Present a Verifiable Credential

Using the /present-proof-2.0 API endpoints, it is possible to present Verifiable Credentials, signed by a cheqd DID, in a few clicks or lines of code. This process enables secure and trustworthy sharing of verifiable credentials within the ACA-Py framework and cheqd ecosystem.

Step 1: Create a Connection with Holder

Use any supported method to create a connection with the Holder. Automated out-of-band protocol is recommended. You can follow the same steps as described in Issue a Verifiable Credential.

Step 2: Send Proof Request

After connection is established, the Verifier can send a proof request to the Holder.

Sends a free presentation request not bound to any proposal

POST/present-proof-2.0/send-request

Body

application/json

auto_removeboolean

Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)

auto_verifyboolean

Verifier choice to auto-verify proof presentation

Example: false

commentnullable string

connection_id*string

Connection identifier

Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

presentation_request*object

traceboolean

Whether to trace event (default false)

Example: false

Response

200

Body

application/json

auto_presentboolean

Prover choice to auto-present proof as verifier requests

Example: false

auto_removeboolean

Verifier choice to remove this presentation exchange record when complete

Example: false

auto_verifyboolean

Verifier choice to auto-verify proof presentation

by_formatall of

Attachment content by format for proposal, request, and presentation

connection_idstring

Connection identifier

Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

created_atstring

Time of record creation

Example: "2021-12-31T23:59:59Z"

Pattern: ^\d{4}-\d\d-\d\d[T ]\d\d:\d\d(?:\:(?:\d\d(?:\.\d{1,6})?))?(?:[+-]\d\d:?\d\d|Z|)$

error_msgstring

Error message

Example: "Invalid structure"

initiatorenum

Present-proof exchange initiator: self or external

Example: "self"

selfexternal

presall of

Presentation message

pres_ex_idstring

Presentation exchange identifier

Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

pres_proposalall of

Presentation proposal message

pres_requestall of

Presentation request message

roleenum

Present-proof exchange role: prover or verifier

Example: "prover"

proververifier

stateenum

Present-proof exchange state

proposal-sentproposal-receivedrequest-sentrequest-receivedpresentation-sentpresentation-receiveddoneabandoneddeleted

thread_idstring

Thread identifier

Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

traceboolean

Record trace information, based on agent configuration

updated_atstring

Time of last record update

Example: "2021-12-31T23:59:59Z"

Pattern: ^\d{4}-\d\d-\d\d[T ]\d\d:\d\d(?:\:(?:\d\d(?:\.\d{1,6})?))?(?:[+-]\d\d:?\d\d|Z|)$

verifiedenum

Whether presentation is verified: 'true' or 'false'

Example: "true"

truefalse

verified_msgsarray of string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/present-proof-2.0/send-request', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "auto_verify": false,
      "connection_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "presentation_request": {
        "anoncreds": {
          "name": "Proof request",
          "non_revoked": {
            "from": 1640995199,
            "to": 1640995199
          },
          "nonce": "1",
          "requested_attributes": {
            "ANY_ADDITIONAL_PROPERTY": {
              "name": "favouriteDrink",
              "names": [
                "age"
              ],
              "non_revoked": {
                "from": 1640995199,
                "to": 1640995199
              },
              "restrictions": [
                {
                  "ANY_ADDITIONAL_PROPERTY": "did:(method):3:CL:20:tag"
                }
              ]
            }
          },
          "requested_predicates": {
            "ANY_ADDITIONAL_PROPERTY": {
              "name": "index",
              "non_revoked": {
                "from": 1640995199,
                "to": 1640995199
              },
              "p_type": ">=",
              "p_value": 1,
              "restrictions": [
                {
                  "ANY_ADDITIONAL_PROPERTY": "did:(method):3:CL:20:tag"
                }
              ]
            }
          },
          "version": "1.0"
        },
        "dif": {
          "options": {
            "challenge": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "domain": "4jt78h47fh47"
          },
          "presentation_definition": {
            "format": {
              "di_vc": {},
              "jwt": {},
              "jwt_vc": {},
              "jwt_vp": {},
              "ldp": {},
              "ldp_vc": {},
              "ldp_vp": {}
            },
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "input_descriptors": [
              {
                "constraints": {
                  "fields": [
                    {
                      "filter": {
                        "enum": [],
                        "maxLength": 1234,
                        "minLength": 1234,
                        "not": false
                      },
                      "path": [
                        null
                      ],
                      "predicate": "required"
                    }
                  ],
                  "is_holder": [
                    {
                      "directive": "required",
                      "field_id": [
                        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
                      ]
                    }
                  ],
                  "status_active": "required",
                  "status_revoked": "required",
                  "status_suspended": "required",
                  "subject_is_issuer": "required"
                },
                "group": [
                  null
                ],
                "metadata": {},
                "schema": {
                  "oneof_filter": [
                    [
                      {
                        "uri": "https://www.w3.org/Test1#Test1"
                      },
                      {
                        "uri": "https://www.w3.org/Test2#Test2"
                      }
                    ],
                    {
                      "oneof_filter": [
                        [
                          {
                            "uri": "https://www.w3.org/Test1#Test1"
                          }
                        ],
                        [
                          {
                            "uri": "https://www.w3.org/Test2#Test2"
                          }
                        ]
                      ]
                    }
                  ]
                }
              }
            ],
            "submission_requirements": [
              "[Circular Reference]"
            ]
          },
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "indy": {
          "name": "Proof request",
          "non_revoked": {
            "from": 1640995199,
            "to": 1640995199
          },
          "nonce": "1",
          "requested_attributes": {
            "ANY_ADDITIONAL_PROPERTY": {
              "name": "favouriteDrink",
              "names": [
                "age"
              ],
              "non_revoked": {
                "from": 1640995199,
                "to": 1640995199
              },
              "restrictions": [
                {
                  "ANY_ADDITIONAL_PROPERTY": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"
                }
              ]
            }
          },
          "requested_predicates": {
            "ANY_ADDITIONAL_PROPERTY": {
              "name": "index",
              "non_revoked": {
                "from": 1640995199,
                "to": 1640995199
              },
              "p_type": ">=",
              "p_value": 1,
              "restrictions": [
                {
                  "ANY_ADDITIONAL_PROPERTY": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"
                }
              ]
            }
          },
          "version": "1.0"
        }
      },
      "trace": false
    }),
});
const data = await response.json();

Response

200

{
  "auto_present": false,
  "auto_remove": false,
  "auto_verify": true,
  "by_format": {
    "pres": {},
    "pres_proposal": {},
    "pres_request": {}
  },
  "connection_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_at": "2021-12-31T23:59:59Z",
  "error_msg": "Invalid structure",
  "initiator": "self",
  "pres": {
    "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "@type": "https://didcomm.org/my-family/1.0/my-message-type",
    "comment": "text",
    "formats": [
      {
        "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "format": "dif/presentation-exchange/submission@v1.0"
      }
    ],
    "presentations~attach": [
      {
        "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "byte_count": 1234,
        "data": {
          "base64": "ey4uLn0=",
          "json": "{\"sample\": \"content\"}",
          "jws": {
            "header": {
              "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
            },
            "protected": "ey4uLn0",
            "signature": "ey4uLn0",
            "signatures": [
              {
                "header": {
                  "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                },
                "protected": "ey4uLn0",
                "signature": "ey4uLn0"
              }
            ]
          },
          "links": [
            "https://link.to/data"
          ],
          "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
        },
        "description": "view from doorway, facing east, with lights off",
        "filename": "IMG1092348.png",
        "lastmod_time": "2021-12-31T23:59:59Z",
        "mime-type": "image/png"
      }
    ]
  },
  "pres_ex_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "pres_proposal": {
    "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "@type": "https://didcomm.org/my-family/1.0/my-message-type",
    "comment": "text",
    "formats": [
      {
        "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "format": "dif/presentation-exchange/submission@v1.0"
      }
    ],
    "proposals~attach": [
      {
        "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "byte_count": 1234,
        "data": {
          "base64": "ey4uLn0=",
          "json": "{\"sample\": \"content\"}",
          "jws": {
            "header": {
              "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
            },
            "protected": "ey4uLn0",
            "signature": "ey4uLn0",
            "signatures": [
              {
                "header": {
                  "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                },
                "protected": "ey4uLn0",
                "signature": "ey4uLn0"
              }
            ]
          },
          "links": [
            "https://link.to/data"
          ],
          "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
        },
        "description": "view from doorway, facing east, with lights off",
        "filename": "IMG1092348.png",
        "lastmod_time": "2021-12-31T23:59:59Z",
        "mime-type": "image/png"
      }
    ]
  },
  "pres_request": {
    "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "@type": "https://didcomm.org/my-family/1.0/my-message-type",
    "comment": "text",
    "formats": [
      {
        "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "format": "dif/presentation-exchange/submission@v1.0"
      }
    ],
    "request_presentations~attach": [
      {
        "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "byte_count": 1234,
        "data": {
          "base64": "ey4uLn0=",
          "json": "{\"sample\": \"content\"}",
          "jws": {
            "header": {
              "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
            },
            "protected": "ey4uLn0",
            "signature": "ey4uLn0",
            "signatures": [
              {
                "header": {
                  "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                },
                "protected": "ey4uLn0",
                "signature": "ey4uLn0"
              }
            ]
          },
          "links": [
            "https://link.to/data"
          ],
          "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
        },
        "description": "view from doorway, facing east, with lights off",
        "filename": "IMG1092348.png",
        "lastmod_time": "2021-12-31T23:59:59Z",
        "mime-type": "image/png"
      }
    ],
    "will_confirm": true
  },
  "role": "prover",
  "state": "proposal-sent",
  "thread_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "trace": true,
  "updated_at": "2021-12-31T23:59:59Z",
  "verified": "true",
  "verified_msgs": [
    "text"
  ]
}

Sample Request Body

The request body will depend on the credential, but here is a sample.

{
  "connection_id": "<verifier-to-holder-conn-id>",
  "auto_verify": false,
  "auto_remove": false,
  "comment": "Presentation request from Issuer",
  "presentation_request": {
    "anoncreds": {
        "name": "proof",
        "version": "1.0",
        "requested_predicates": {
            "additionalProp1": {
                "name": "score",
                "p_value": 40,
                "p_type": ">",
                "restrictions": [{"cred_def_id": "<cred-def-id>"}]
            }
        },
        "requested_attributes": {},
        "non_revoked": {"to": <some-time-in-future>}
    }
  },
  "trace": false
}

Step 3: Holder sends Presentation Proof

Holder can get the stored credentials from own wallet and format a proof to send to the Verifier.

Sends a proof presentation

POST/present-proof-2.0/records/{pres_ex_id}/send-presentation

Path parameters

pres_ex_id*string

Presentation exchange identifier

Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

Body

application/json

anoncredsall of

Presentation specification for anoncreds

auto_removeboolean

Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)

difall of

Optional Presentation specification for DIF, overrides the PresentationExchange record's PresRequest

indyall of

Presentation specification for indy

traceboolean

Record trace information, based on agent configuration

Response

200

Body

application/json

auto_presentboolean

Prover choice to auto-present proof as verifier requests

Example: false

auto_removeboolean

Verifier choice to remove this presentation exchange record when complete

Example: false

auto_verifyboolean

Verifier choice to auto-verify proof presentation

by_formatall of

Attachment content by format for proposal, request, and presentation

connection_idstring

Connection identifier

Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

created_atstring

Time of record creation

Example: "2021-12-31T23:59:59Z"

Pattern: ^\d{4}-\d\d-\d\d[T ]\d\d:\d\d(?:\:(?:\d\d(?:\.\d{1,6})?))?(?:[+-]\d\d:?\d\d|Z|)$

error_msgstring

Error message

Example: "Invalid structure"

initiatorenum

Present-proof exchange initiator: self or external

Example: "self"

selfexternal

presall of

Presentation message

pres_ex_idstring

Presentation exchange identifier

Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

pres_proposalall of

Presentation proposal message

pres_requestall of

Presentation request message

roleenum

Present-proof exchange role: prover or verifier

Example: "prover"

proververifier

stateenum

Present-proof exchange state

proposal-sentproposal-receivedrequest-sentrequest-receivedpresentation-sentpresentation-receiveddoneabandoneddeleted

thread_idstring

Thread identifier

Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

traceboolean

Record trace information, based on agent configuration

updated_atstring

Time of last record update

Example: "2021-12-31T23:59:59Z"

Pattern: ^\d{4}-\d\d-\d\d[T ]\d\d:\d\d(?:\:(?:\d\d(?:\.\d{1,6})?))?(?:[+-]\d\d:?\d\d|Z|)$

verifiedenum

Whether presentation is verified: 'true' or 'false'

Example: "true"

truefalse

verified_msgsarray of string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/present-proof-2.0/records/{pres_ex_id}/send-presentation', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "anoncreds": {
        "requested_attributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "cred_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
          }
        },
        "requested_predicates": {
          "ANY_ADDITIONAL_PROPERTY": {
            "cred_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "timestamp": 1640995199
          }
        },
        "self_attested_attributes": {
          "ANY_ADDITIONAL_PROPERTY": "self_attested_value"
        },
        "trace": false
      },
      "dif": {
        "presentation_definition": {
          "format": {
            "di_vc": {},
            "jwt": {},
            "jwt_vc": {},
            "jwt_vp": {},
            "ldp": {},
            "ldp_vc": {},
            "ldp_vp": {}
          },
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "input_descriptors": [
            {
              "constraints": {
                "fields": [
                  {
                    "filter": {
                      "enum": [],
                      "maxLength": 1234,
                      "minLength": 1234,
                      "not": false
                    },
                    "path": [
                      null
                    ],
                    "predicate": "required"
                  }
                ],
                "is_holder": [
                  {
                    "directive": "required",
                    "field_id": [
                      "3fa85f64-5717-4562-b3fc-2c963f66afa6"
                    ]
                  }
                ],
                "status_active": "required",
                "status_revoked": "required",
                "status_suspended": "required",
                "subject_is_issuer": "required"
              },
              "group": [
                null
              ],
              "metadata": {},
              "schema": {
                "oneof_filter": [
                  [
                    {
                      "uri": "https://www.w3.org/Test1#Test1"
                    },
                    {
                      "uri": "https://www.w3.org/Test2#Test2"
                    }
                  ],
                  {
                    "oneof_filter": [
                      [
                        {
                          "uri": "https://www.w3.org/Test1#Test1"
                        }
                      ],
                      [
                        {
                          "uri": "https://www.w3.org/Test2#Test2"
                        }
                      ]
                    ]
                  }
                ]
              }
            }
          ],
          "submission_requirements": [
            {
              "count": 1234,
              "from_nested": "[Circular Reference]",
              "max": 1234,
              "min": 1234,
              "rule": "all"
            }
          ]
        },
        "record_ids": {
          "<input descriptor id_1>": [
            "<record id_1>",
            "<record id_2>"
          ],
          "<input descriptor id_2>": [
            "<record id>"
          ]
        },
        "reveal_doc": {
          "@context": [
            "https://www.w3.org/2018/credentials/v1",
            "https://w3id.org/security/bbs/v1"
          ],
          "@explicit": true,
          "@requireAll": true,
          "credentialSubject": {
            "@explicit": true,
            "@requireAll": true,
            "Observation": [
              {
                "effectiveDateTime": {},
                "@explicit": true,
                "@requireAll": true
              }
            ]
          },
          "issuanceDate": {},
          "issuer": {},
          "type": [
            "VerifiableCredential",
            "LabReport"
          ]
        }
      },
      "indy": {
        "requested_attributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "cred_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
          }
        },
        "requested_predicates": {
          "ANY_ADDITIONAL_PROPERTY": {
            "cred_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "timestamp": 1640995199
          }
        },
        "self_attested_attributes": {
          "ANY_ADDITIONAL_PROPERTY": "self_attested_value"
        },
        "trace": false
      }
    }),
});
const data = await response.json();

Response

200

{
  "auto_present": false,
  "auto_remove": false,
  "auto_verify": true,
  "by_format": {
    "pres": {},
    "pres_proposal": {},
    "pres_request": {}
  },
  "connection_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_at": "2021-12-31T23:59:59Z",
  "error_msg": "Invalid structure",
  "initiator": "self",
  "pres": {
    "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "@type": "https://didcomm.org/my-family/1.0/my-message-type",
    "comment": "text",
    "formats": [
      {
        "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "format": "dif/presentation-exchange/submission@v1.0"
      }
    ],
    "presentations~attach": [
      {
        "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "byte_count": 1234,
        "data": {
          "base64": "ey4uLn0=",
          "json": "{\"sample\": \"content\"}",
          "jws": {
            "header": {
              "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
            },
            "protected": "ey4uLn0",
            "signature": "ey4uLn0",
            "signatures": [
              {
                "header": {
                  "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                },
                "protected": "ey4uLn0",
                "signature": "ey4uLn0"
              }
            ]
          },
          "links": [
            "https://link.to/data"
          ],
          "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
        },
        "description": "view from doorway, facing east, with lights off",
        "filename": "IMG1092348.png",
        "lastmod_time": "2021-12-31T23:59:59Z",
        "mime-type": "image/png"
      }
    ]
  },
  "pres_ex_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "pres_proposal": {
    "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "@type": "https://didcomm.org/my-family/1.0/my-message-type",
    "comment": "text",
    "formats": [
      {
        "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "format": "dif/presentation-exchange/submission@v1.0"
      }
    ],
    "proposals~attach": [
      {
        "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "byte_count": 1234,
        "data": {
          "base64": "ey4uLn0=",
          "json": "{\"sample\": \"content\"}",
          "jws": {
            "header": {
              "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
            },
            "protected": "ey4uLn0",
            "signature": "ey4uLn0",
            "signatures": [
              {
                "header": {
                  "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                },
                "protected": "ey4uLn0",
                "signature": "ey4uLn0"
              }
            ]
          },
          "links": [
            "https://link.to/data"
          ],
          "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
        },
        "description": "view from doorway, facing east, with lights off",
        "filename": "IMG1092348.png",
        "lastmod_time": "2021-12-31T23:59:59Z",
        "mime-type": "image/png"
      }
    ]
  },
  "pres_request": {
    "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "@type": "https://didcomm.org/my-family/1.0/my-message-type",
    "comment": "text",
    "formats": [
      {
        "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "format": "dif/presentation-exchange/submission@v1.0"
      }
    ],
    "request_presentations~attach": [
      {
        "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "byte_count": 1234,
        "data": {
          "base64": "ey4uLn0=",
          "json": "{\"sample\": \"content\"}",
          "jws": {
            "header": {
              "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
            },
            "protected": "ey4uLn0",
            "signature": "ey4uLn0",
            "signatures": [
              {
                "header": {
                  "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                },
                "protected": "ey4uLn0",
                "signature": "ey4uLn0"
              }
            ]
          },
          "links": [
            "https://link.to/data"
          ],
          "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
        },
        "description": "view from doorway, facing east, with lights off",
        "filename": "IMG1092348.png",
        "lastmod_time": "2021-12-31T23:59:59Z",
        "mime-type": "image/png"
      }
    ],
    "will_confirm": true
  },
  "role": "prover",
  "state": "proposal-sent",
  "thread_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "trace": true,
  "updated_at": "2021-12-31T23:59:59Z",
  "verified": "true",
  "verified_msgs": [
    "text"
  ]
}

Step 4: Verifier verifies Presentation

Verifier receives the presentation via the connection, and can use the following API to verify. The response must have verified: true .

Verify a received presentation

POST/present-proof-2.0/records/{pres_ex_id}/verify-presentation

Path parameters

pres_ex_id*string

Presentation exchange identifier

Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

Response

200

Body

application/json

auto_presentboolean

Prover choice to auto-present proof as verifier requests

Example: false

auto_removeboolean

Verifier choice to remove this presentation exchange record when complete

Example: false

auto_verifyboolean

Verifier choice to auto-verify proof presentation

by_formatall of

Attachment content by format for proposal, request, and presentation

connection_idstring

Connection identifier

Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

created_atstring

Time of record creation

Example: "2021-12-31T23:59:59Z"

Pattern: ^\d{4}-\d\d-\d\d[T ]\d\d:\d\d(?:\:(?:\d\d(?:\.\d{1,6})?))?(?:[+-]\d\d:?\d\d|Z|)$

error_msgstring

Error message

Example: "Invalid structure"

initiatorenum

Present-proof exchange initiator: self or external

Example: "self"

selfexternal

presall of

Presentation message

pres_ex_idstring

Presentation exchange identifier

Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

pres_proposalall of

Presentation proposal message

pres_requestall of

Presentation request message

roleenum

Present-proof exchange role: prover or verifier

Example: "prover"

proververifier

stateenum

Present-proof exchange state

proposal-sentproposal-receivedrequest-sentrequest-receivedpresentation-sentpresentation-receiveddoneabandoneddeleted

thread_idstring

Thread identifier

Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

traceboolean

Record trace information, based on agent configuration

updated_atstring

Time of last record update

Example: "2021-12-31T23:59:59Z"

Pattern: ^\d{4}-\d\d-\d\d[T ]\d\d:\d\d(?:\:(?:\d\d(?:\.\d{1,6})?))?(?:[+-]\d\d:?\d\d|Z|)$

verifiedenum

Whether presentation is verified: 'true' or 'false'

Example: "true"

truefalse

verified_msgsarray of string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/present-proof-2.0/records/{pres_ex_id}/verify-presentation', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200

{
  "auto_present": false,
  "auto_remove": false,
  "auto_verify": true,
  "by_format": {
    "pres": {},
    "pres_proposal": {},
    "pres_request": {}
  },
  "connection_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_at": "2021-12-31T23:59:59Z",
  "error_msg": "Invalid structure",
  "initiator": "self",
  "pres": {
    "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "@type": "https://didcomm.org/my-family/1.0/my-message-type",
    "comment": "text",
    "formats": [
      {
        "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "format": "dif/presentation-exchange/submission@v1.0"
      }
    ],
    "presentations~attach": [
      {
        "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "byte_count": 1234,
        "data": {
          "base64": "ey4uLn0=",
          "json": "{\"sample\": \"content\"}",
          "jws": {
            "header": {
              "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
            },
            "protected": "ey4uLn0",
            "signature": "ey4uLn0",
            "signatures": [
              {
                "header": {
                  "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                },
                "protected": "ey4uLn0",
                "signature": "ey4uLn0"
              }
            ]
          },
          "links": [
            "https://link.to/data"
          ],
          "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
        },
        "description": "view from doorway, facing east, with lights off",
        "filename": "IMG1092348.png",
        "lastmod_time": "2021-12-31T23:59:59Z",
        "mime-type": "image/png"
      }
    ]
  },
  "pres_ex_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "pres_proposal": {
    "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "@type": "https://didcomm.org/my-family/1.0/my-message-type",
    "comment": "text",
    "formats": [
      {
        "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "format": "dif/presentation-exchange/submission@v1.0"
      }
    ],
    "proposals~attach": [
      {
        "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "byte_count": 1234,
        "data": {
          "base64": "ey4uLn0=",
          "json": "{\"sample\": \"content\"}",
          "jws": {
            "header": {
              "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
            },
            "protected": "ey4uLn0",
            "signature": "ey4uLn0",
            "signatures": [
              {
                "header": {
                  "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                },
                "protected": "ey4uLn0",
                "signature": "ey4uLn0"
              }
            ]
          },
          "links": [
            "https://link.to/data"
          ],
          "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
        },
        "description": "view from doorway, facing east, with lights off",
        "filename": "IMG1092348.png",
        "lastmod_time": "2021-12-31T23:59:59Z",
        "mime-type": "image/png"
      }
    ]
  },
  "pres_request": {
    "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "@type": "https://didcomm.org/my-family/1.0/my-message-type",
    "comment": "text",
    "formats": [
      {
        "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "format": "dif/presentation-exchange/submission@v1.0"
      }
    ],
    "request_presentations~attach": [
      {
        "@id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "byte_count": 1234,
        "data": {
          "base64": "ey4uLn0=",
          "json": "{\"sample\": \"content\"}",
          "jws": {
            "header": {
              "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
            },
            "protected": "ey4uLn0",
            "signature": "ey4uLn0",
            "signatures": [
              {
                "header": {
                  "kid": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4"
                },
                "protected": "ey4uLn0",
                "signature": "ey4uLn0"
              }
            ]
          },
          "links": [
            "https://link.to/data"
          ],
          "sha256": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb"
        },
        "description": "view from doorway, facing east, with lights off",
        "filename": "IMG1092348.png",
        "lastmod_time": "2021-12-31T23:59:59Z",
        "mime-type": "image/png"
      }
    ],
    "will_confirm": true
  },
  "role": "prover",
  "state": "proposal-sent",
  "thread_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "trace": true,
  "updated_at": "2021-12-31T23:59:59Z",
  "verified": "true",
  "verified_msgs": [
    "text"
  ]
}