Skip to content
CREDEBL Logo CREDEBL Docs

CreateInvitation

POST
/oob/create-invitation

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

Authorizations

Request Body required

Configuration of how out-of-band invitation should be created

Configuration of how out-of-band invitation should be created

object
label
string
alias
string
imageUrl
string
goalCode
string
goal
string
handshake
boolean
handshakeProtocols
Array<string>
Allowed values: https://didcomm.org/didexchange/1.x https://didcomm.org/connections/1.x
messages
Array<object>
object
@type
required
string
@id
required
string
~thread
object
pthid
string
thid
string
messageType
required
string
key
additional properties
multiUseInvitation
boolean
autoAcceptConnection
boolean
routing
object
endpoints
required
Array<string>
recipientKey
required
object
publicKey
required
string format: byte
keyType
required
string
Allowed values: ed25519 bls12381g1g2 bls12381g1 bls12381g2 x25519 p256 p384 p521 k256
routingKeys
required
Array<object>
object
publicKey
required
string format: byte
keyType
required
string
Allowed values: ed25519 bls12381g1g2 bls12381g1 bls12381g2 x25519 p256 p384 p521 k256
mediatorId
string
appendedAttachments
Array
invitationDid
string
recipientKey
string

Responses

200

Out of band record

object
invitationDid
required
string
outOfBandRecord
required

Construct a type with a set of properties K of type T

object
invitation
required
object
@type
required
string
@id
required
string
~thread
object
pthid
string
thid
string
messageType
required
string
key
additional properties
invitationUrl
required
string
Examples
{
  "invitationUrl": "string",
  "invitation": {
    "@type": "did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/out-of-band/1.1/invitation",
    "@id": "d6472943-e5d0-4d95-8b48-790ed5a41931",
    "label": "Aries Test Agent",
    "accept": [
      "didcomm/aip1",
      "didcomm/aip2;env=rfc19"
    ],
    "handshake_protocols": [
      "https://didcomm.org/didexchange/1.0",
      "https://didcomm.org/connections/1.0"
    ],
    "services": [
      {
        "id": "#inline-0",
        "serviceEndpoint": "https://6b77-89-20-162-146.ngrok.io",
        "type": "did-communication",
        "recipientKeys": [
          "did:key:z6MkmTBHTWrvLPN8pBmUj7Ye5ww9GiacXCYMNVvpScSpf1DM"
        ],
        "routingKeys": []
      }
    ]
  },
  "outOfBandRecord": {
    "_tags": {
      "invitationId": "1cbd22e4-1906-41e9-8807-83d84437f978",
      "state": "await-response",
      "role": "sender",
      "recipientKeyFingerprints": [
        "z6MktUCPZjfRJXD4GMcYuXiqX2qZ8vBw6UAYpDFiHEUfwuLj"
      ]
    },
    "outOfBandInvitation": {
      "@type": "did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/out-of-band/1.1/invitation",
      "@id": "d6472943-e5d0-4d95-8b48-790ed5a41931",
      "label": "Aries Test Agent",
      "accept": [
        "didcomm/aip1",
        "didcomm/aip2;env=rfc19"
      ],
      "handshake_protocols": [
        "https://didcomm.org/didexchange/1.0",
        "https://didcomm.org/connections/1.0"
      ],
      "services": [
        {
          "id": "#inline-0",
          "serviceEndpoint": "https://6b77-89-20-162-146.ngrok.io",
          "type": "did-communication",
          "recipientKeys": [
            "did:key:z6MkmTBHTWrvLPN8pBmUj7Ye5ww9GiacXCYMNVvpScSpf1DM"
          ],
          "routingKeys": []
        }
      ]
    },
    "metadata": {},
    "id": "42a95528-0e30-4f86-a462-0efb02178b53",
    "createdAt": "2022-01-01T00:00:00.000Z",
    "reusable": false
  }
}