Present a Verifiable Credential

Present a JSON-LD Verifiable Credential, signed by a did:cheqd Decentralized Identifier (DID), using ACA-Py.

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

Body

application/json

auto_removebooleanOptional

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

auto_verifybooleanOptional

Verifier choice to auto-verify proof presentation

commentstringOptional

connection_idstringRequired

Connection identifier

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

tracebooleanOptional

Whether to trace event (default false)

Responses

200Success

application/json

auto_presentbooleanOptional

Prover choice to auto-present proof as verifier requests

auto_removebooleanOptional

Verifier choice to remove this presentation exchange record when complete

auto_verifybooleanOptional

Verifier choice to auto-verify proof presentation

connection_idstringOptional

Connection identifier

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

created_atstringOptional

Time of record creation

Example: 2021-12-31T23:59:59ZPattern: ^\d{4}-\d\d-\d\d[T ]\d\d:\d\d(?:\:(?:\d\d(?:\.\d{1,6})?))?(?:[+-]\d\d:?\d\d|Z|)$

error_msgstringOptional

Error message

Example: Invalid structure

initiatorstring · enumOptional

Present-proof exchange initiator: self or external

Example: selfPossible values:

pres_ex_idstringOptional

Presentation exchange identifier

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

rolestring · enumOptional

Present-proof exchange role: prover or verifier

Example: proverPossible values:

statestring · enumOptional

Present-proof exchange state

Possible values:

thread_idstringOptional

Thread identifier

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

tracebooleanOptional

Record trace information, based on agent configuration

updated_atstringOptional

Time of last record update

Example: 2021-12-31T23:59:59ZPattern: ^\d{4}-\d\d-\d\d[T ]\d\d:\d\d(?:\:(?:\d\d(?:\.\d{1,6})?))?(?:[+-]\d\d:?\d\d|Z|)$

verifiedstring · enumOptional

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

Example: truePossible values:

verified_msgsstring[]Optional

Proof verification warning or error information

post

/present-proof-2.0/send-request

HTTPcURLJavaScriptPython

POST /present-proof-2.0/send-request HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2482

{
  "auto_remove": true,
  "auto_verify": false,
  "comment": "text",
  "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": {
                    "const": null,
                    "enum": [],
                    "exclusiveMaximum": null,
                    "exclusiveMinimum": null,
                    "format": "text",
                    "maxLength": 1234,
                    "maximum": null,
                    "minLength": 1234,
                    "minimum": null,
                    "not": false,
                    "pattern": "text",
                    "type": "text"
                  },
                  "id": "text",
                  "path": [
                    "text"
                  ],
                  "predicate": "required",
                  "purpose": "text"
                }
              ],
              "is_holder": [
                {
                  "directive": "required",
                  "field_id": [
                    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
                  ]
                }
              ],
              "limit_disclosure": "text",
              "status_active": "required",
              "status_revoked": "required",
              "status_suspended": "required",
              "subject_is_issuer": "required"
            },
            "group": [
              "text"
            ],
            "id": "text",
            "metadata": {},
            "name": "text",
            "purpose": "text",
            "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"
                      }
                    ]
                  ]
                }
              ]
            }
          }
        ],
        "name": "text",
        "purpose": "text",
        "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
}

200Success

{
  "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/[email protected]"
      }
    ],
    "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/[email protected]"
      }
    ],
    "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/[email protected]"
      }
    ],
    "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; for our citizenship credential, this is a sample.

{
    "auto_verify": false,
    "connection_id": "{{issuer-conn-id}}",
    "comment": "Proof request for json-ld credential.",
    "presentation_request": {
        "dif": {
            "options": {
                "challenge": "{{$randomUUID}}",
                "domain": "test-citizenship"
            },
            "presentation_definition": {
                "id": "{{$randomUUID}}",
                "format": {
                    "ldp_vp": {
                        "proof_type": [
                            "Ed25519Signature2020"
                        ]
                    }
                },
                "input_descriptors": [
                    {
                        "id": "citizenship_input_1",
                        "name": "EU Driver's License",
                        "schema": [
                            {
                                "uri": "https://www.w3.org/2018/credentials#VerifiableCredential"
                            },
                            {
                                "uri": "https://w3id.org/citizenship#PermanentResident"
                            }
                        ],
                        "constraints": {
                            "fields": [
                                {
                                    "path": [
                                        "$.credentialSubject.familyName"
                                    ],
                                    "purpose": "The claim must be from one of the specified issuers",
                                    "filter": {
                                        "const": "SMITH"
                                    }
                                },
                                {
                                    "path": [
                                        "$.credentialSubject.givenName"
                                    ],
                                    "filter": {
                                        "const": "ALICE"
                                    },
                                    "purpose": "The claim must be from one of the specified issuers"
                                }
                            ]
                        }
                    }
                ]
            }
        }
    }
}

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

Path parameters

pres_ex_idanyRequired

Presentation exchange identifier

Example: {"value":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}

Body

application/json

auto_removebooleanOptional

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

tracebooleanOptional

Record trace information, based on agent configuration

Responses

200Success

application/json

auto_presentbooleanOptional

Prover choice to auto-present proof as verifier requests

auto_removebooleanOptional

Verifier choice to remove this presentation exchange record when complete

auto_verifybooleanOptional

Verifier choice to auto-verify proof presentation

connection_idstringOptional

Connection identifier

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

created_atstringOptional

Time of record creation

Example: 2021-12-31T23:59:59ZPattern: ^\d{4}-\d\d-\d\d[T ]\d\d:\d\d(?:\:(?:\d\d(?:\.\d{1,6})?))?(?:[+-]\d\d:?\d\d|Z|)$

error_msgstringOptional

Error message

Example: Invalid structure

initiatorstring · enumOptional

Present-proof exchange initiator: self or external

Example: selfPossible values:

pres_ex_idstringOptional

Presentation exchange identifier

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

rolestring · enumOptional

Present-proof exchange role: prover or verifier

Example: proverPossible values:

statestring · enumOptional

Present-proof exchange state

Possible values:

thread_idstringOptional

Thread identifier

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

tracebooleanOptional

Record trace information, based on agent configuration

updated_atstringOptional

Time of last record update

Example: 2021-12-31T23:59:59ZPattern: ^\d{4}-\d\d-\d\d[T ]\d\d:\d\d(?:\:(?:\d\d(?:\.\d{1,6})?))?(?:[+-]\d\d:?\d\d|Z|)$

verifiedstring · enumOptional

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

Example: truePossible values:

verified_msgsstring[]Optional

Proof verification warning or error information

post

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

HTTPcURLJavaScriptPython

POST /present-proof-2.0/records/{pres_ex_id}/send-presentation HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2418

{
  "anoncreds": {
    "requested_attributes": {
      "ANY_ADDITIONAL_PROPERTY": {
        "cred_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "revealed": true
      }
    },
    "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
  },
  "auto_remove": true,
  "dif": {
    "issuer_id": "text",
    "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": {
                  "const": null,
                  "enum": [],
                  "exclusiveMaximum": null,
                  "exclusiveMinimum": null,
                  "format": "text",
                  "maxLength": 1234,
                  "maximum": null,
                  "minLength": 1234,
                  "minimum": null,
                  "not": false,
                  "pattern": "text",
                  "type": "text"
                },
                "id": "text",
                "path": [
                  "text"
                ],
                "predicate": "required",
                "purpose": "text"
              }
            ],
            "is_holder": [
              {
                "directive": "required",
                "field_id": [
                  "3fa85f64-5717-4562-b3fc-2c963f66afa6"
                ]
              }
            ],
            "limit_disclosure": "text",
            "status_active": "required",
            "status_revoked": "required",
            "status_suspended": "required",
            "subject_is_issuer": "required"
          },
          "group": [
            "text"
          ],
          "id": "text",
          "metadata": {},
          "name": "text",
          "purpose": "text",
          "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"
                    }
                  ]
                ]
              }
            ]
          }
        }
      ],
      "name": "text",
      "purpose": "text",
      "submission_requirements": [
        {
          "count": 1234,
          "from": "text",
          "from_nested": "[Circular Reference]",
          "max": 1234,
          "min": 1234,
          "name": "text",
          "purpose": "text",
          "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",
        "revealed": true
      }
    },
    "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
  },
  "trace": true
}

200Success

{
  "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/[email protected]"
      }
    ],
    "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/[email protected]"
      }
    ],
    "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/[email protected]"
      }
    ],
    "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"
  ]
}

Request Body

For our citizenship credential example, the following is a sample request body.

{
    "dif": {
        "issuer_id": "{{issuer-did}}",
        "presentation_definition": {
            "id": "6d55f3ac-1dae-4306-a4bf-cf4fb93138b7",
            "format": {
                "ldp_vp": {
                    "proof_type": [
                        "Ed25519Signature2020"
                    ]
                }
            },
            "input_descriptors": [
                {
                    "id": "citizenship_input_1",
                    "name": "EU Driver's License",
                    "schema": [
                        {
                            "uri": "https://www.w3.org/2018/credentials#VerifiableCredential"
                        },
                        {
                            "uri": "https://w3id.org/citizenship#PermanentResident"
                        }
                    ],
                    "constraints": {
                        "fields": [
                            {
                                "path": [
                                    "$.credentialSubject.familyName"
                                ],
                                "purpose": "The claim must be from one of the specified issuers",
                                "filter": {
                                    "const": "SMITH"
                                }
                            },
                            {
                                "path": [
                                    "$.credentialSubject.givenName"
                                ],
                                "filter": {
                                    "const": "ALICE"
                                },
                                "purpose": "The claim must be from one of the specified issuers"
                            }
                        ]
                    }
                }
            ]
        }
    }
}

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

Path parameters

pres_ex_idanyRequired

Presentation exchange identifier

Example: {"value":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}

Responses

200Success

application/json

auto_presentbooleanOptional

Prover choice to auto-present proof as verifier requests

auto_removebooleanOptional

Verifier choice to remove this presentation exchange record when complete

auto_verifybooleanOptional

Verifier choice to auto-verify proof presentation

connection_idstringOptional

Connection identifier

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

created_atstringOptional

Time of record creation

Example: 2021-12-31T23:59:59ZPattern: ^\d{4}-\d\d-\d\d[T ]\d\d:\d\d(?:\:(?:\d\d(?:\.\d{1,6})?))?(?:[+-]\d\d:?\d\d|Z|)$

error_msgstringOptional

Error message

Example: Invalid structure

initiatorstring · enumOptional

Present-proof exchange initiator: self or external

Example: selfPossible values:

pres_ex_idstringOptional

Presentation exchange identifier

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

rolestring · enumOptional

Present-proof exchange role: prover or verifier

Example: proverPossible values:

statestring · enumOptional

Present-proof exchange state

Possible values:

thread_idstringOptional

Thread identifier

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

tracebooleanOptional

Record trace information, based on agent configuration

updated_atstringOptional

Time of last record update

Example: 2021-12-31T23:59:59ZPattern: ^\d{4}-\d\d-\d\d[T ]\d\d:\d\d(?:\:(?:\d\d(?:\.\d{1,6})?))?(?:[+-]\d\d:?\d\d|Z|)$

verifiedstring · enumOptional

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

Example: truePossible values:

verified_msgsstring[]Optional

Proof verification warning or error information

post

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

HTTPcURLJavaScriptPython

POST /present-proof-2.0/records/{pres_ex_id}/verify-presentation HTTP/1.1
Accept: */*

200Success

{
  "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/[email protected]"
      }
    ],
    "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/[email protected]"
      }
    ],
    "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/[email protected]"
      }
    ],
    "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"
  ]
}