Proof requests

Proof templates are used to create proof requests. When a proof request is created, you will receive a URL which needs to be delivered to a holder's wallet application either as a link (in the "response_url" field) or displayed in a QR code for the wallet application to scan (conveniently pre-generated for you in the "qr" field). The holder's wallet will then generate a proof response and deliver it to the Truvera API which will check it for cryptographic correctness. Like other asynchronous operations, you can receive the verification response along with the verified attributes either by polling or via a webhook.

To get a response by polling, check the proof-request details for when the "verified" attribute equals "true". At that point, the "presentation" field will contain the verified attributes as a JSON list. If at any point the "verified" attribute equals "false", the response can be checked to determine the cause of the failure and appropriate next steps.

When creating a proof request, you can optionally provide a verifier DID in order for the holder to know that your verifier is on their trust-list, such as in an ecosystem of trust.

Create proof request

This route uses a template ID and takes the PEX request you defined there.

Creates proof request

post

https://api-testnet.truvera.iohttps://api.truvera.io

/proof-templates/{id}/request

Creates a proof request from this template

Authorizations

bearerAuthaccessTokennextAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

Proof template UUID

Body

application/json

noncestringOptional

A unique nonce value used in the proof request.

Example: 123456

didstring · min: 32Optional

The DID that will be used as the verifier DID in the proof request

Example: did:cheqd:testnet:ac2b9027-ec1a-4ee2-aad1-1e316e7d6f59

Responses

200

Returns the information about the proof request

application/json

400

Application error

application/json

402

Transaction limit reached or upgrade required to proceed

application/json

404

Proof template was not found.

application/json

post

/proof-templates/{id}/request

HTTPcURLJavaScriptPython

POST /proof-templates/{id}/request HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "nonce": "123456",
  "did": "did:cheqd:testnet:ac2b9027-ec1a-4ee2-aad1-1e316e7d6f59"
}

{
  "id": "37275574-7ea4-438d-b8ef-f8fc61dbf09e",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {
      "name": "favouriteDrink",
      "names": [
        "age"
      ]
    }
  },
  "name": "Proof request",
  "cedarVerificationPolicy": "text",
  "nonce": "1234567890",
  "error": "text",
  "response_url": "http://api-testnet.truvera.io/proof-requests/37275574-7ea4-438d-b8ef-f8fc61dbf09e/send-presentation",
  "qr": "http://creds-testnet.truvera.io/proof/37275574-7ea4-438d-b8ef-f8fc61dbf09e",
  "did": "did:cheqd:testnet:ac2b9027-ec1a-4ee2-aad1-1e316e7d6f59",
  "verified": false,
  "expired": false,
  "presentation": {},
  "created": "2024-09-26T12:38:10.871Z",
  "updated": "2024-09-26T12:38:10.871Z",
  "request": {
    "name": "test request",
    "purpose": "my purpose",
    "input_descriptors": null
  },
  "type": "proof-request",
  "types": [
    "jsonld"
  ],
  "verifierName": "Truvera",
  "verifierLogo": "https://logo.truvera.io/verifier"
}

Create proof request

This route lets you create a standalone proof request without storing a verification template first.

Create a new proof request

post

https://api-testnet.truvera.iohttps://api.truvera.io

/proof-requests

Create a proof request

Authorizations

bearerAuthaccessTokennextAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Represents a proof request payload in a verifiable credential system.

namestringRequired

Proof request name

Example: Proof request

cedarVerificationPolicystringOptional

Optional Cedar policy to run on verification

templatestring · uuidOptional

The unique identifier for the template.

Example: 37275574-7ea4-438d-b8ef-f8fc61dbf09e

noncestringOptional

Nonce or challenge for the presentation to match

Example: 1234567890

didstring · min: 32Optional

A DID

Example: did:cheqd:testnet:ac2b9027-ec1a-4ee2-aad1-1e316e7d6f59

Responses

200

Proof request created

application/json

400

Invalid parameters

application/json

402

Transaction limit reached or upgrade required to proceed

application/json

post

/proof-requests

HTTPcURLJavaScriptPython

POST /proof-requests HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 356

{
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {
      "name": "favouriteDrink",
      "names": [
        "age"
      ]
    }
  },
  "name": "Proof request",
  "cedarVerificationPolicy": "text",
  "template": "37275574-7ea4-438d-b8ef-f8fc61dbf09e",
  "nonce": "1234567890",
  "did": "did:cheqd:testnet:ac2b9027-ec1a-4ee2-aad1-1e316e7d6f59",
  "request": {
    "name": "test request",
    "purpose": "my purpose",
    "input_descriptors": null
  }
}

{
  "id": "37275574-7ea4-438d-b8ef-f8fc61dbf09e",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {
      "name": "favouriteDrink",
      "names": [
        "age"
      ]
    }
  },
  "name": "Proof request",
  "cedarVerificationPolicy": "text",
  "nonce": "1234567890",
  "error": "text",
  "response_url": "http://api-testnet.truvera.io/proof-requests/37275574-7ea4-438d-b8ef-f8fc61dbf09e/send-presentation",
  "qr": "http://creds-testnet.truvera.io/proof/37275574-7ea4-438d-b8ef-f8fc61dbf09e",
  "did": "did:cheqd:testnet:ac2b9027-ec1a-4ee2-aad1-1e316e7d6f59",
  "verified": false,
  "expired": false,
  "presentation": {},
  "created": "2024-09-26T12:38:10.871Z",
  "updated": "2024-09-26T12:38:10.871Z",
  "request": {
    "name": "test request",
    "purpose": "my purpose",
    "input_descriptors": null
  },
  "type": "proof-request",
  "types": [
    "jsonld"
  ],
  "verifierName": "Truvera",
  "verifierLogo": "https://logo.truvera.io/verifier"
}

Get all proof requests

List all proof requests

get

https://api-testnet.truvera.iohttps://api.truvera.io

/proof-requests

Authorizations

bearerAuthaccessTokennextAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

offsetinteger · int32Optional

How many items to offset by for pagination

Default: 0

limitinteger · int32 · min: 1 · max: 64Optional

How many items to return at one time (max 64)

Default: 64

Responses

200

A paged array of proof requests

application/json

idstring · uuidRequired

The unique identifier for the proof request.

Example: 37275574-7ea4-438d-b8ef-f8fc61dbf09e

namestringOptional

Proof request name

Example: Proof request

cedarVerificationPolicystringOptional

Optional Cedar policy to run on verification

noncestringOptional

Nonce or challenge for the presentation to match

Example: 1234567890

errorstringOptional

response_urlstring · uriRequired

The URL to send the proof presentation response.

Example: http://api-testnet.truvera.io/proof-requests/37275574-7ea4-438d-b8ef-f8fc61dbf09e/send-presentation

qrstringOptional

QR code deep link for mobile wallet scanning

Example: http://creds-testnet.truvera.io/proof/37275574-7ea4-438d-b8ef-f8fc61dbf09e

didstring · min: 32Optional

A DID

Example: did:cheqd:testnet:ac2b9027-ec1a-4ee2-aad1-1e316e7d6f59

verifiedbooleanOptional

Indicates whether the proof request has been verified.

Example: false

expiredbooleanOptional

Indicates whether the proof request has expired

Example: false

presentationobjectOptional

createdstring · date-timeRequired

The timestamp when the proof request was created.

Example: 2024-09-26T12:38:10.871Z

updatedstring · date-timeOptional

The timestamp when the proof request was last updated.

Example: 2024-09-26T12:38:10.871Z

typestringOptional

The type of the request.

Example: proof-request

typesstring[]Optional

An array of types indicating the formats or methods that can be used for the proof.

Example: jsonld

400

Application error

application/json

get

/proof-requests

HTTPcURLJavaScriptPython

GET /proof-requests HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "37275574-7ea4-438d-b8ef-f8fc61dbf09e",
    "attributes": {
      "ANY_ADDITIONAL_PROPERTY": {
        "name": "favouriteDrink",
        "names": [
          "age"
        ]
      }
    },
    "name": "Proof request",
    "cedarVerificationPolicy": "text",
    "nonce": "1234567890",
    "error": "text",
    "response_url": "http://api-testnet.truvera.io/proof-requests/37275574-7ea4-438d-b8ef-f8fc61dbf09e/send-presentation",
    "qr": "http://creds-testnet.truvera.io/proof/37275574-7ea4-438d-b8ef-f8fc61dbf09e",
    "did": "did:cheqd:testnet:ac2b9027-ec1a-4ee2-aad1-1e316e7d6f59",
    "verified": false,
    "expired": false,
    "presentation": {},
    "created": "2024-09-26T12:38:10.871Z",
    "updated": "2024-09-26T12:38:10.871Z",
    "request": {
      "name": "test request",
      "purpose": "my purpose",
      "input_descriptors": null
    },
    "type": "proof-request",
    "types": [
      "jsonld"
    ]
  }
]

Get the details of an existing proof request

Get proof request

get

https://api-testnet.truvera.iohttps://api.truvera.io

/proof-requests/{id}

Get the details of an existing proof request

Authorizations

bearerAuthaccessToken

Path parameters

idstring · uuidRequired

Proof request UUID

Responses

200

Returns the information about the proof request

application/json

400

Application error

application/json

404

Proof request was not found.

application/json

get

/proof-requests/{id}

HTTPcURLJavaScriptPython

GET /proof-requests/{id} HTTP/1.1
Host: api-testnet.truvera.io
Accept: */*

{
  "id": "37275574-7ea4-438d-b8ef-f8fc61dbf09e",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {
      "name": "favouriteDrink",
      "names": [
        "age"
      ]
    }
  },
  "name": "Proof request",
  "cedarVerificationPolicy": "text",
  "nonce": "1234567890",
  "error": "text",
  "response_url": "http://api-testnet.truvera.io/proof-requests/37275574-7ea4-438d-b8ef-f8fc61dbf09e/send-presentation",
  "qr": "http://creds-testnet.truvera.io/proof/37275574-7ea4-438d-b8ef-f8fc61dbf09e",
  "did": "did:cheqd:testnet:ac2b9027-ec1a-4ee2-aad1-1e316e7d6f59",
  "verified": false,
  "expired": false,
  "presentation": {},
  "created": "2024-09-26T12:38:10.871Z",
  "updated": "2024-09-26T12:38:10.871Z",
  "request": {
    "name": "test request",
    "purpose": "my purpose",
    "input_descriptors": null
  },
  "type": "proof-request",
  "types": [
    "jsonld"
  ],
  "verifierName": "Truvera",
  "verifierLogo": "https://logo.truvera.io/verifier"
}

Delete the proof request

Delete proof request

delete

https://api-testnet.truvera.iohttps://api.truvera.io

/proof-requests/{id}

Deletes the proof request and associated data

Authorizations

bearerAuthaccessTokennextAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

Proof request UUID

Responses

200

Proof request will be deleted

No content

400

Something went wrong.

application/json

404

Proof request was not found.

application/json

delete

/proof-requests/{id}

HTTPcURLJavaScriptPython

DELETE /proof-requests/{id} HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content