Issue a Verifiable Credential

Issue a Verifiable AnonCreds Credential, signed by a did:cheqd Decentralized Identifier (DID), using the ACA-Py API endpoints.

Using the /issue-credential-2.0 API endpoints, it is possible to issue Verifiable Credentials, signed by a cheqd DID, in a few clicks or lines of code. By following the following steps, you can effectively issue verifiable credentials using ACA-Py integrated with the cheqd ecosystem.

Step 1: Create a Connection with Holder

Use any supported method to create a connection with the Holder of the credential. Automated out-of-band protocol is recommended.

1a: Issuer Creates Connection Invite

The Issuer agent will create a new connection invite for the Holder. This is needed to securely communicate between the Issuer and the Holder agents.

Create a new connection invitation

post

Query parameters

auto_acceptbooleanOptional

Auto-accept connection (defaults to configuration)

create_unique_didbooleanOptional

Create unique DID for this invitation (default false)

multi_usebooleanOptional

Create invitation for multiple use (default false)

Body

application/json

acceptstring[]Optional

List of mime type in order of preference that should be use in responding to the message

Example: ["didcomm/aip1","didcomm/aip2;env=rfc19"]

aliasstringOptional

Alias for connection

Example: Barry

goalstringOptional

A self-attested string that the receiver may want to display to the user about the context-specific goal of the out-of-band message

Example: To issue a Faber College Graduate credential

goal_codestringOptional

A self-attested code the receiver may want to display to the user or use in automatically deciding what to do with the out-of-band message

Example: issue-vc

handshake_protocolsstring[]Optional

Handshake protocol to specify in invitation

mediation_idstringOptional

Identifier for active mediation record to be used

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

metadataobjectOptional

Optional metadata to attach to the connection created with the invitation

my_labelstringOptional

Label for connection invitation

Example: Invitation to Barry

protocol_versionstringOptional

OOB protocol version

Example: 1.1

use_didstringOptional

DID to use in invitation

Example: did:example:123

use_did_methodstring · enumOptional

DID method to use in invitation

Example: did:peer:2Possible values:

use_public_didbooleanOptional

Whether to use public DID in invitation

Responses

200Success

application/json

created_atstringOptional

Time of record creation

Example: 2021-12-31T23:59:59ZPattern: ^\d{4}-\d\d-\d\d[T ]\d\d:\d\d(?:\:(?:\d\d(?:\.\d{1,6})?))?(?:[+-]\d\d:?\d\d|Z|)$

invi_msg_idstringOptional

Invitation message identifier

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

invitation_idstringOptional

Invitation record identifier

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

invitation_urlstringOptional

Invitation message URL

Example: https://example.com/endpoint?c_i=eyJAdHlwZSI6ICIuLi4iLCAiLi4uIjogIi4uLiJ9XX0=

oob_idstringOptional

Out of band record identifier

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

statestringOptional

Out of band message exchange state

Example: await_response

tracebooleanOptional

Record trace information, based on agent configuration

updated_atstringOptional

Time of last record update

Example: 2021-12-31T23:59:59ZPattern: ^\d{4}-\d\d-\d\d[T ]\d\d:\d\d(?:\:(?:\d\d(?:\.\d{1,6})?))?(?:[+-]\d\d:?\d\d|Z|)$

post

/out-of-band/create-invitation

HTTPcURLJavaScriptPython

POST /out-of-band/create-invitation HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 475

{
  "accept": [
    "didcomm/aip1",
    "didcomm/aip2;env=rfc19"
  ],
  "alias": "Barry",
  "attachments": [
    {
      "id": "attachment-0",
      "type": "present-proof"
    }
  ],
  "goal": "To issue a Faber College Graduate credential",
  "goal_code": "issue-vc",
  "handshake_protocols": [
    "https://didcomm.org/didexchange/1.0"
  ],
  "mediation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "metadata": {},
  "my_label": "Invitation to Barry",
  "protocol_version": "1.1",
  "use_did": "did:example:123",
  "use_did_method": "did:peer:2",
  "use_public_did": false
}

200Success

{
  "created_at": "2021-12-31T23:59:59Z",
  "invi_msg_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "invitation": {
    "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "@type": "https://didcomm.org/my-family/1.0/my-message-type",
    "accept": [
      "didcomm/aip1",
      "didcomm/aip2;env=rfc19"
    ],
    "goal": "To issue a Faber College Graduate credential",
    "goal_code": "issue-vc",
    "handshake_protocols": [
      "https://didcomm.org/didexchange/1.0"
    ],
    "imageUrl": "http://192.168.56.101/img/logo.jpg",
    "label": "Bob",
    "requests~attach": [
      {
        "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "byte_count": 1234,
        "data": {
          "base64": "ey4uLn0=",
          "json": "{\"sample\": \"content\"}",
          "jws": {
            "header": {
              "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
            },
            "protected": "ey4uLn0",
            "signature": "ey4uLn0",
            "signatures": [
              {
                "header": {
                  "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                },
                "protected": "ey4uLn0",
                "signature": "ey4uLn0"
              }
            ]
          },
          "links": [
            "https://link.to/data"
          ],
          "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
        },
        "description": "view from doorway, facing east, with lights off",
        "filename": "IMG1092348.png",
        "lastmod_time": "2021-12-31T23:59:59Z",
        "mime-type": "image/png"
      }
    ],
    "services": [
      {
        "did": "WgWxqztrNooG92RXvxSTWv",
        "id": "string",
        "recipientKeys": [
          "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH"
        ],
        "routingKeys": [
          "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH"
        ],
        "serviceEndpoint": "http://192.168.56.101:8020",
        "type": "string"
      },
      "did:sov:WgWxqztrNooG92RXvxSTWv"
    ]
  },
  "invitation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "invitation_url": "https://example.com/endpoint?c_i=eyJAdHlwZSI6ICIuLi4iLCAiLi4uIjogIi4uLiJ9XX0=",
  "oob_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "state": "await_response",
  "trace": true,
  "updated_at": "2021-12-31T23:59:59Z"
}

Parameters and Request Body

For automated acceptance, pass the following parameters:

auto_accept

Set this to true

A simple request body is below:

{
    "alias": "Holder",
    "handshake_protocols": ["https://didcomm.org/didexchange/1.0"],
    "use_public_did": false,
    "my_label": "Invitation to Holder"
}

1b: Holder receives invitation

The above request will have an invitation in the response. Holder will have to copy that invitation and pass in the body of the following API call.

Receive a new connection invitation

post

Query parameters

aliasstringOptional

Alias for connection

Example: {"value":"Barry"}

auto_acceptbooleanOptional

Auto-accept connection (defaults to configuration)

mediation_idstringOptional

Identifier for active mediation record to be used

Example: {"value":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

use_existing_connectionbooleanOptional

Use an existing connection, if possible

Body

application/json

@idstringOptional

Message identifier

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

@typestringOptional

Message type

Example: https://didcomm.org/my-family/1.0/my-message-type

acceptstring[]Optional

List of mime type in order of preference

Example: ["didcomm/aip1","didcomm/aip2;env=rfc19"]

goalstringOptional

A self-attested string that the receiver may want to display to the user about the context-specific goal of the out-of-band message

Example: To issue a Faber College Graduate credential

goal_codestringOptional

A self-attested code the receiver may want to display to the user or use in automatically deciding what to do with the out-of-band message

Example: issue-vc

handshake_protocolsstring[]Optional

Handshake protocol

imageUrlstring · urlOptional

Optional image URL for out-of-band invitation

Example: http://192.168.56.101/img/logo.jpg

labelstringOptional

Optional label

Example: Bob

Responses

200Success

application/json

attach_thread_idstringOptional

Connection record identifier

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

connection_idstringOptional

Connection record identifier

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

created_atstringOptional

Time of record creation

Example: 2021-12-31T23:59:59ZPattern: ^\d{4}-\d\d-\d\d[T ]\d\d:\d\d(?:\:(?:\d\d(?:\.\d{1,6})?))?(?:[+-]\d\d:?\d\d|Z|)$

invi_msg_idstringRequired

Invitation message identifier

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

multi_usebooleanOptional

Allow for multiple uses of the oob invitation

Example: true

oob_idstringRequired

Oob record identifier

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

our_recipient_keystringOptional

Recipient key used for oob invitation

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

rolestring · enumOptional

OOB Role

Example: receiverPossible values:

statestring · enumRequired

Out of band message exchange state

Example: await-responsePossible values:

tracebooleanOptional

Record trace information, based on agent configuration

updated_atstringOptional

Time of last record update

Example: 2021-12-31T23:59:59ZPattern: ^\d{4}-\d\d-\d\d[T ]\d\d:\d\d(?:\:(?:\d\d(?:\.\d{1,6})?))?(?:[+-]\d\d:?\d\d|Z|)$

post

/out-of-band/receive-invitation

HTTPcURLJavaScriptPython

POST /out-of-band/receive-invitation HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 1305

{
  "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "@type": "https://didcomm.org/my-family/1.0/my-message-type",
  "accept": [
    "didcomm/aip1",
    "didcomm/aip2;env=rfc19"
  ],
  "goal": "To issue a Faber College Graduate credential",
  "goal_code": "issue-vc",
  "handshake_protocols": [
    "https://didcomm.org/didexchange/1.0"
  ],
  "imageUrl": "http://192.168.56.101/img/logo.jpg",
  "label": "Bob",
  "requests~attach": [
    {
      "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "byte_count": 1234,
      "data": {
        "base64": "ey4uLn0=",
        "json": "{\"sample\": \"content\"}",
        "jws": {
          "header": {
            "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
          },
          "protected": "ey4uLn0",
          "signature": "ey4uLn0",
          "signatures": [
            {
              "header": {
                "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
              },
              "protected": "ey4uLn0",
              "signature": "ey4uLn0"
            }
          ]
        },
        "links": [
          "https://link.to/data"
        ],
        "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
      },
      "description": "view from doorway, facing east, with lights off",
      "filename": "IMG1092348.png",
      "lastmod_time": "2021-12-31T23:59:59Z",
      "mime-type": "image/png"
    }
  ],
  "services": [
    {
      "did": "WgWxqztrNooG92RXvxSTWv",
      "id": "string",
      "recipientKeys": [
        "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH"
      ],
      "routingKeys": [
        "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH"
      ],
      "serviceEndpoint": "http://192.168.56.101:8020",
      "type": "string"
    },
    "did:sov:WgWxqztrNooG92RXvxSTWv"
  ]
}

200Success

{
  "attach_thread_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "connection_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_at": "2021-12-31T23:59:59Z",
  "invi_msg_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "invitation": {
    "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "@type": "https://didcomm.org/my-family/1.0/my-message-type",
    "accept": [
      "didcomm/aip1",
      "didcomm/aip2;env=rfc19"
    ],
    "goal": "To issue a Faber College Graduate credential",
    "goal_code": "issue-vc",
    "handshake_protocols": [
      "https://didcomm.org/didexchange/1.0"
    ],
    "imageUrl": "http://192.168.56.101/img/logo.jpg",
    "label": "Bob",
    "requests~attach": [
      {
        "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "byte_count": 1234,
        "data": {
          "base64": "ey4uLn0=",
          "json": "{\"sample\": \"content\"}",
          "jws": {
            "header": {
              "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
            },
            "protected": "ey4uLn0",
            "signature": "ey4uLn0",
            "signatures": [
              {
                "header": {
                  "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                },
                "protected": "ey4uLn0",
                "signature": "ey4uLn0"
              }
            ]
          },
          "links": [
            "https://link.to/data"
          ],
          "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
        },
        "description": "view from doorway, facing east, with lights off",
        "filename": "IMG1092348.png",
        "lastmod_time": "2021-12-31T23:59:59Z",
        "mime-type": "image/png"
      }
    ],
    "services": [
      {
        "did": "WgWxqztrNooG92RXvxSTWv",
        "id": "string",
        "recipientKeys": [
          "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH"
        ],
        "routingKeys": [
          "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH"
        ],
        "serviceEndpoint": "http://192.168.56.101:8020",
        "type": "string"
      },
      "did:sov:WgWxqztrNooG92RXvxSTWv"
    ]
  },
  "multi_use": true,
  "oob_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "our_recipient_key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "role": "receiver",
  "state": "await-response",
  "their_service": {
    "recipientKeys": [
      "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"
    ],
    "routingKeys": [
      "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"
    ],
    "serviceEndpoint": "http://192.168.56.101:8020"
  },
  "trace": true,
  "updated_at": "2021-12-31T23:59:59Z"
}

Parameters and Request Body

auto_accept

Set this to true

alias

Pass an alias for the connection

use_existing_connection

Set this to true

The request body should be the invitation value from the /create-invitation call by the Issuer.

Step 2: Prepare Credential Offer

Generate a credential offer using the /issue-credential-2.0/send-offer API. This offer is sent to the holder, informing them about the available credential and its attributes.

Send holder a credential offer, independent of any proposal

post

Body

application/json

auto_issuebooleanOptional

Whether to respond automatically to credential requests, creating and issuing requested credentials

auto_removebooleanOptional

Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)

commentstringOptional

Human-readable comment

connection_idstringRequired

Connection identifier

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

replacement_idstringOptional

Optional identifier used to manage credential replacement

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

tracebooleanOptional

Record trace information, based on agent configuration

Responses

200Success

application/json

auto_issuebooleanOptional

Issuer choice to issue to request in this credential exchange

auto_offerbooleanOptional

Holder choice to accept offer in this credential exchange

auto_removebooleanOptional

Issuer choice to remove this credential exchange record when complete

connection_idstringOptional

Connection identifier

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

created_atstringOptional

Time of record creation

Example: 2021-12-31T23:59:59ZPattern: ^\d{4}-\d\d-\d\d[T ]\d\d:\d\d(?:\:(?:\d\d(?:\.\d{1,6})?))?(?:[+-]\d\d:?\d\d|Z|)$

cred_ex_idstringOptional

Credential exchange identifier

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

error_msgstringOptional

Error message

Example: The front fell off

initiatorstring · enumOptional

Issue-credential exchange initiator: self or external

Example: selfPossible values:

parent_thread_idstringOptional

Parent thread identifier

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

rolestring · enumOptional

Issue-credential exchange role: holder or issuer

Example: issuerPossible values:

statestring · enumOptional

Issue-credential exchange state

Example: donePossible values:

thread_idstringOptional

Thread identifier

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

tracebooleanOptional

Record trace information, based on agent configuration

updated_atstringOptional

Time of last record update

Example: 2021-12-31T23:59:59ZPattern: ^\d{4}-\d\d-\d\d[T ]\d\d:\d\d(?:\:(?:\d\d(?:\.\d{1,6})?))?(?:[+-]\d\d:?\d\d|Z|)$

post

/issue-credential-2.0/send-offer

HTTPcURLJavaScriptPython

POST /issue-credential-2.0/send-offer HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 1703

{
  "auto_issue": true,
  "auto_remove": true,
  "comment": "text",
  "connection_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "credential_preview": {
    "@type": "issue-credential/2.0/credential-preview",
    "attributes": [
      {
        "mime-type": "image/jpeg",
        "name": "favourite_drink",
        "value": "martini"
      }
    ]
  },
  "filter": {
    "anoncreds": {
      "cred_def_id": "did:(method):3:CL:20:tag",
      "issuer_id": "did:(method):WgWxqztrNooG92RXvxSTWv",
      "schema_id": "did:(method):2:schema_name:1.0",
      "schema_issuer_id": "did:(method):WgWxqztrNooG92RXvxSTWv",
      "schema_name": "preferences",
      "schema_version": "1.0"
    },
    "indy": {
      "cred_def_id": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag",
      "issuer_did": "WgWxqztrNooG92RXvxSTWv",
      "schema_id": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0",
      "schema_issuer_did": "WgWxqztrNooG92RXvxSTWv",
      "schema_name": "preferences",
      "schema_version": "1.0"
    },
    "ld_proof": {
      "credential": {
        "@context": [
          "https://www.w3.org/2018/credentials/v1",
          "https://w3id.org/citizenship/v1"
        ],
        "credentialSubject": {
          "familyName": "SMITH",
          "gender": "Male",
          "givenName": "JOHN",
          "type": [
            "PermanentResident",
            "Person"
          ]
        },
        "description": "Government of Example Permanent Resident Card.",
        "identifier": "83627465",
        "issuanceDate": "2019-12-03T12:19:52Z",
        "issuer": "did:key:z6MkmjY8GnV5i9YTDtPETC2uUAW6ejw3nk5mXF5yci5ab7th",
        "name": "Permanent Resident Card",
        "type": [
          "VerifiableCredential",
          "PermanentResidentCard"
        ]
      },
      "options": {
        "proofType": "Ed25519Signature2018"
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "vc_di": {
      "cred_def_id": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag",
      "issuer_did": "WgWxqztrNooG92RXvxSTWv",
      "schema_id": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0",
      "schema_issuer_did": "WgWxqztrNooG92RXvxSTWv",
      "schema_name": "preferences",
      "schema_version": "1.0"
    }
  },
  "replacement_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "trace": true
}

200Success

{
  "auto_issue": false,
  "auto_offer": false,
  "auto_remove": false,
  "by_format": {
    "cred_issue": {},
    "cred_offer": {},
    "cred_proposal": {},
    "cred_request": {}
  },
  "connection_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_at": "2021-12-31T23:59:59Z",
  "cred_ex_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "cred_issue": {
    "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "@type": "https://didcomm.org/my-family/1.0/my-message-type",
    "comment": "text",
    "credentials~attach": [
      {
        "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "byte_count": 1234,
        "data": {
          "base64": "ey4uLn0=",
          "json": "{\"sample\": \"content\"}",
          "jws": {
            "header": {
              "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
            },
            "protected": "ey4uLn0",
            "signature": "ey4uLn0",
            "signatures": [
              {
                "header": {
                  "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                },
                "protected": "ey4uLn0",
                "signature": "ey4uLn0"
              }
            ]
          },
          "links": [
            "https://link.to/data"
          ],
          "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
        },
        "description": "view from doorway, facing east, with lights off",
        "filename": "IMG1092348.png",
        "lastmod_time": "2021-12-31T23:59:59Z",
        "mime-type": "image/png"
      }
    ],
    "formats": [
      {
        "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "format": "aries/[email protected]"
      }
    ],
    "replacement_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "cred_offer": {
    "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "@type": "https://didcomm.org/my-family/1.0/my-message-type",
    "comment": "text",
    "credential_preview": {
      "@type": "issue-credential/2.0/credential-preview",
      "attributes": [
        {
          "mime-type": "image/jpeg",
          "name": "favourite_drink",
          "value": "martini"
        }
      ]
    },
    "formats": [
      {
        "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "format": "aries/[email protected]"
      }
    ],
    "offers~attach": [
      {
        "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "byte_count": 1234,
        "data": {
          "base64": "ey4uLn0=",
          "json": "{\"sample\": \"content\"}",
          "jws": {
            "header": {
              "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
            },
            "protected": "ey4uLn0",
            "signature": "ey4uLn0",
            "signatures": [
              {
                "header": {
                  "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                },
                "protected": "ey4uLn0",
                "signature": "ey4uLn0"
              }
            ]
          },
          "links": [
            "https://link.to/data"
          ],
          "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
        },
        "description": "view from doorway, facing east, with lights off",
        "filename": "IMG1092348.png",
        "lastmod_time": "2021-12-31T23:59:59Z",
        "mime-type": "image/png"
      }
    ],
    "replacement_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "cred_preview": {
    "@type": "issue-credential/2.0/credential-preview",
    "attributes": [
      {
        "mime-type": "image/jpeg",
        "name": "favourite_drink",
        "value": "martini"
      }
    ]
  },
  "cred_proposal": {
    "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "@type": "https://didcomm.org/my-family/1.0/my-message-type",
    "comment": "text",
    "credential_preview": {
      "@type": "issue-credential/2.0/credential-preview",
      "attributes": [
        {
          "mime-type": "image/jpeg",
          "name": "favourite_drink",
          "value": "martini"
        }
      ]
    },
    "filters~attach": [
      {
        "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "byte_count": 1234,
        "data": {
          "base64": "ey4uLn0=",
          "json": "{\"sample\": \"content\"}",
          "jws": {
            "header": {
              "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
            },
            "protected": "ey4uLn0",
            "signature": "ey4uLn0",
            "signatures": [
              {
                "header": {
                  "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                },
                "protected": "ey4uLn0",
                "signature": "ey4uLn0"
              }
            ]
          },
          "links": [
            "https://link.to/data"
          ],
          "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
        },
        "description": "view from doorway, facing east, with lights off",
        "filename": "IMG1092348.png",
        "lastmod_time": "2021-12-31T23:59:59Z",
        "mime-type": "image/png"
      }
    ],
    "formats": [
      {
        "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "format": "aries/[email protected]"
      }
    ]
  },
  "cred_request": {
    "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "@type": "https://didcomm.org/my-family/1.0/my-message-type",
    "comment": "text",
    "formats": [
      {
        "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "format": "aries/[email protected]"
      }
    ],
    "requests~attach": [
      {
        "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "byte_count": 1234,
        "data": {
          "base64": "ey4uLn0=",
          "json": "{\"sample\": \"content\"}",
          "jws": {
            "header": {
              "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
            },
            "protected": "ey4uLn0",
            "signature": "ey4uLn0",
            "signatures": [
              {
                "header": {
                  "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                },
                "protected": "ey4uLn0",
                "signature": "ey4uLn0"
              }
            ]
          },
          "links": [
            "https://link.to/data"
          ],
          "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
        },
        "description": "view from doorway, facing east, with lights off",
        "filename": "IMG1092348.png",
        "lastmod_time": "2021-12-31T23:59:59Z",
        "mime-type": "image/png"
      }
    ]
  },
  "error_msg": "The front fell off",
  "initiator": "self",
  "parent_thread_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "role": "issuer",
  "state": "done",
  "thread_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "trace": true,
  "updated_at": "2021-12-31T23:59:59Z"
}

Step 3: Holder accepts credential offer

The Holder has to retrieve the credential exchange id, and call this API to accept the offer.

Send issuer a credential request

post

Path parameters

cred_ex_idstringRequired

Credential exchange identifier

Example: {"value":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

Body

application/json

auto_removebooleanOptional

Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)

holder_didstringOptional

Holder DID to substitute for the credentialSubject.id

Example: did:key:ahsdkjahsdkjhaskjdhakjshdkajhsdkjahs

Responses

200Success

application/json

auto_issuebooleanOptional

Issuer choice to issue to request in this credential exchange

auto_offerbooleanOptional

Holder choice to accept offer in this credential exchange

auto_removebooleanOptional

Issuer choice to remove this credential exchange record when complete

connection_idstringOptional

Connection identifier

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

created_atstringOptional

Time of record creation

Example: 2021-12-31T23:59:59ZPattern: ^\d{4}-\d\d-\d\d[T ]\d\d:\d\d(?:\:(?:\d\d(?:\.\d{1,6})?))?(?:[+-]\d\d:?\d\d|Z|)$

cred_ex_idstringOptional

Credential exchange identifier

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

error_msgstringOptional

Error message

Example: The front fell off

initiatorstring · enumOptional

Issue-credential exchange initiator: self or external

Example: selfPossible values:

parent_thread_idstringOptional

Parent thread identifier

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

rolestring · enumOptional

Issue-credential exchange role: holder or issuer

Example: issuerPossible values:

statestring · enumOptional

Issue-credential exchange state

Example: donePossible values:

thread_idstringOptional

Thread identifier

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

tracebooleanOptional

Record trace information, based on agent configuration

updated_atstringOptional

Time of last record update

Example: 2021-12-31T23:59:59ZPattern: ^\d{4}-\d\d-\d\d[T ]\d\d:\d\d(?:\:(?:\d\d(?:\.\d{1,6})?))?(?:[+-]\d\d:?\d\d|Z|)$

post

/issue-credential-2.0/records/{cred_ex_id}/send-request

HTTPcURLJavaScriptPython

POST /issue-credential-2.0/records/{cred_ex_id}/send-request HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "auto_remove": true,
  "holder_did": "did:key:ahsdkjahsdkjhaskjdhakjshdkajhsdkjahs"
}

200Success

{
  "auto_issue": false,
  "auto_offer": false,
  "auto_remove": false,
  "by_format": {
    "cred_issue": {},
    "cred_offer": {},
    "cred_proposal": {},
    "cred_request": {}
  },
  "connection_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_at": "2021-12-31T23:59:59Z",
  "cred_ex_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "cred_issue": {
    "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "@type": "https://didcomm.org/my-family/1.0/my-message-type",
    "comment": "text",
    "credentials~attach": [
      {
        "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "byte_count": 1234,
        "data": {
          "base64": "ey4uLn0=",
          "json": "{\"sample\": \"content\"}",
          "jws": {
            "header": {
              "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
            },
            "protected": "ey4uLn0",
            "signature": "ey4uLn0",
            "signatures": [
              {
                "header": {
                  "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                },
                "protected": "ey4uLn0",
                "signature": "ey4uLn0"
              }
            ]
          },
          "links": [
            "https://link.to/data"
          ],
          "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
        },
        "description": "view from doorway, facing east, with lights off",
        "filename": "IMG1092348.png",
        "lastmod_time": "2021-12-31T23:59:59Z",
        "mime-type": "image/png"
      }
    ],
    "formats": [
      {
        "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "format": "aries/[email protected]"
      }
    ],
    "replacement_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "cred_offer": {
    "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "@type": "https://didcomm.org/my-family/1.0/my-message-type",
    "comment": "text",
    "credential_preview": {
      "@type": "issue-credential/2.0/credential-preview",
      "attributes": [
        {
          "mime-type": "image/jpeg",
          "name": "favourite_drink",
          "value": "martini"
        }
      ]
    },
    "formats": [
      {
        "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "format": "aries/[email protected]"
      }
    ],
    "offers~attach": [
      {
        "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "byte_count": 1234,
        "data": {
          "base64": "ey4uLn0=",
          "json": "{\"sample\": \"content\"}",
          "jws": {
            "header": {
              "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
            },
            "protected": "ey4uLn0",
            "signature": "ey4uLn0",
            "signatures": [
              {
                "header": {
                  "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                },
                "protected": "ey4uLn0",
                "signature": "ey4uLn0"
              }
            ]
          },
          "links": [
            "https://link.to/data"
          ],
          "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
        },
        "description": "view from doorway, facing east, with lights off",
        "filename": "IMG1092348.png",
        "lastmod_time": "2021-12-31T23:59:59Z",
        "mime-type": "image/png"
      }
    ],
    "replacement_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "cred_preview": {
    "@type": "issue-credential/2.0/credential-preview",
    "attributes": [
      {
        "mime-type": "image/jpeg",
        "name": "favourite_drink",
        "value": "martini"
      }
    ]
  },
  "cred_proposal": {
    "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "@type": "https://didcomm.org/my-family/1.0/my-message-type",
    "comment": "text",
    "credential_preview": {
      "@type": "issue-credential/2.0/credential-preview",
      "attributes": [
        {
          "mime-type": "image/jpeg",
          "name": "favourite_drink",
          "value": "martini"
        }
      ]
    },
    "filters~attach": [
      {
        "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "byte_count": 1234,
        "data": {
          "base64": "ey4uLn0=",
          "json": "{\"sample\": \"content\"}",
          "jws": {
            "header": {
              "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
            },
            "protected": "ey4uLn0",
            "signature": "ey4uLn0",
            "signatures": [
              {
                "header": {
                  "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                },
                "protected": "ey4uLn0",
                "signature": "ey4uLn0"
              }
            ]
          },
          "links": [
            "https://link.to/data"
          ],
          "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
        },
        "description": "view from doorway, facing east, with lights off",
        "filename": "IMG1092348.png",
        "lastmod_time": "2021-12-31T23:59:59Z",
        "mime-type": "image/png"
      }
    ],
    "formats": [
      {
        "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "format": "aries/[email protected]"
      }
    ]
  },
  "cred_request": {
    "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "@type": "https://didcomm.org/my-family/1.0/my-message-type",
    "comment": "text",
    "formats": [
      {
        "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "format": "aries/[email protected]"
      }
    ],
    "requests~attach": [
      {
        "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "byte_count": 1234,
        "data": {
          "base64": "ey4uLn0=",
          "json": "{\"sample\": \"content\"}",
          "jws": {
            "header": {
              "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
            },
            "protected": "ey4uLn0",
            "signature": "ey4uLn0",
            "signatures": [
              {
                "header": {
                  "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                },
                "protected": "ey4uLn0",
                "signature": "ey4uLn0"
              }
            ]
          },
          "links": [
            "https://link.to/data"
          ],
          "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
        },
        "description": "view from doorway, facing east, with lights off",
        "filename": "IMG1092348.png",
        "lastmod_time": "2021-12-31T23:59:59Z",
        "mime-type": "image/png"
      }
    ]
  },
  "error_msg": "The front fell off",
  "initiator": "self",
  "parent_thread_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "role": "issuer",
  "state": "done",
  "thread_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "trace": true,
  "updated_at": "2021-12-31T23:59:59Z"
}

Step 4: Issue Credential

Once the credential request is received and validated, issue the credential using the /issue-credential-2.0/records/<exchange-id>/issue API endpoint.

Send holder a credential

post

Path parameters

cred_ex_idstringRequired

Credential exchange identifier

Example: {"value":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

Body

application/json

commentstringOptional

Human-readable comment

Responses

200Success

application/json

post

/issue-credential-2.0/records/{cred_ex_id}/issue

HTTPcURLJavaScriptPython

POST /issue-credential-2.0/records/{cred_ex_id}/issue HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "comment": "text"
}

200Success

{
  "cred_ex_record": {
    "auto_issue": false,
    "auto_offer": false,
    "auto_remove": false,
    "by_format": {
      "cred_issue": {},
      "cred_offer": {},
      "cred_proposal": {},
      "cred_request": {}
    },
    "connection_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created_at": "2021-12-31T23:59:59Z",
    "cred_ex_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "cred_issue": {
      "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "@type": "https://didcomm.org/my-family/1.0/my-message-type",
      "comment": "text",
      "credentials~attach": [
        {
          "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "byte_count": 1234,
          "data": {
            "base64": "ey4uLn0=",
            "json": "{\"sample\": \"content\"}",
            "jws": {
              "header": {
                "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
              },
              "protected": "ey4uLn0",
              "signature": "ey4uLn0",
              "signatures": [
                {
                  "header": {
                    "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                  },
                  "protected": "ey4uLn0",
                  "signature": "ey4uLn0"
                }
              ]
            },
            "links": [
              "https://link.to/data"
            ],
            "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
          },
          "description": "view from doorway, facing east, with lights off",
          "filename": "IMG1092348.png",
          "lastmod_time": "2021-12-31T23:59:59Z",
          "mime-type": "image/png"
        }
      ],
      "formats": [
        {
          "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "format": "aries/[email protected]"
        }
      ],
      "replacement_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "cred_offer": {
      "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "@type": "https://didcomm.org/my-family/1.0/my-message-type",
      "comment": "text",
      "credential_preview": {
        "@type": "issue-credential/2.0/credential-preview",
        "attributes": [
          {
            "mime-type": "image/jpeg",
            "name": "favourite_drink",
            "value": "martini"
          }
        ]
      },
      "formats": [
        {
          "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "format": "aries/[email protected]"
        }
      ],
      "offers~attach": [
        {
          "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "byte_count": 1234,
          "data": {
            "base64": "ey4uLn0=",
            "json": "{\"sample\": \"content\"}",
            "jws": {
              "header": {
                "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
              },
              "protected": "ey4uLn0",
              "signature": "ey4uLn0",
              "signatures": [
                {
                  "header": {
                    "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                  },
                  "protected": "ey4uLn0",
                  "signature": "ey4uLn0"
                }
              ]
            },
            "links": [
              "https://link.to/data"
            ],
            "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
          },
          "description": "view from doorway, facing east, with lights off",
          "filename": "IMG1092348.png",
          "lastmod_time": "2021-12-31T23:59:59Z",
          "mime-type": "image/png"
        }
      ],
      "replacement_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "cred_preview": {
      "@type": "issue-credential/2.0/credential-preview",
      "attributes": [
        {
          "mime-type": "image/jpeg",
          "name": "favourite_drink",
          "value": "martini"
        }
      ]
    },
    "cred_proposal": {
      "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "@type": "https://didcomm.org/my-family/1.0/my-message-type",
      "comment": "text",
      "credential_preview": {
        "@type": "issue-credential/2.0/credential-preview",
        "attributes": [
          {
            "mime-type": "image/jpeg",
            "name": "favourite_drink",
            "value": "martini"
          }
        ]
      },
      "filters~attach": [
        {
          "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "byte_count": 1234,
          "data": {
            "base64": "ey4uLn0=",
            "json": "{\"sample\": \"content\"}",
            "jws": {
              "header": {
                "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
              },
              "protected": "ey4uLn0",
              "signature": "ey4uLn0",
              "signatures": [
                {
                  "header": {
                    "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                  },
                  "protected": "ey4uLn0",
                  "signature": "ey4uLn0"
                }
              ]
            },
            "links": [
              "https://link.to/data"
            ],
            "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
          },
          "description": "view from doorway, facing east, with lights off",
          "filename": "IMG1092348.png",
          "lastmod_time": "2021-12-31T23:59:59Z",
          "mime-type": "image/png"
        }
      ],
      "formats": [
        {
          "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "format": "aries/[email protected]"
        }
      ]
    },
    "cred_request": {
      "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "@type": "https://didcomm.org/my-family/1.0/my-message-type",
      "comment": "text",
      "formats": [
        {
          "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "format": "aries/[email protected]"
        }
      ],
      "requests~attach": [
        {
          "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "byte_count": 1234,
          "data": {
            "base64": "ey4uLn0=",
            "json": "{\"sample\": \"content\"}",
            "jws": {
              "header": {
                "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
              },
              "protected": "ey4uLn0",
              "signature": "ey4uLn0",
              "signatures": [
                {
                  "header": {
                    "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                  },
                  "protected": "ey4uLn0",
                  "signature": "ey4uLn0"
                }
              ]
            },
            "links": [
              "https://link.to/data"
            ],
            "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
          },
          "description": "view from doorway, facing east, with lights off",
          "filename": "IMG1092348.png",
          "lastmod_time": "2021-12-31T23:59:59Z",
          "mime-type": "image/png"
        }
      ]
    },
    "error_msg": "The front fell off",
    "initiator": "self",
    "parent_thread_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "role": "issuer",
    "state": "done",
    "thread_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "trace": true,
    "updated_at": "2021-12-31T23:59:59Z"
  },
  "indy": {
    "created_at": "2021-12-31T23:59:59Z",
    "cred_ex_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "cred_ex_indy_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "cred_id_stored": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "cred_request_metadata": {},
    "cred_rev_id": "12345",
    "rev_reg_id": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0",
    "state": "active",
    "updated_at": "2021-12-31T23:59:59Z"
  },
  "ld_proof": {
    "created_at": "2021-12-31T23:59:59Z",
    "cred_ex_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "cred_ex_ld_proof_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "cred_id_stored": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "state": "active",
    "updated_at": "2021-12-31T23:59:59Z"
  },
  "vc_di": {
    "auto_issue": false,
    "auto_offer": false,
    "auto_remove": false,
    "by_format": {
      "cred_issue": {},
      "cred_offer": {},
      "cred_proposal": {},
      "cred_request": {}
    },
    "connection_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created_at": "2021-12-31T23:59:59Z",
    "cred_ex_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "cred_issue": {
      "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "@type": "https://didcomm.org/my-family/1.0/my-message-type",
      "comment": "text",
      "credentials~attach": [
        {
          "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "byte_count": 1234,
          "data": {
            "base64": "ey4uLn0=",
            "json": "{\"sample\": \"content\"}",
            "jws": {
              "header": {
                "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
              },
              "protected": "ey4uLn0",
              "signature": "ey4uLn0",
              "signatures": [
                {
                  "header": {
                    "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                  },
                  "protected": "ey4uLn0",
                  "signature": "ey4uLn0"
                }
              ]
            },
            "links": [
              "https://link.to/data"
            ],
            "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
          },
          "description": "view from doorway, facing east, with lights off",
          "filename": "IMG1092348.png",
          "lastmod_time": "2021-12-31T23:59:59Z",
          "mime-type": "image/png"
        }
      ],
      "formats": [
        {
          "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "format": "aries/[email protected]"
        }
      ],
      "replacement_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "cred_offer": {
      "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "@type": "https://didcomm.org/my-family/1.0/my-message-type",
      "comment": "text",
      "credential_preview": {
        "@type": "issue-credential/2.0/credential-preview",
        "attributes": [
          {
            "mime-type": "image/jpeg",
            "name": "favourite_drink",
            "value": "martini"
          }
        ]
      },
      "formats": [
        {
          "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "format": "aries/[email protected]"
        }
      ],
      "offers~attach": [
        {
          "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "byte_count": 1234,
          "data": {
            "base64": "ey4uLn0=",
            "json": "{\"sample\": \"content\"}",
            "jws": {
              "header": {
                "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
              },
              "protected": "ey4uLn0",
              "signature": "ey4uLn0",
              "signatures": [
                {
                  "header": {
                    "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                  },
                  "protected": "ey4uLn0",
                  "signature": "ey4uLn0"
                }
              ]
            },
            "links": [
              "https://link.to/data"
            ],
            "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
          },
          "description": "view from doorway, facing east, with lights off",
          "filename": "IMG1092348.png",
          "lastmod_time": "2021-12-31T23:59:59Z",
          "mime-type": "image/png"
        }
      ],
      "replacement_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "cred_preview": {
      "@type": "issue-credential/2.0/credential-preview",
      "attributes": [
        {
          "mime-type": "image/jpeg",
          "name": "favourite_drink",
          "value": "martini"
        }
      ]
    },
    "cred_proposal": {
      "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "@type": "https://didcomm.org/my-family/1.0/my-message-type",
      "comment": "text",
      "credential_preview": {
        "@type": "issue-credential/2.0/credential-preview",
        "attributes": [
          {
            "mime-type": "image/jpeg",
            "name": "favourite_drink",
            "value": "martini"
          }
        ]
      },
      "filters~attach": [
        {
          "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "byte_count": 1234,
          "data": {
            "base64": "ey4uLn0=",
            "json": "{\"sample\": \"content\"}",
            "jws": {
              "header": {
                "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
              },
              "protected": "ey4uLn0",
              "signature": "ey4uLn0",
              "signatures": [
                {
                  "header": {
                    "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                  },
                  "protected": "ey4uLn0",
                  "signature": "ey4uLn0"
                }
              ]
            },
            "links": [
              "https://link.to/data"
            ],
            "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
          },
          "description": "view from doorway, facing east, with lights off",
          "filename": "IMG1092348.png",
          "lastmod_time": "2021-12-31T23:59:59Z",
          "mime-type": "image/png"
        }
      ],
      "formats": [
        {
          "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "format": "aries/[email protected]"
        }
      ]
    },
    "cred_request": {
      "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "@type": "https://didcomm.org/my-family/1.0/my-message-type",
      "comment": "text",
      "formats": [
        {
          "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "format": "aries/[email protected]"
        }
      ],
      "requests~attach": [
        {
          "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "byte_count": 1234,
          "data": {
            "base64": "ey4uLn0=",
            "json": "{\"sample\": \"content\"}",
            "jws": {
              "header": {
                "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
              },
              "protected": "ey4uLn0",
              "signature": "ey4uLn0",
              "signatures": [
                {
                  "header": {
                    "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                  },
                  "protected": "ey4uLn0",
                  "signature": "ey4uLn0"
                }
              ]
            },
            "links": [
              "https://link.to/data"
            ],
            "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
          },
          "description": "view from doorway, facing east, with lights off",
          "filename": "IMG1092348.png",
          "lastmod_time": "2021-12-31T23:59:59Z",
          "mime-type": "image/png"
        }
      ]
    },
    "error_msg": "The front fell off",
    "initiator": "self",
    "parent_thread_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "role": "issuer",
    "state": "done",
    "thread_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "trace": true,
    "updated_at": "2021-12-31T23:59:59Z"
  }
}

Step 5: Holder stores Credential

The Holder has to store the issued credential into their wallet using the following API.

Store a received credential

post

Path parameters

cred_ex_idstringRequired

Credential exchange identifier

Example: {"value":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

Body

application/json

credential_idstringOptional

Responses

200Success

application/json

post

/issue-credential-2.0/records/{cred_ex_id}/store

HTTPcURLJavaScriptPython

POST /issue-credential-2.0/records/{cred_ex_id}/store HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "credential_id": "text"
}

200Success

{
  "cred_ex_record": {
    "auto_issue": false,
    "auto_offer": false,
    "auto_remove": false,
    "by_format": {
      "cred_issue": {},
      "cred_offer": {},
      "cred_proposal": {},
      "cred_request": {}
    },
    "connection_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created_at": "2021-12-31T23:59:59Z",
    "cred_ex_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "cred_issue": {
      "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "@type": "https://didcomm.org/my-family/1.0/my-message-type",
      "comment": "text",
      "credentials~attach": [
        {
          "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "byte_count": 1234,
          "data": {
            "base64": "ey4uLn0=",
            "json": "{\"sample\": \"content\"}",
            "jws": {
              "header": {
                "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
              },
              "protected": "ey4uLn0",
              "signature": "ey4uLn0",
              "signatures": [
                {
                  "header": {
                    "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                  },
                  "protected": "ey4uLn0",
                  "signature": "ey4uLn0"
                }
              ]
            },
            "links": [
              "https://link.to/data"
            ],
            "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
          },
          "description": "view from doorway, facing east, with lights off",
          "filename": "IMG1092348.png",
          "lastmod_time": "2021-12-31T23:59:59Z",
          "mime-type": "image/png"
        }
      ],
      "formats": [
        {
          "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "format": "aries/[email protected]"
        }
      ],
      "replacement_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "cred_offer": {
      "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "@type": "https://didcomm.org/my-family/1.0/my-message-type",
      "comment": "text",
      "credential_preview": {
        "@type": "issue-credential/2.0/credential-preview",
        "attributes": [
          {
            "mime-type": "image/jpeg",
            "name": "favourite_drink",
            "value": "martini"
          }
        ]
      },
      "formats": [
        {
          "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "format": "aries/[email protected]"
        }
      ],
      "offers~attach": [
        {
          "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "byte_count": 1234,
          "data": {
            "base64": "ey4uLn0=",
            "json": "{\"sample\": \"content\"}",
            "jws": {
              "header": {
                "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
              },
              "protected": "ey4uLn0",
              "signature": "ey4uLn0",
              "signatures": [
                {
                  "header": {
                    "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                  },
                  "protected": "ey4uLn0",
                  "signature": "ey4uLn0"
                }
              ]
            },
            "links": [
              "https://link.to/data"
            ],
            "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
          },
          "description": "view from doorway, facing east, with lights off",
          "filename": "IMG1092348.png",
          "lastmod_time": "2021-12-31T23:59:59Z",
          "mime-type": "image/png"
        }
      ],
      "replacement_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "cred_preview": {
      "@type": "issue-credential/2.0/credential-preview",
      "attributes": [
        {
          "mime-type": "image/jpeg",
          "name": "favourite_drink",
          "value": "martini"
        }
      ]
    },
    "cred_proposal": {
      "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "@type": "https://didcomm.org/my-family/1.0/my-message-type",
      "comment": "text",
      "credential_preview": {
        "@type": "issue-credential/2.0/credential-preview",
        "attributes": [
          {
            "mime-type": "image/jpeg",
            "name": "favourite_drink",
            "value": "martini"
          }
        ]
      },
      "filters~attach": [
        {
          "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "byte_count": 1234,
          "data": {
            "base64": "ey4uLn0=",
            "json": "{\"sample\": \"content\"}",
            "jws": {
              "header": {
                "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
              },
              "protected": "ey4uLn0",
              "signature": "ey4uLn0",
              "signatures": [
                {
                  "header": {
                    "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                  },
                  "protected": "ey4uLn0",
                  "signature": "ey4uLn0"
                }
              ]
            },
            "links": [
              "https://link.to/data"
            ],
            "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
          },
          "description": "view from doorway, facing east, with lights off",
          "filename": "IMG1092348.png",
          "lastmod_time": "2021-12-31T23:59:59Z",
          "mime-type": "image/png"
        }
      ],
      "formats": [
        {
          "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "format": "aries/[email protected]"
        }
      ]
    },
    "cred_request": {
      "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "@type": "https://didcomm.org/my-family/1.0/my-message-type",
      "comment": "text",
      "formats": [
        {
          "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "format": "aries/[email protected]"
        }
      ],
      "requests~attach": [
        {
          "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "byte_count": 1234,
          "data": {
            "base64": "ey4uLn0=",
            "json": "{\"sample\": \"content\"}",
            "jws": {
              "header": {
                "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
              },
              "protected": "ey4uLn0",
              "signature": "ey4uLn0",
              "signatures": [
                {
                  "header": {
                    "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                  },
                  "protected": "ey4uLn0",
                  "signature": "ey4uLn0"
                }
              ]
            },
            "links": [
              "https://link.to/data"
            ],
            "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
          },
          "description": "view from doorway, facing east, with lights off",
          "filename": "IMG1092348.png",
          "lastmod_time": "2021-12-31T23:59:59Z",
          "mime-type": "image/png"
        }
      ]
    },
    "error_msg": "The front fell off",
    "initiator": "self",
    "parent_thread_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "role": "issuer",
    "state": "done",
    "thread_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "trace": true,
    "updated_at": "2021-12-31T23:59:59Z"
  },
  "indy": {
    "created_at": "2021-12-31T23:59:59Z",
    "cred_ex_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "cred_ex_indy_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "cred_id_stored": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "cred_request_metadata": {},
    "cred_rev_id": "12345",
    "rev_reg_id": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0",
    "state": "active",
    "updated_at": "2021-12-31T23:59:59Z"
  },
  "ld_proof": {
    "created_at": "2021-12-31T23:59:59Z",
    "cred_ex_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "cred_ex_ld_proof_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "cred_id_stored": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "state": "active",
    "updated_at": "2021-12-31T23:59:59Z"
  },
  "vc_di": {
    "auto_issue": false,
    "auto_offer": false,
    "auto_remove": false,
    "by_format": {
      "cred_issue": {},
      "cred_offer": {},
      "cred_proposal": {},
      "cred_request": {}
    },
    "connection_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created_at": "2021-12-31T23:59:59Z",
    "cred_ex_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "cred_issue": {
      "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "@type": "https://didcomm.org/my-family/1.0/my-message-type",
      "comment": "text",
      "credentials~attach": [
        {
          "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "byte_count": 1234,
          "data": {
            "base64": "ey4uLn0=",
            "json": "{\"sample\": \"content\"}",
            "jws": {
              "header": {
                "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
              },
              "protected": "ey4uLn0",
              "signature": "ey4uLn0",
              "signatures": [
                {
                  "header": {
                    "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                  },
                  "protected": "ey4uLn0",
                  "signature": "ey4uLn0"
                }
              ]
            },
            "links": [
              "https://link.to/data"
            ],
            "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
          },
          "description": "view from doorway, facing east, with lights off",
          "filename": "IMG1092348.png",
          "lastmod_time": "2021-12-31T23:59:59Z",
          "mime-type": "image/png"
        }
      ],
      "formats": [
        {
          "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "format": "aries/[email protected]"
        }
      ],
      "replacement_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "cred_offer": {
      "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "@type": "https://didcomm.org/my-family/1.0/my-message-type",
      "comment": "text",
      "credential_preview": {
        "@type": "issue-credential/2.0/credential-preview",
        "attributes": [
          {
            "mime-type": "image/jpeg",
            "name": "favourite_drink",
            "value": "martini"
          }
        ]
      },
      "formats": [
        {
          "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "format": "aries/[email protected]"
        }
      ],
      "offers~attach": [
        {
          "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "byte_count": 1234,
          "data": {
            "base64": "ey4uLn0=",
            "json": "{\"sample\": \"content\"}",
            "jws": {
              "header": {
                "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
              },
              "protected": "ey4uLn0",
              "signature": "ey4uLn0",
              "signatures": [
                {
                  "header": {
                    "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                  },
                  "protected": "ey4uLn0",
                  "signature": "ey4uLn0"
                }
              ]
            },
            "links": [
              "https://link.to/data"
            ],
            "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
          },
          "description": "view from doorway, facing east, with lights off",
          "filename": "IMG1092348.png",
          "lastmod_time": "2021-12-31T23:59:59Z",
          "mime-type": "image/png"
        }
      ],
      "replacement_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "cred_preview": {
      "@type": "issue-credential/2.0/credential-preview",
      "attributes": [
        {
          "mime-type": "image/jpeg",
          "name": "favourite_drink",
          "value": "martini"
        }
      ]
    },
    "cred_proposal": {
      "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "@type": "https://didcomm.org/my-family/1.0/my-message-type",
      "comment": "text",
      "credential_preview": {
        "@type": "issue-credential/2.0/credential-preview",
        "attributes": [
          {
            "mime-type": "image/jpeg",
            "name": "favourite_drink",
            "value": "martini"
          }
        ]
      },
      "filters~attach": [
        {
          "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "byte_count": 1234,
          "data": {
            "base64": "ey4uLn0=",
            "json": "{\"sample\": \"content\"}",
            "jws": {
              "header": {
                "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
              },
              "protected": "ey4uLn0",
              "signature": "ey4uLn0",
              "signatures": [
                {
                  "header": {
                    "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                  },
                  "protected": "ey4uLn0",
                  "signature": "ey4uLn0"
                }
              ]
            },
            "links": [
              "https://link.to/data"
            ],
            "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
          },
          "description": "view from doorway, facing east, with lights off",
          "filename": "IMG1092348.png",
          "lastmod_time": "2021-12-31T23:59:59Z",
          "mime-type": "image/png"
        }
      ],
      "formats": [
        {
          "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "format": "aries/[email protected]"
        }
      ]
    },
    "cred_request": {
      "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "@type": "https://didcomm.org/my-family/1.0/my-message-type",
      "comment": "text",
      "formats": [
        {
          "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "format": "aries/[email protected]"
        }
      ],
      "requests~attach": [
        {
          "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "byte_count": 1234,
          "data": {
            "base64": "ey4uLn0=",
            "json": "{\"sample\": \"content\"}",
            "jws": {
              "header": {
                "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
              },
              "protected": "ey4uLn0",
              "signature": "ey4uLn0",
              "signatures": [
                {
                  "header": {
                    "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                  },
                  "protected": "ey4uLn0",
                  "signature": "ey4uLn0"
                }
              ]
            },
            "links": [
              "https://link.to/data"
            ],
            "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
          },
          "description": "view from doorway, facing east, with lights off",
          "filename": "IMG1092348.png",
          "lastmod_time": "2021-12-31T23:59:59Z",
          "mime-type": "image/png"
        }
      ]
    },
    "error_msg": "The front fell off",
    "initiator": "self",
    "parent_thread_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "role": "issuer",
    "state": "done",
    "thread_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "trace": true,
    "updated_at": "2021-12-31T23:59:59Z"
  }
}