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 displayed in a QR code for a wallet application to scan.

Create Proof Request

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

Creates proof request

Creates a proof request from this template

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

Path parameters

id*string (uuid)

Proof template UUID

Body

application/json

Specify optional nonce and verifier DID

noncestring

A unique nonce value used in the proof request.

Example: "123456"

didDID (string)

DID as fully qualified, typically. did:dock:

Example: "did:dock:xyz"

Response

200400402404

Returns the information about the proof request

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.

verifierNamestring

The name of the verifier.

Example: "Truvera"

verifierLogostring

The logo of the verifier.

Example: "https://logo.truvera.io/verifier"

Request

JavaScriptCurlPython

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

Response

200400402404

{
  "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"
  ],
  "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

Create a proof request

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

Body

application/json

Proof request object

attributesobject

Requested attribute specifications of proof request

name*string

Proof request name

Example: "Proof request"

templatestring (uuid)

The unique identifier for the template.

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

noncestring

Nonce or challenge for the presentation to match

Example: "1234567890"

didDID (string)

DID as fully qualified, typically. did:dock:

Example: "did:dock:xyz"

requestobject

The actual details of the proof request.

Response

200400402

Proof request created

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.

verifierNamestring

The name of the verifier.

Example: "Truvera"

verifierLogostring

The logo of the verifier.

Example: "https://logo.truvera.io/verifier"

Request

JavaScriptCurlPython

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

Response

200400402

{
  "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"
  ],
  "verifierName": "Truvera",
  "verifierLogo": "https://logo.truvera.io/verifier"
}

Get all proof requests

List all proof requests

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

Query parameters

Response

200400

A paged array of proof requests

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.

Request

JavaScriptCurlPython

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

Response

200400

[
  {
    "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"
    ]
  }
]

Get the details of an existing proof request

Get proof request

Get the details of an existing proof request

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

Authorization

rapidAPIaccessTokenbearerAuth

Path parameters

id*string (uuid)

Proof request UUID

Response

200400404

Returns the information about the proof request

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.

verifierNamestring

The name of the verifier.

Example: "Truvera"

verifierLogostring

The logo of the verifier.

Example: "https://logo.truvera.io/verifier"

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/proof-requests/{id}', {
    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"
  ],
  "verifierName": "Truvera",
  "verifierLogo": "https://logo.truvera.io/verifier"
}

Delete the proof request

Delete proof request

Deletes the proof request and associated data

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

Path parameters

id*string (uuid)

Proof request UUID

Response

200400404

Proof request will be deleted

Request

JavaScriptCurlPython

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

Response

400404

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