v2/didcomm
Operates on the wire-level DIDComm state of the agent.
List protocols
Returns the protocol modules that this deployment serves.
Send a basic message
Sends a text message on an established connection.
List basic messages
Returns the message records, filtered when the caller supplies a filter.
Create a presentation request
Creates a Presentation Request. The body names the credentials, and the attributes of them, that the holder is asked to present. An entry that omits `attributes` asks for every attribute the schema defines. With a `connectionId` the agent sends the request on that connection and answers with neither `invitation` nor `shortUrl`; without one it mints an Out-of-Band invitation.
Accept a presentation request
Accepts a presentation request that a peer sent to this agent, and presents the matching credentials from the credential store of the agent. The agent selects the credentials.
Accept a presentation
Acknowledges a received presentation as verifier, and completes the exchange. This method does not change the verification result: the agent verified the presentation when it received it, and stored the result in `verified`.
List presentations
Returns the presentation flows that the agent created, filtered when the caller supplies a filter.
Get a presentation
Retrieves one presentation by `proofExchangeId`.
Delete a presentation
Deletes a presentation exchange record, along with the DIDComm messages it accumulated.
Decline a presentation exchange
Refuses the pending step of a presentation exchange, in either role. The agent sends a problem report to the peer and ends the exchange in state `declined`.
List connections
Returns the connection records, filtered when the caller supplies a filter.
Get a connection
Retrieves one connection record by identifier.
Delete a connection
Deletes a connection record, and drops the routing it held on its mediator when it had one. The connections opened from invitations sent on it stay, each with its `parentConnectionId`.
Create a credential offer
Creates an AnonCreds credential offer, with a preview of the offered claims. With a `connectionId` the agent sends the offer on that connection and answers with neither `invitation` nor `shortUrl`; without one it makes an Out-of-Band invitation. A revocable credential definition also needs `revocationRegistryDefinitionId` and `revocationRegistryIndex`.
Decline a credential exchange
Refuses the pending step of a credential exchange, in either role. The agent sends a problem report to the peer and ends the exchange in state `declined`.
Accept a credential offer
Accepts a credential offer that a peer sent to this agent, and requests the credential.
Accept a credential request
Accepts a credential request as issuer, and issues the credential. The agent issues the claims that the offer previewed. A caller that wants other claims declines this exchange and starts a new offer.
Accept a credential
Accepts a received credential as holder: the agent stores the credential in its credential store and acknowledges it to the issuer.
List credential exchanges
Returns the credential exchange records that the agent tracks, filtered when the caller supplies a filter.
Get a credential exchange
Retrieves one credential exchange record by identifier.
Send an invitation
Sends an Out-of-Band invitation on an established connection. A v1 connection carries the Out-of-Band 1.1 message. A v2 connection carries the Out-of-Band 2.0 invitation in the `application/didcomm-plain+json` attachment of a Media Sharing share-media message. Without `did`, the invitation opens a single-use sub-connection to this agent, correlated through `parentConnectionId`. With `did`, it refers the peer to that service and creates no record.