Proof templates

To verify a credential verifier will need to create a proof template and generate a proof request to which the holder wallet will provide the verifiable presentation. Verifiable presentations can not be done via the API, the credential SDK is needed to create a presentation.

When working with proof requests you will often want to request the same information from holders. To make this easier you can create proof request templates to define the contents of the proof requests to be re-used.

Create a proof template

Create a new proof template

post

Create a proof template

Authorizations

bearerAuthaccessTokennextAuth

Body

namestringrequired

Proof request name

Example: Proof request

requestobjectoptional

The actual details of the proof request.

expirationTimeobjectoptional

Expiration time as interval object

Example: {"amount":1,"unit":"months"}

didstring · min: 32optional

A DID

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

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api-testnet.truvera.io/proof-templates' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Proof request",
    "request": {
      "name": "test request",
      "purpose": "my purpose",
      "input_descriptors": null
    },
    "expirationTime": {
      "amount": 1,
      "unit": "months"
    },
    "did": "did:cheqd:testnet:ac2b9027-ec1a-4ee2-aad1-1e316e7d6f59"
  }'

200

400

402

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "totalRequests": 1,
  "isOwner": true,
  "created": "2025-04-03T04:48:51.070Z",
  "updated": "2025-04-03T04:48:51.070Z",
  "did": "did:cheqd:testnet:ac2b9027-ec1a-4ee2-aad1-1e316e7d6f59",
  "request": {
    "name": "test request",
    "purpose": "my purpose",
    "input_descriptors": null
  },
  "types": [
    "jsonld"
  ]
}

Proof request template created

Get proof templates

List all proof templates

get

Authorizations

bearerAuthaccessTokennextAuth

Query parameters

offsetinteger · int32 · default: 0optional

How many items to offset by for pagination

limitinteger · int32 · min: 1 · max: 64 · default: 64optional

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api-testnet.truvera.io/proof-templates' \
  --header 'Authorization: Bearer JWT'

200

400

200

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "totalRequests": 1,
    "isOwner": true,
    "created": "2025-04-03T04:48:51.070Z",
    "updated": "2025-04-03T04:48:51.070Z",
    "did": "did:cheqd:testnet:ac2b9027-ec1a-4ee2-aad1-1e316e7d6f59",
    "request": {
      "name": "test request",
      "purpose": "my purpose",
      "input_descriptors": null
    },
    "types": [
      "jsonld"
    ]
  }
]

A paged array of proof templates

Get details of a specific proof template

Get proof templates

get

Get the details of an existing proof templates

Authorizations

bearerAuthaccessTokennextAuth

Path parameters

idstring · uuidrequired

Proof template UUID

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api-testnet.truvera.io/proof-templates/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

404

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "totalRequests": 1,
  "isOwner": true,
  "created": "2025-04-03T04:48:51.070Z",
  "updated": "2025-04-03T04:48:51.070Z",
  "did": "did:cheqd:testnet:ac2b9027-ec1a-4ee2-aad1-1e316e7d6f59",
  "request": {
    "name": "test request",
    "purpose": "my purpose",
    "input_descriptors": null
  },
  "types": [
    "jsonld"
  ]
}

Returns the information about the proof templates

Update a proof template

Update a proof template

patch

Authorizations

bearerAuthaccessTokennextAuth

Path parameters

idstring · uuidrequired

Proof template UUID

Body

namestringrequired

Proof request name

Example: Proof request

requestobjectoptional

The actual details of the proof request.

expirationTimeobjectoptional

Expiration time as interval object

Example: {"amount":1,"unit":"months"}

didstring · min: 32optional

A DID

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

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api-testnet.truvera.io/proof-templates/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Proof request",
    "request": {
      "name": "test request",
      "purpose": "my purpose",
      "input_descriptors": null
    },
    "expirationTime": {
      "amount": 1,
      "unit": "months"
    },
    "did": "did:cheqd:testnet:ac2b9027-ec1a-4ee2-aad1-1e316e7d6f59"
  }'

200

400

401

402

404

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "totalRequests": 1,
  "isOwner": true,
  "created": "2025-04-03T04:48:51.070Z",
  "updated": "2025-04-03T04:48:51.070Z",
  "did": "did:cheqd:testnet:ac2b9027-ec1a-4ee2-aad1-1e316e7d6f59",
  "request": {
    "name": "test request",
    "purpose": "my purpose",
    "input_descriptors": null
  },
  "types": [
    "jsonld"
  ]
}

Profile has been updated

Get proof requests from template

Use the Verified parameter when needing to get only those verifications that were succsessful.

Gets the proof requests from this template

get

Authorizations

bearerAuthaccessTokennextAuth

Path parameters

idstring · uuidrequired

Proof template UUID

Query parameters

verifiedbooleanoptional

Whether the presentation was verified or not

offsetinteger · int32 · default: 0optional

How many items to offset by for pagination

limitinteger · int32 · min: 1 · max: 64 · default: 64optional

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

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api-testnet.truvera.io/proof-templates/{id}/history' \
  --header 'Authorization: Bearer JWT'

200

400

404

200

[
  {
    "id": "37275574-7ea4-438d-b8ef-f8fc61dbf09e",
    "attributes": {
      "ANY_ADDITIONAL_PROPERTY": {
        "name": "favouriteDrink",
        "names": [
          "age"
        ]
      }
    },
    "name": "Proof request",
    "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"
    ],
    "credentialsIssuers": [
      {
        "issuerDid": "text",
        "issuerName": "text",
        "issuerLogo": "text",
        "issuerTrustRegistries": [
          {
            "name": "text",
            "logoUrl": "text"
          }
        ]
      }
    ]
  }
]

Returns the information about the proof request history

Delete a proof template

Delete proof templates

delete

Deletes the proof templates and associated data

Authorizations

bearerAuthaccessTokennextAuth

Path parameters

idstring · uuidrequired

Proof template UUID

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api-testnet.truvera.io/proof-templates/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

404

200

No body

Proof templates will be deleted

Delete history for proof template

This endpoint provides an irreversible deletion of all of proof template's verification history data.

Deletes all the history for this proof template

delete

Deletes all the history for this proof template

Authorizations

bearerAuthaccessTokennextAuth

Path parameters

idstring · uuidrequired

Proof template UUID

Query parameters

verifiedbooleanoptional

Whether the presentation was verified or not

offsetinteger · int32 · default: 0optional

How many items to offset by for pagination

limitinteger · int32 · min: 1 · max: 64 · default: 64optional

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api-testnet.truvera.io/proof-templates/{id}/history' \
  --header 'Authorization: Bearer JWT'

200

400

404

200

No body

Proof requests have been deleted

Delete a proof template

Delete proof templates

delete

Deletes the proof templates and associated data

Authorizations

bearerAuthaccessTokennextAuth

Path parameters

idstring · uuidrequired

Proof template UUID

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api-testnet.truvera.io/proof-templates/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

404

200

No body

Proof templates will be deleted