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

Data

PreviousIssuing paid credentials (KVAC algorithm integration)NextVerify

Last updated 5 months ago

Was this helpful?

List all notifications for your account

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
readbooleanOptional

Whether to return read/unread items, or all if not provided

Responses
200
A paged array of notifications
application/json
400
Application error
application/json
get
GET /data/notifications HTTP/1.1
Host: api-testnet.dock.io
DOCK-API-TOKEN: YOUR_API_KEY
Accept: */*
{
  "total": 1,
  "list": [
    {
      "type": "text",
      "data": {},
      "created": "2025-06-01T22:14:22.222Z"
    }
  ]
}

Gets your user profile

get
Authorizations
Responses
200
Your user profile
application/json
400
Application error
application/json
get
GET /data/profile HTTP/1.1
Host: api-testnet.dock.io
DOCK-API-TOKEN: YOUR_API_KEY
Accept: */*
{
  "name": "text",
  "image": "text"
}

Marks all pending notifications as read

post
Authorizations
Responses
200
Latest notifications have been marked as read
400
Application error
application/json
post
POST /data/notifications/mark-read HTTP/1.1
Host: api-testnet.dock.io
DOCK-API-TOKEN: YOUR_API_KEY
Accept: */*

No content

get

Gets the plan limits for your account

Authorizations
Responses
200
Account paid plan limits
application/json
400
Error getting account limits
application/json
get
GET /data/limits HTTP/1.1
Host: api-testnet.dock.io
DOCK-API-TOKEN: YOUR_API_KEY
Accept: */*
{
  "code": 1
}
get

Gets the call history for your account

Authorizations
Responses
200
Account paid calls history by date
application/json
Responseobject[]

Default response

400
Error getting account history
application/json
get
GET /data/history HTTP/1.1
Host: api-testnet.dock.io
DOCK-API-TOKEN: YOUR_API_KEY
Accept: */*
[
  {}
]
get

Gets the transactions for your account

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
Account transactions
application/json
400
Error getting account transactions
application/json
get
GET /data/transactions HTTP/1.1
Host: api-testnet.dock.io
DOCK-API-TOKEN: YOUR_API_KEY
Accept: */*
{
  "total": 1,
  "list": [
    {}
  ]
}
get

Gets some statistics for your account

Authorizations
Responses
200
Account statistics
application/json
400
Error getting account statistics
application/json
get
GET /data/stats HTTP/1.1
Host: api-testnet.dock.io
DOCK-API-TOKEN: YOUR_API_KEY
Accept: */*
{
  "code": 1
}
  • GETList all notifications for your account
  • GETGets your user profile
  • PATCHUpdates your user profile metadata
  • POSTMarks all pending notifications as read
  • POSTCerts internal route, not for typical usage. Submits onboarding information for new accounts.
  • GET/data/limits
  • GET/data/history
  • GET/data/transactions
  • GET/data/stats
  • POST/data/delete
  • POST/data/accountdelete

Updates your user profile metadata

patch
Authorizations
Body
namestringRequired
imagestringRequired
Responses
200
User profile has been updated
400
Application error
application/json
patch
PATCH /data/profile HTTP/1.1
Host: api-testnet.dock.io
DOCK-API-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "name": "text",
  "image": "text"
}

No content

Certs internal route, not for typical usage. Submits onboarding information for new accounts.

post
Authorizations
Body
objectOptional
Responses
200
Success
application/json
Responseobject
400
Application error
application/json
post
POST /data/onboarding HTTP/1.1
Host: api-testnet.dock.io
CERTS-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{}
post

Deletes all data stored on our servers (credentials, dids, profiles, etc - not authentication/account data).

Authorizations
Body
validationstringOptional
Responses
200
Data has been deleted
application/json
400
Data could not be deleted
application/json
401
Unauthorized
application/json
post
POST /data/delete HTTP/1.1
Host: api-testnet.dock.io
DOCK-API-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "validation": "text"
}
{
  "code": 1
}
post

WARNING - Deletes your entire account! this is a two step process that requires getting a token then re-submitting that token as validation

Authorizations
Body
reasonstringOptional
validationstringOptional
Responses
200
Account has been deleted
application/json
400
Account could not be deleted
application/json
401
Unauthorized
application/json
post
POST /data/accountdelete HTTP/1.1
Host: api-testnet.dock.io
DOCK-API-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "reason": "text",
  "validation": "text"
}
{
  "code": 1
}