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
    • 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
    • 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
  • 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

Keys

PreviousVerifyNextSchemas

Last updated 4 months ago

Was this helpful?

Delete a key

delete
Authorizations
Path parameters
publicKeystringRequired

A public key

Responses
200
Key has been deleted
application/json
400
Something went wrong.
application/json
404
Key was not found.
application/json
delete
DELETE /keys/{publicKey} HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer JWT
Accept: */*
{
  "revoked": true
}
  • GETList all keys
  • POSTCreate a key
  • DELETEDelete a key
  • PATCHUpdate a key
  • POSTCerts internal route, not for typical usage. Generates a temporary key

List all keys

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 keys
application/json
400
Application error
application/json
get
GET /keys HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer JWT
Accept: */*
[
  {
    "ips": [
      "text"
    ],
    "alias": "My API",
    "key": "text",
    "created": "text",
    "expires": "text"
  }
]

Create a key

post
Authorizations
Body
ipsstring[]Optional
aliasstring | nullableOptional

A human-readable name for the key

Example: My Key
Responses
200
Key has been created
application/json
Responseall of
400
Something went wrong.
application/json
403
Forbidden
application/json
post
POST /keys HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "ips": [
    "text"
  ],
  "alias": "My Key"
}
{
  "ips": [
    "text"
  ],
  "alias": "My API",
  "key": "text",
  "created": "text",
  "expires": "text",
  "jwt": "text"
}

Update a key

patch
Authorizations
Path parameters
publicKeystringRequired

A public key

Body
ipsstring[]Optional
aliasstring | nullableOptional

A human-readable name for the key

Example: My Key
Responses
200
Key has been updated
application/json
400
Something went wrong.
application/json
404
Key was not found.
application/json
patch
PATCH /keys/{publicKey} HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "ips": [
    "text"
  ],
  "alias": "My Key"
}
{
  "ips": [
    "text"
  ],
  "alias": "My API",
  "key": "text",
  "created": "text",
  "expires": "text"
}

Certs internal route, not for typical usage. Generates a temporary key

post
Authorizations
Body
subaccountintegerOptional
selectedTeamIdintegerOptional
isTestmodebooleanOptional
Responses
200
Temporary key has been created
application/json
400
Application error
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
post
POST /keys/temporary-key HTTP/1.1
Host: api-testnet.truvera.io
CERTS-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "subaccount": 1,
  "selectedTeamId": 1,
  "isTestmode": true
}
{
  "key": "text",
  "selectedTeamId": 1
}