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

auto_removeboolean

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

commentstring

presentation_requestobjectrequired

auto_verifyboolean

Verifier choice to auto-verify proof presentation

connection_idstringrequired

Connection identifier

traceboolean

Whether to trace event (default false)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/present-proof-2.0/send-request' \
  --header 'Content-Type: application/json' \
  --data '{
    "auto_remove": true,
    "comment": "text",
    "presentation_request": {
      "anoncreds": {
        "non_revoked": {
          "from": 1640995199,
          "to": 1640995199
        },
        "name": "Proof request",
        "nonce": "1",
        "version": "1.0",
        "requested_attributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "non_revoked": {
              "from": 1640995199,
              "to": 1640995199
            },
            "name": "favouriteDrink",
            "names": [
              "age"
            ],
            "restrictions": [
              {
                "ANY_ADDITIONAL_PROPERTY": "did:(method):3:CL:20:tag"
              }
            ]
          }
        },
        "requested_predicates": {
          "ANY_ADDITIONAL_PROPERTY": {
            "non_revoked": {
              "from": 1640995199,
              "to": 1640995199
            },
            "p_value": 1,
            "name": "index",
            "p_type": ">=",
            "restrictions": [
              {
                "ANY_ADDITIONAL_PROPERTY": "did:(method):3:CL:20:tag"
              }
            ]
          }
        }
      },
      "dif": "[Circular Reference]",
      "indy": {
        "non_revoked": {
          "from": 1640995199,
          "to": 1640995199
        },
        "name": "Proof request",
        "nonce": "1",
        "version": "1.0",
        "requested_attributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "non_revoked": {
              "from": 1640995199,
              "to": 1640995199
            },
            "name": "favouriteDrink",
            "names": [
              "age"
            ],
            "restrictions": [
              {
                "ANY_ADDITIONAL_PROPERTY": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"
              }
            ]
          }
        },
        "requested_predicates": {
          "ANY_ADDITIONAL_PROPERTY": {
            "non_revoked": {
              "from": 1640995199,
              "to": 1640995199
            },
            "p_value": 1,
            "name": "index",
            "p_type": ">=",
            "restrictions": [
              {
                "ANY_ADDITIONAL_PROPERTY": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"
              }
            ]
          }
        }
      }
    },
    "auto_verify": false,
    "connection_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "trace": false
  }'

200

200

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

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_idanyrequired

Presentation exchange identifier

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

Body

auto_removeboolean

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

traceboolean

Record trace information, based on agent configuration

anoncredsall of

Presentation specification for anoncreds

difall of

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

indyall of

Presentation specification for indy

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/present-proof-2.0/records/{pres_ex_id}/send-presentation' \
  --header 'Content-Type: application/json' \
  --data '{
    "auto_remove": true,
    "trace": true,
    "anoncreds": {
      "trace": false,
      "requested_attributes": {
        "ANY_ADDITIONAL_PROPERTY": {
          "revealed": true,
          "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"
      }
    },
    "dif": {
      "issuer_id": "text",
      "presentation_definition": "[Circular Reference]",
      "record_ids": {
        "<input descriptor id_1>": [
          "<record id_1>",
          "<record id_2>"
        ],
        "<input descriptor id_2>": [
          "<record id>"
        ]
      },
      "reveal_doc": {
        "@explicit": true,
        "@requireAll": true,
        "@context": [
          "https://www.w3.org/2018/credentials/v1",
          "https://w3id.org/security/bbs/v1"
        ],
        "type": [
          "VerifiableCredential",
          "LabReport"
        ],
        "issuanceDate": {},
        "issuer": {},
        "credentialSubject": {
          "@explicit": true,
          "@requireAll": true,
          "Observation": [
            {
              "@explicit": true,
              "@requireAll": true,
              "effectiveDateTime": {}
            }
          ]
        }
      }
    },
    "indy": {
      "trace": false,
      "requested_attributes": {
        "ANY_ADDITIONAL_PROPERTY": {
          "revealed": true,
          "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"
      }
    }
  }'

200

200

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

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_idanyrequired

Presentation exchange identifier

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/present-proof-2.0/records/{pres_ex_id}/verify-presentation'

200

200

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