DIDComm Out Of Band

Changed on

Retrieve an out of band record by id

get/didcomm/out-of-band/{outOfBandId}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /didcomm/out-of-band/{outOfBandId}
  • Auth
    none declared

Path parameters

outOfBandIdstring required
Example:821f9b26-ad04-4f56-89b6-e2ef9c72b36e

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"
}

Changes

  • 33596742b733Revision changes
    • info

      the endpoint scheme security tenants was removed from the API

    • info

      added the new optional header request parameter x-tenant-id

  • a7641432a6c1Revision changes
    • warning

      deleted the header request parameter x-tenant-id

    • info

      the endpoint scheme security tenants was added to the API