Sign in

v1

latestOpenAPI 3.0.0Apache-2.02026-07-1767300384.3 KB
DIDComm Out Of Band

Retrieve all out of band records by query

get/didcomm/out-of-band

Query parameters

invitationIdstring
role'sender' | 'receiver'
state'initial' | 'await-response' | 'prepare-response' | 'done'
threadIdstring

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
role'sender' | 'receiver' required
state'initial' | 'await-response' | 'prepare-response' | 'done' required
aliasstring

Alias for the connection(s) created based on the out of band invitation

reusableboolean required

Whether the out of band invitation is reusable

autoAcceptConnectionboolean

Whether to auto accept the out of band invitation. If not defined agent config will be used.

mediatorIdstring
reuseConnectionIdstring

Example response

[
  {
    "id": "821f9b26-ad04-4f56-89b6-e2ef9c72b36e",
    "alias": "My Connection",
    "reusable": true,
    "autoAcceptConnection": true,
    "mediatorId": "821f9b26-ad04-4f56-89b6-e2ef9c72b36e",
    "reuseConnectionId": "821f9b26-ad04-4f56-89b6-e2ef9c72b36e"
  }
]