DIDComm Proofs

Changed on

Initiate a new presentation exchange as prover by sending a presentation proposal request to the connection with the specified connection id.

post/didcomm/proofs/propose-proof

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /didcomm/proofs/propose-proof
  • Auth
    none declared

Headers

x-tenant-idstring

Optional header to set the context to a specific tenant. Only needed when the --multi-tenant feature is enabled. Default value is 'default'

Request body

connectionIdstring required
goalCodestring
parentThreadIdstring
autoAcceptProof'always' | 'contentApproved' | 'never'

Typing of the state for auto acceptance

commentstring
protocolVersion'v1' | 'v2' required

Response

Ok

idstring required
createdAtstring date-time required
updatedAtstring date-time
typestring required
connectionIdstring
threadIdstring required
parentThreadIdstring
state'proposal-sent' | 'proposal-received' | 'request-sent' | 'request-received' | 'presentation-sent' | 'presentation-received' | 'declined' | 'abandoned' | 'done' required

Present Proof protocol states as defined in RFC 0037

role'verifier' | 'prover' required
autoAcceptProof'always' | 'contentApproved' | 'never'

Typing of the state for auto acceptance

errorMessagestring
protocolVersionstring required

Example response

{
  "id": "821f9b26-ad04-4f56-89b6-e2ef9c72b36e",
  "connectionId": "821f9b26-ad04-4f56-89b6-e2ef9c72b36e",
  "threadId": "ea4e5e69-fc04-465a-90d2-9f8ff78aa71d",
  "parentThreadId": "ea4e5e69-fc04-465a-90d2-9f8ff78aa71d"
}

Changes

  • 33596742b733Revision changes
    • info

      the endpoint scheme security tenants was removed from the API

    • info

      added the new optional header request parameter x-tenant-id

  • a7641432a6c1Revision changes
    • warning

      deleted the header request parameter x-tenant-id

    • info

      the endpoint scheme security tenants was added to the API