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

Create a proof template

POSThttps://api-testnet.truvera.io/proof-templates

Body

application/json

Proof template object

name*string

Proof request name

Example: "Proof request"

requestobject

The actual details of the proof request.

didDID (string)

DID as fully qualified, typically. did:dock:

Example: "did:dock:xyz"

Response

200400402

Proof request template created

Body

application/json

id*string (uuid)

The unique identifier for the proof template.

totalRequestsinteger

The total number of proof requests associated with the template.

Example: 1

isOwnerboolean

Whether the current user is the owner of the template

Example: true

created*string (date-time)

updated*string (date-time)

didDID (string)

DID as fully qualified, typically. did:dock:

Example: "did:dock:xyz"

requestobject

The actual details of the proof request.

typesarray of string

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

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/proof-templates', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "Proof request"
    }),
});
const data = await response.json();

Response

200400402

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "totalRequests": 1,
  "isOwner": true,
  "created": "2025-01-09T20:07:57.155Z",
  "updated": "2025-01-09T20:07:57.155Z",
  "did": "did:dock:xyz",
  "request": {
    "name": "test request",
    "purpose": "my purpose"
  },
  "types": [
    "jsonld"
  ]
}

Get proof templates

List all proof templates

GEThttps://api-testnet.truvera.io/proof-templates

Query parameters

Response

200400

A paged array of proof templates

Body

application/json

id*string (uuid)

The unique identifier for the proof template.

totalRequestsinteger

The total number of proof requests associated with the template.

Example: 1

isOwnerboolean

Whether the current user is the owner of the template

Example: true

created*string (date-time)

updated*string (date-time)

didDID (string)

DID as fully qualified, typically. did:dock:

Example: "did:dock:xyz"

requestobject

The actual details of the proof request.

typesarray of string

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

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/proof-templates', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "totalRequests": 1,
    "isOwner": true,
    "created": "2025-01-09T20:07:57.155Z",
    "updated": "2025-01-09T20:07:57.155Z",
    "did": "did:dock:xyz",
    "request": {
      "name": "test request",
      "purpose": "my purpose"
    },
    "types": [
      "jsonld"
    ]
  }
]

Get details of a specific proof template

Get proof templates

Get the details of an existing proof templates

GEThttps://api-testnet.truvera.io/proof-templates/{id}

Path parameters

id*string (uuid)

Proof template UUID

Response

200400404

Returns the information about the proof templates

Body

application/json

id*string (uuid)

The unique identifier for the proof template.

totalRequestsinteger

The total number of proof requests associated with the template.

Example: 1

isOwnerboolean

Whether the current user is the owner of the template

Example: true

created*string (date-time)

updated*string (date-time)

didDID (string)

DID as fully qualified, typically. did:dock:

Example: "did:dock:xyz"

requestobject

The actual details of the proof request.

typesarray of string

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

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/proof-templates/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "totalRequests": 1,
  "isOwner": true,
  "created": "2025-01-09T20:07:57.155Z",
  "updated": "2025-01-09T20:07:57.155Z",
  "did": "did:dock:xyz",
  "request": {
    "name": "test request",
    "purpose": "my purpose"
  },
  "types": [
    "jsonld"
  ]
}

Update a proof template

Update a proof template

PATCHhttps://api-testnet.truvera.io/proof-templates/{id}

Path parameters

id*string (uuid)

Proof template UUID

Body

application/json

Proof template object

name*string

Proof request name

Example: "Proof request"

requestobject

The actual details of the proof request.

didDID (string)

DID as fully qualified, typically. did:dock:

Example: "did:dock:xyz"

Response

200400401402404

Profile has been updated

Body

application/json

id*string (uuid)

The unique identifier for the proof template.

totalRequestsinteger

The total number of proof requests associated with the template.

Example: 1

isOwnerboolean

Whether the current user is the owner of the template

Example: true

created*string (date-time)

updated*string (date-time)

didDID (string)

DID as fully qualified, typically. did:dock:

Example: "did:dock:xyz"

requestobject

The actual details of the proof request.

typesarray of string

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

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/proof-templates/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "Proof request"
    }),
});
const data = await response.json();

Response

200400401402404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "totalRequests": 1,
  "isOwner": true,
  "created": "2025-01-09T20:07:57.155Z",
  "updated": "2025-01-09T20:07:57.155Z",
  "did": "did:dock:xyz",
  "request": {
    "name": "test request",
    "purpose": "my purpose"
  },
  "types": [
    "jsonld"
  ]
}

Get proof requests from template

Gets the proof requests from this template

GEThttps://api-testnet.truvera.io/proof-templates/{id}/history

Path parameters

id*string (uuid)

Proof template UUID

Query parameters

Response

200400404

Returns the information about the proof request history

Body

application/json

id*string (uuid)

The unique identifier for the proof request.

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

attributesobject

Requested attribute specifications of proof request

namestring

Proof request name

Example: "Proof request"

noncestring

Nonce or challenge for the presentation to match

Example: "1234567890"

errorstring

response_url*string (uri)

The URL to send the proof presentation response.

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

qrstring

QR code deep link for mobile wallet scanning

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

didDID (string)

DID as fully qualified, typically. did:dock:

Example: "did:dock:xyz"

verifiedboolean

Indicates whether the proof request has been verified.

Example: false

presentationobject

created*string (date-time)

The timestamp when the proof request was created.

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

updatedstring (date-time)

The timestamp when the proof request was last updated.

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

requestobject

The actual details of the proof request.

typestring

The type of the request.

Example: "proof-request"

typesarray of string

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

credentialsIssuersarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/proof-templates/{id}/history', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404

[
  {
    "id": "37275574-7ea4-438d-b8ef-f8fc61dbf09e",
    "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:dock:xyz",
    "verified": false,
    "created": "2024-09-26T12:38:10.871Z",
    "updated": "2024-09-26T12:38:10.871Z",
    "request": {
      "name": "test request",
      "purpose": "my purpose"
    },
    "type": "proof-request",
    "types": [
      "jsonld"
    ],
    "credentialsIssuers": [
      {
        "issuerDid": "text",
        "issuerName": "text",
        "issuerLogo": "text",
        "issuerTrustRegistries": [
          {
            "name": "text",
            "logoUrl": "text"
          }
        ]
      }
    ]
  }
]

Delete history for proof template

Deletes all the history for this proof template

Deletes all the history for this proof template

DELETEhttps://api-testnet.truvera.io/proof-templates/{id}/history

Path parameters

id*string (uuid)

Proof template UUID

Query parameters

Response

200400404

Proof requests have been deleted

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/proof-templates/{id}/history', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400404

{
  "status": 0,
  "type": "text",
  "message": "text"
}

Delete a proof template

Delete proof templates

Deletes the proof templates and associated data

DELETEhttps://api-testnet.truvera.io/proof-templates/{id}

Path parameters

id*string (uuid)

Proof template UUID

Response

200400401404

Proof templates will be deleted

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/proof-templates/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401404

{
  "status": 0,
  "type": "text",
  "message": "text"
}