Skip to content
CREDEBL Logo CREDEBL Docs

ReceiveInvitation

POST
/oob/receive-invitation

Creates inbound out-of-band record and assigns out-of-band invitation message to it if the message is valid.

Authorizations

Request Body required

object
alias
string
label
string
imageUrl
string
autoAcceptConnection
boolean
autoAcceptInvitation
boolean
reuseConnection
boolean
acceptInvitationTimeoutMs
number format: double
ourDid
string
invitation
required
object
@id
string
@type
required
string
label
required
string
goalCode
string
goal
string
accept
Array<string>
handshake_protocols
Array<string>
Allowed values: https://didcomm.org/didexchange/1.1 https://didcomm.org/connections/1.0
services
required
Array
Any of:
object
id
required
string
serviceEndpoint
required
string
type
required
string
recipientKeys
required
Array<string>
routingKeys
Array<string>
accept
Array<string>
imageUrl
string

Responses

200

Out-of-band record and connection record if one has been created.

object
connectionRecord
required

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

object
outOfBandRecord
required

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

object
Examples
{
  "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
  },
  "connectionRecord": {
    "_tags": {
      "invitationDid": "did:peer:2.SeyJzIjoiaHR0cHM6Ly9kYTIzLTg5LTIwLTE2Mi0xNDYubmdyb2suaW8iLCJ0IjoiZGlkLWNvbW11bmljYXRpb24iLCJwcmlvcml0eSI6MCwicmVjaXBpZW50S2V5cyI6WyJkaWQ6a2V5Ono2TWtualg3U1lXRmdHMThCYkNEZHJnemhuQnA0UlhyOGVITHZxQ3FvRXllckxiTiN6Nk1rbmpYN1NZV0ZnRzE4QmJDRGRyZ3pobkJwNFJYcjhlSEx2cUNxb0V5ZXJMYk4iXSwiciI6W119",
      "did": "did:peer:1zQmfQh1T3rSqarP2FZ37uKjdQHPKFdVyo2mGiAPHZ8Ep7hv",
      "invitationKey": "9HG4rJFpLiWf56MWxHj9rgdpErFzim2zEpHuxy1dw7oz",
      "outOfBandId": "edbc89fe-785f-4774-a288-46012486881d",
      "verkey": "9HG4rJFpLiWf56MWxHj9rgdpErFzim2zEpHuxy1dw7oz"
    },
    "metadata": {},
    "id": "821f9b26-ad04-4f56-89b6-e2ef9c72b36e",
    "createdAt": "2022-01-01T00:00:00.000Z",
    "did": "did:peer:1zQmfQh1T3rSqarP2FZ37uKjdQHPKFdVyo2mGiAPHZ8Ep7hv",
    "invitationDid": "did:peer:2.SeyJzIjoiaHR0cHM6Ly9kYTIzLTg5LTIwLTE2Mi0xNDYubmdyb2suaW8iLCJ0IjoiZGlkLWNvbW11bmljYXRpb24iLCJwcmlvcml0eSI6MCwicmVjaXBpZW50S2V5cyI6WyJkaWQ6a2V5Ono2TWtualg3U1lXRmdHMThCYkNEZHJnemhuQnA0UlhyOGVITHZxQ3FvRXllckxiTiN6Nk1rbmpYN1NZV0ZnRzE4QmJDRGRyZ3pobkJwNFJYcjhlSEx2cUNxb0V5ZXJMYk4iXSwiciI6W119",
    "outOfBandId": "edbc89fe-785f-4774-a288-46012486881d"
  }
}