Skip to main content
Version: v4

CredentialExchangeRecordPageDto

items object[]required

The records of this page.

  • Array [
  • credentialExchangeIdstringrequired

    Identifier of the credential exchange

    Example: cred-1234-5678
    statestringrequired

    Current state of the issuance flow

    Possible values: [proposal-sent, proposal-received, offer-sent, offer-received, declined, request-sent, request-received, credential-issued, credential-received, done, abandoned]

    rolestringrequired

    Role of this agent in the exchange

    Possible values: [issuer, holder]

    threadIdstringrequired

    DIDComm thread identifier

    Example: thread-8765-4321
    connectionIdstring

    Connection identifier

    Example: conn-1234
    credentialDefinitionIdstring

    AnonCreds credential definition identifier, if the agent knows it

    Example: did:webvh:QmaZYZF4aaHUTWzaKu23TowgvsX7JWfCRgQZX488EAssPQ:dm.chatbot.demos.dev.2060.io/resources/zQmevazUUyXBhGoXJwJNNEqXgvPPQ5WrwTE8G5MdhfWsmxM
    schemaIdstring

    AnonCreds schema identifier, if the agent knows it

    claimsobject[]required

    The offered attributes. The list is empty if the agent cannot read the offer.

    Example: [{"name":"phoneNumber","value":"+57128348520"}]
    errorMessagestring

    Error message on the exchange. The agent sets it if the flow stops.

    createdAtstring<date-time>required

    When the flow was created

    updatedAtstring<date-time>required

    When the flow was last updated

  • ]
  • nextCursorstringnullablerequired

    Cursor of the next page. The agent sets it to null on the last page.

    CredentialExchangeRecordPageDto
    {
    "items": [
    {
    "credentialExchangeId": "cred-1234-5678",
    "state": "proposal-sent",
    "role": "issuer",
    "threadId": "thread-8765-4321",
    "connectionId": "conn-1234",
    "credentialDefinitionId": "did:webvh:QmaZYZF4aaHUTWzaKu23TowgvsX7JWfCRgQZX488EAssPQ:dm.chatbot.demos.dev.2060.io/resources/zQmevazUUyXBhGoXJwJNNEqXgvPPQ5WrwTE8G5MdhfWsmxM",
    "schemaId": "string",
    "claims": [
    {
    "name": "phoneNumber",
    "value": "+57128348520"
    }
    ],
    "errorMessage": "string",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
    }
    ],
    "nextCursor": "string"
    }