Truvera Documentation portal
WebsiteTruvera Workspace
  • Truvera overview
    • Decentralized identity explained
    • Roadmap
    • Subscription plans & billing
  • Solutions
    • Biometric-Bound Credentials
  • Truvera Workspace
    • Create an organization profile (DID)
    • Issue verifiable credentials
      • Filtering, downloading and deleting credentials
    • Verify credentials
    • Create a schema
    • Create a design
    • Team management
      • Inviting a team member
      • Removing a team member
      • Changing team member roles
      • Data retention policies
      • Sub-accounts
    • Revoking credentials
    • Ecosystem Tools
      • Ecosystem set up
      • Ecosystem example
    • Monetizing credentials
      • Setting up monetizable credentials
    • Creating API keys and webhook endpoints
    • Transaction history
    • Custom branded distribution emails
    • Truvera Workspace release notes
      • 2025 Release notes
        • Release notes Q1 2025
      • 2024 Release notes
        • Release Notes February 2024
        • Release Notes March 2024
        • Release Notes April 2024
        • Release Notes May 2024
        • Release Notes June 2024
        • Release Notes July 2024
        • Release Notes August 2024
        • Release Notes September 2024
        • Release Notes October 2024
        • Release notes November 2024
        • Release notes December 2024
  • Truvera API
    • Getting started
    • Webhooks
      • Webhooks API endpoints
    • Sample Postman collections
      • Issue-Store-Verify sample flow
      • Create ecosystems
      • Issue monetizable credentials
      • Create sub-accounts
      • Issue OpenID credentials
    • Truvera Swagger UI
    • DIDs
    • Profiles
    • Credentials
    • Presentations
      • Proof templates
      • Proof requests
      • Other proof endpoints
    • Registries
    • Revocation Status
    • Credential Schemas
    • Jobs
    • Templates
    • Sub-accounts
    • Teams
    • Messaging
    • OpenID
      • OpenID Issuance and Verification Integration Guide
    • iden3comm
    • Ecosystem Tools
      • Trust Registry Integration Guide
      • Creating a Trust Registry
      • Inviting participants
      • Verifiers and Public info
      • Trust Registry Schemas
      • Trust Registry Proof Templates
      • Reports
      • Updating and Deleting Trust Registry
    • Issuing paid credentials (KVAC algorithm integration)
    • Data
    • Verify
    • Keys
    • Schemas
  • System architecture
    • Proposed architecture with Truvera
    • Revocation
    • System scalability
    • Security policies
    • How data is processed and stored
  • Supported standards
    • Interoperability with OpenID
  • Credential wallet
    • Create and manage DIDs in the Truvera Wallet
    • White label wallet
      • Configuration
        • Enabling and Disabling Features
        • Customizing the Styling
        • Configuring for Android Builds
        • Configuring iOS Builds
      • Publishing in App Stores
        • Android Build Testing and Publishing
        • iOS Build Testing and Publishing
    • Wallet SDK
      • Getting started
        • Example Credential
        • Presentation definition
        • Verify credentials
      • Cloud wallet
      • Biometric plugin
      • Ecosystem Tools
    • Download Truvera Wallet
    • Truvera Wallet release notes
      • Release Notes 2025Q1
      • Release Notes 2024Q4
      • Release Notes 2024Q3
        • Release Notes September 2024
        • Release Notes August 2024
        • Release Notes July 2024
      • Release Notes June 2024
      • Release Notes May 2024
      • Release Notes April 2024
  • Open source community
    • Code of Conduct
    • Truvera Credential SDK
    • Blockchain archives
      • DOCK token
        • Migration terms and conditions
  • Support
    • System Status
    • Discord
    • Support services
    • Security policy
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
  1. Truvera API
  2. Presentations

Proof requests

PreviousProof templatesNextOther proof endpoints

Last updated 5 months ago

Was this helpful?

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.

Create Proof Request

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

Get all proof requests

Get the details of an existing proof request

Delete the proof request

List all proof requests

get
Authorizations
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
400
Application error
application/json
get
GET /proof-requests HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer JWT
Accept: */*
[
  {
    "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"
    ]
  }
]

Get proof request

get

Get the details of an existing proof request

Authorizations
Path parameters
idstring · uuidRequired

Proof request UUID

Responses
200
Returns the information about the proof request
application/json
Responseall of
400
Application error
application/json
404
Proof request was not found.
application/json
get
GET /proof-requests/{id} HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer JWT
Accept: */*
{
  "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"
  ],
  "verifierName": "Truvera",
  "verifierLogo": "https://logo.truvera.io/verifier"
}

Delete proof request

delete

Deletes the proof request and associated data

Authorizations
Path parameters
idstring · uuidRequired

Proof request UUID

Responses
200
Proof request will be deleted
400
Something went wrong.
application/json
404
Proof request was not found.
application/json
delete
DELETE /proof-requests/{id} HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer JWT
Accept: */*

No content

  • Create Proof Request
  • POSTCreates proof request
  • Create Proof Request
  • POSTCreate a new proof request
  • Get all proof requests
  • GETList all proof requests
  • Get the details of an existing proof request
  • GETGet proof request
  • Delete the proof request
  • DELETEDelete proof request

Creates proof request

post

Creates a proof request from this template

Authorizations
Path parameters
idstring · uuidRequired

Proof template UUID

Body
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
Responseall of
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
POST /proof-templates/{id}/request HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer JWT
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",
  "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 a new proof request

post

Create a proof request

Authorizations
Body

Represents a proof request payload in a verifiable credential system.

namestringRequired

Proof request name

Example: Proof request
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
Responseall of
400
Invalid parameters
application/json
402
Transaction limit reached or upgrade required to proceed
application/json
post
POST /proof-requests HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 323

{
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {
      "name": "favouriteDrink",
      "names": [
        "age"
      ]
    }
  },
  "name": "Proof request",
  "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",
  "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"
}