Sign in

v1

latestOpenAPI 3.0.0Apache-2.02026-07-1767300384.3 KB
DIDComm Credentials

Retrieve all credential exchange records by query

get/didcomm/credentials

Query parameters

threadIdstring
Example:ea4e5e69-fc04-465a-90d2-9f8ff78aa71d
parentThreadIdstring
Example:ea4e5e69-fc04-465a-90d2-9f8ff78aa71d
connectionIdstring
Example:821f9b26-ad04-4f56-89b6-e2ef9c72b36e
state'proposal-sent' | 'proposal-received' | 'offer-sent' | 'offer-received' | 'declined' | 'request-sent' | 'request-received' | 'credential-issued' | 'credential-received' | 'done' | 'abandoned'

Issue Credential states as defined in RFC 0036 and RFC 0453

role'issuer' | 'holder'

Headers

x-tenant-idstring

Optional header to set the context to a specific tenant. Only needed when the --multi-tenant feature is enabled. Default value is 'default'

Response

Ok

idstring required
createdAtstring date-time required
updatedAtstring date-time
typestring required
connectionIdstring
threadIdstring required
parentThreadIdstring
state'proposal-sent' | 'proposal-received' | 'offer-sent' | 'offer-received' | 'declined' | 'request-sent' | 'request-received' | 'credential-issued' | 'credential-received' | 'done' | 'abandoned' required

Issue Credential states as defined in RFC 0036 and RFC 0453

role'issuer' | 'holder' required
autoAcceptCredential'always' | 'contentApproved' | 'never'

Typing of the state for auto acceptance

errorMessagestring
protocolVersionstring required

Example response

[
  {
    "id": "821f9b26-ad04-4f56-89b6-e2ef9c72b36e",
    "connectionId": "821f9b26-ad04-4f56-89b6-e2ef9c72b36e",
    "threadId": "ea4e5e69-fc04-465a-90d2-9f8ff78aa71d",
    "parentThreadId": "ea4e5e69-fc04-465a-90d2-9f8ff78aa71d"
  }
]