Receive connection invitation
POST/digital-wallet/connection/receive
Receive a new connection invitation
Request
Query Parameters
alias string
Alias
autoAccept boolean
Auto-accept connection
- application/json
Body
required
connectionUrl stringrequired
the connection invitation url
Responses
- 200
- 400
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
connection object
id string
Identifier
accept string
Possible values: [manual
, auto
]
Connection acceptance
alias string
Optional alias to apply to connection for later use
connectionId string
Connection identifier
createdAt string
Time of record creation
errorMsg string
Error message
inboundConnectionId string
Inbound routing connection id to use
initiator string
Possible values: [self
, external
, multiuse
]
Connection initiator
invitationKey string
Public key for connection
invitationMode string
Possible values: [once
, multi
, static
]
Invitation mode
myDid string
Our DID for connection
requestId string
Connection request identifier
routingState string
Routing state of connection
state string
Current record state
theirDid string
Their DID for connection
theirLabel string
Their label for connection
theirRole string
Their assigned role for connection
trustAnchor string
Trust anchor for connection
updatedAt string
Time of last record update
{
"connection": {
"id": "65e760f8dcf16cb987552297",
"accept": "auto",
"alias": "Bob, providing quotes",
"connectionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createdAt": "2024-02-28 07:03:35Z",
"errorMsg": "No DIDDoc provided; cannot connect to public DID",
"inboundConnectionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"initiator": "self",
"invitationKey": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV",
"invitationMode": "once",
"myDid": "WgWxqztrNooG92RXvxSTWv",
"requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"routingState": "active",
"state": "active",
"theirDid": "WgWxqztrNooG92RXvxSTWv",
"theirLabel": "Bob",
"theirRole": "Point of contact",
"trustAnchor": "sovrinlive",
"updatedAt": "2024-02-28 07:03:35Z"
}
}
bad input parameter
Response Headers
Loading...