Skip to content
CREDEBL Logo CREDEBL Docs

Create connection invitation for cloud wallet

POST
/connections/invitation

Create connection invitation

Authorizations

Request Body required

object
label
string
alias
string
imageUrl
string
multiUseInvitation
boolean
true
autoAcceptConnection
boolean
true
goalCode
string
goal
string
handshake
boolean
true
handshakeProtocols
Array<string>
[
  "https://didcomm.org/didexchange/1.x"
]
messages
Array<string>
[
  {
    "@type": "string",
    "@id": "string",
    "~thread": {
      "pthid": "string",
      "thid": "string"
    },
    "messageType": "string",
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
]
appendedAttachments
Array<string>
[
  {
    "id": "string",
    "description": "string",
    "filename": "string",
    "mimeType": "string",
    "lastmodTime": "2024-07-19T13:24:42.255Z",
    "byteCount": 0,
    "data": {
      "base64": "string",
      "json": "string",
      "links": [
        "string"
      ],
      "jws": {
        "header": {},
        "signature": "string",
        "protected": "string"
      },
      "sha256": "string"
    }
  }
]
invitationDid
string
recipientKey
string

Responses

201

Created

object
message
required
string
Success
success
required
boolean
data
required
object
statusCode
required
number
200

401

Unauthorized

object
statusCode
required
number
401
error
required
string
Unauthorized

403

Forbidden

object
statusCode
required
number
403
error
required
string
Forbidden