DIDComm Out Of Band

Changed on

Creates an outbound out-of-band record containing out-of-band invitation message defined in Aries RFC 0434: Out-of-Band Protocol 1.1.

post/didcomm/out-of-band/create-invitation

Request

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

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'

Request body

labelstring
goalCodestring
aliasstring
imageUrlstring
goalstring
handshakeboolean
handshakeProtocolsHandshakeProtocol[]
multiUseInvitationboolean
autoAcceptConnectionboolean

Response

Ok

invitationUrlstring required

Example response

{
  "outOfBandRecord": {
    "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