Truvera

Delete a Credential. Deletes all credential metadata and contents from the client. More info about [Delete Credentials](https://docs.truvera.io/developer-documentation/truvera-api/credentials) DELETE /credentials/{id}

Delete Delegation Rule Set. Deletes a delegation rule set and all of its versions. DELETE /delegation-rules/{policyId}

Delete DID. Deletes a provided DID from the blockchain, further attempts to resolve this DID will fail. More info about [Delete DID](https://docs.truvera.io/developer-documentation/truvera-api/dids) DELETE /dids/{did}

Delete a key. DELETE /keys/{publicKey}

Delete a DIDComm message. Delete a specific DIDComm message by its ID. Only messages owned by the authenticated user can be deleted. This action is irreversible. DELETE /messaging/messages/{messageId}

Delete OpenID issuer. Deletes the specified OpenID issuer and all associated data from the system. Use this endpoint to clean up issuers that are no longer needed. DELETE /openid/issuers/{id}

Deletes a single profile based on the supplied value of DID. DELETE /profiles/{did}

Delete proof request. Deletes the proof request and associated data DELETE /proof-requests/{id}

Delete proof templates. Deletes the proof templates and associated data DELETE /proof-templates/{id}

Deletes all the history for this proof template. DELETE /proof-templates/{id}/history

Delete Registry. A registry can be deleted, leading to all the corresponding revocation ids being deleted as well. More info about [Registry Deletion](https://docs.truvera.io/developer-documentation/truvera-api/registries#delete-registry) DELETE /registries/{id}

Delete Schema. Deletes a schema from the database DELETE /schemas/{schemaId}

Deletes a single sub-account. DELETE /subaccounts/{id}

Deletes a sub-account API key. DELETE /subaccounts/{id}/keys/{keyId}

Deletes a single team member. DELETE /teams/{id}/members/{user_id}

Deletes a single template based on ID provided. DELETE /templates/{id}

Delete Trust Registry. Deletes a Trust Registry DELETE /trust-registries/{registryId}

Remove Trust Registry participant. Removes a Trust Registry participant DELETE /trust-registries/{registryId}/participants/{participantId}

Remove Trust Registry proof template. Removes a Trust Registry proof template DELETE /trust-registries/{registryId}/proof-templates/{templateId}

Remove Trust Registry schema. Unassigns a schema from all participants in the trust registry DELETE /trust-registries/{registryId}/schemas/{schemaId}

Deletes a single webhook. DELETE /webhooks/{id}

List Credentials. Get all credential metadata GET /credentials

Get credential metadata and contents if persistent. Get credential metadata and, if persistent, its contents. **Deprecation notice:** retrieving decrypted persisted credential contents by supplying the `password` query parameter is deprecated and should not be used. Refer to the cloud wallet documentation for the recommended approach. When the `password` parameter is used, the response includes a `warning` field and `Deprecation`/`Warning` response headers. Retrieving credential metadata without a password is not deprecated. GET /credentials/{id}

List Credentials. Lists all created request claims that are open GET /credentials/request-claims

Get data history. Gets the call history for your account GET /data/history

Get data limits. Gets the plan limits for your account GET /data/limits

List all notifications for your account. GET /data/notifications

Gets your user profile. GET /data/profile

Get data stats. Gets some statistics for your account GET /data/stats

Get data transactions. Gets the transactions for your account GET /data/transactions

Get delegated StatusList2021Credential. Returns a StatusList2021Credential-compatible document for delegated credential revocation checks. GET /delegatable-revocations/{registryId}/status-list-credential

List Delegation Rule Sets. Returns delegation rule sets for the authenticated account, optionally filtered by schema id. GET /delegation-rules

Get Delegation Rule Set. Returns the latest delegation policy version for a policy id, or a specific timestamped version when createdAt is supplied. GET /delegation-rules/{policyId}

List DIDs. Return a list of all DIDs that your user account controls as fully resolved DID documents. More info about [Get DID](https://docs.truvera.io/developer-documentation/truvera-api/dids) GET /dids

Get DID. Returns the complete information about the provided "did" which is provided via parameters text box. More info about [Get DID](https://docs.truvera.io/developer-documentation/truvera-api/dids) GET /dids/{did}

Returns ecosystems that this DID is a participant in. GET /dids/{did}/ecosystems

Get DID metadata. Returns the metadata for your DID GET /dids/{did}/metadata

Get Job Status and data. Returns information related to the job being processed and its associated blockchain transaction. On completion or failure, the job data will be updated with a response from the blockchain. More info about [Job Status](https://docs.truvera.io/developer-documentation/truvera-api/jobs) GET /jobs/{id}

List all keys. GET /keys

List DIDComm messages. Retrieve a list of DIDComm messages for the authenticated user. Messages are returned in reverse chronological order (newest first). GET /messaging/messages

Get a specific DIDComm message. Retrieve a specific DIDComm message by its ID. Only messages owned by the authenticated user can be retrieved. GET /messaging/messages/{messageId}

Get OpenID credential offer object. Returns the credential offer object for use by an OpenID client GET /openid/credential-offers/{id}

List all OpenID issuers. Returns a paginated list of all OpenID issuers available in the system. This can be used to view the existing issuers and their configurations. GET /openid/issuers

Get OpenID issuer. Returns the configuration details of an existing OpenID issuer, identified by its UUID. This can be used to view the issuer's settings and supported features. GET /openid/issuers/{id}

OpenID authorize endpoint. Redirects the client to the authorization URL for a specific OpenID issuer. This endpoint begins the authorization flow, allowing users to authenticate with the issuer. GET /openid/issuers/{id}/authorize

OpenID callback endpoint. Processes the callback from the OpenID issuer after user authentication. This endpoint finalizes the authorization flow and returns control to the client application. GET /openid/issuers/{id}/callback

OpenID config endpoint. Retrieves the OpenID Connect discovery document for the specified issuer UUID. This document includes important details like supported scopes, endpoints, and token signing methods. GET /openid/issuers/{id}/.well-known/openid-configuration

Public OpenID issuer configuration route. Retrieves the OpenID configuration document for a specified issuer UUID. This document contains the public configuration details necessary for client applications to interact with the issuer. GET /openid/issuers/{id}/.well-known/openid-credential-issuer

Public issuer DID configuration route. Retrieves the Decentralized Identifier (DID) configuration document for a specified issuer UUID. This configuration is used to establish trust and interoperability with the issuer. GET /openid/issuers/{uuid}/.well-known/did-configuration

Redirect to authorize a proof request in OID4VP format. Redirects the client to the authorization URL for a specific OID4VP proof request. This endpoint is used to initiate the proof request authorization flow. GET /openid/vp/{id}/authorize

Retrieve JWK set for an OID4VP proof request. Returns the JSON Web Key Set (JWKS) associated with a specific OID4VP proof request. This is used to verify signatures within the request object. GET /openid/vp/{id}/jwks

Returns the information about the OID4VP request. Returns the proof request object in OID4VP format, which can be used with a request URI for processing verifiable presentations. GET /openid/vp/{id}/request

OID4VP config endpoint. Retrieves the configuration document for a specific proof request UUID. This document is used in OID4VP flows to verify the structure and requirements of the proof request. GET /openid/vp/{id}/.well-known/openid-configuration

List all Profiles. GET /profiles

Info for a specific profile by DID. GET /profiles/{did}

List all proof requests. GET /proof-requests

Get proof request. Get the details of an existing proof request GET /proof-requests/{id}

Get the proof request PEX definition. GET /proof-requests/{id}/pex

List all proof templates. GET /proof-templates

Get proof templates. Get the details of an existing proof templates GET /proof-templates/{id}

Gets the proof requests from this template. GET /proof-templates/{id}/history

List Registries. Get all registries created by user. More info about [List Registries](https://docs.truvera.io/developer-documentation/truvera-api/registries#list-registries) GET /registries

Get Registry. Get the details of an existing registry, such as policy, add-only status, when it was last updated, and controller(s). More info about [Get Registry](https://docs.truvera.io/developer-documentation/truvera-api/registries#get-registry) GET /registries/{id}

Get Revocation Status. Get the revocation status of a credential. More info about [Revocation Status](https://docs.truvera.io/developer-documentation/truvera-api/revocation-status) GET /revocationStatus/{regId}/{revId}

Get Revocation Status Witness. Get the revocation status witness of a BBS+ credential. More info about [Revocation Status](https://docs.truvera.io/developer-documentation/truvera-api/revocation-status) GET /revocationStatus/{regId}/{revId}/witness

List Schemas. Get all schemas created by user. More info about [List Schemas](https://docs.truvera.io/developer-documentation/truvera-api/credential-schemas#list-schemas) GET /schemas

Get Schema. Returns the JSON schema for a specific ID. More info about [Get Schema By ID](https://docs.truvera.io/developer-documentation/truvera-api/credential-schemas#get-schema) GET /schemas/{schemaId}

List all Subaccounts. GET /subaccounts

Info for a specific sub-account by ID. GET /subaccounts/{id}

List all subaccount keys. GET /subaccounts/{id}/keys

Lists transaction usage for this sub account. GET /subaccounts/{id}/usage

Get team data. GET /teams/{id}

List all Team Member Invitations. GET /teams/{id}/invitations

List all Team Members. GET /teams/{id}/members

List all templates. GET /templates

Info for a specific template by DID. GET /templates/{id}

List Trust Registries. Get all trust registries owned by the user GET /trust-registries

Get Trust Registry. Returns the Trust Registry for a specific ID. GET /trust-registries/{registryId}

Get Trust Registry participants. Returns the Trust Registry participants GET /trust-registries/{registryId}/participants

Get Trust Registry participant. Returns the Trust Registry participant GET /trust-registries/{registryId}/participants/{participantId}

Get Trust Registry proof templates. Returns the Trust Registry proof templates GET /trust-registries/{registryId}/proof-templates

Get public information about a trust registry. GET /trust-registries/{registryId}/public

Get Trust Registry VPI reports. Returns the Trust Registry VPI reports GET /trust-registries/{registryId}/reports

Get Trust Registry schemas. Returns the Trust Registry schemas GET /trust-registries/{registryId}/schemas

Gets all verifiers in a trust registry by schema ID. GET /trust-registries/{registryId}/verifiers

List all the DIDs belonging to the user that are linked to the requested schemas. Get all dids owned by user for schema IDs GET /trust-registries/schema-dids

List prices for schema IDs. Get all prices for schema IDs GET /trust-registries/schema-prices

List all webhooks. GET /webhooks

Info for a specific webhook. GET /webhooks/{id}

OpenID config endpoint. Retrieves the OpenID auth server discovery document for the specified issuer UUID GET /.well-known/oauth-authorization-server/openid/issuers/{id}

Updates your user profile metadata. PATCH /data/profile

Update a key. PATCH /keys/{publicKey}

Update a Profile. PATCH /profiles/{did}

Update a proof template. PATCH /proof-templates/{id}

Update a sub-account. PATCH /subaccounts/{id}

Update a Team. PATCH /teams/{id}

Update a team member. PATCH /teams/{id}/members/{user_id}

Update a template. PATCH /templates/{id}

Update a Trust Registry. PATCH /trust-registries/{registryId}

Update a Trust Registry participant. PATCH /trust-registries/{registryId}/participants/{participantId}

Update own Trust Registry participant info. PATCH /trust-registries/{registryId}/participants/{participantId}/info

Update a Webhook. PATCH /webhooks/{id}

Issue a Credential. Creates and issues a verifiable credential with supplied data. More info about [Issue a Credential](https://docs.truvera.io/developer-documentation/truvera-api/credentials) POST /credentials

Revoke a credential with a given ID. POST /credentials/{id}/revoke

Unrevoke a credential with a given ID. POST /credentials/{id}/unrevoke

Issue a Credential after requesting claims from the user. Creates and issues a verifiable credential with supplied data + claims from the user. POST /credentials/request-claims

Create data accountdelete. WARNING - Deletes your entire account! this is a two step process that requires getting a token then re-submitting that token as validation POST /data/accountdelete

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

Marks all pending notifications as read. POST /data/notifications/mark-read

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

Create or update delegatable revocation status. Claims a registry (create) or marks the delegated credential id as revoked or unrevoked. Requires a DID-signed EdDSA bearer JWT whose iss is the controller did:key and whose registryId, action, credentialId and statusListIndex claims match the request. The first authenticated call binds the registry to the caller DID; subsequent calls must be signed by that same DID. POST /delegatable-revocations/{registryId}

Create Delegation Rule Set. Creates a delegation rule set with a display name and stores its policy document as a timestamped version using policy createdAt. POST /delegation-rules

Create DID. Creates a new DID on chain with an auto generated keypair, the controller will be the same as the DID unless otherwise specified. More info about [Create DID](https://docs.truvera.io/developer-documentation/truvera-api/dids) POST /dids

Export DID document and keys. Exports the DID document and keys as an encrypted Universal Wallet JSON-LD document POST /dids/{did}/export

Import DIDs. Import DIDs from JSON objects ([DIDResolutionResponse](https://www.w3.org/TR/did-resolution/) or [Universal Wallet](https://w3c-ccg.github.io/universal-wallet-interop-spec/) format). Supports both encrypted and plaintext wallet exports. POST /dids/import

Create a key. POST /keys

Certs internal route, not for typical usage. Generates a temporary key. POST /keys/temporary-key

Receive DIDComm messages for a specific DID. Public endpoint to accept DIDComm messages for a specific DID. This endpoint is unauthenticated and allows external parties to send messages to a DID without requiring authentication. This endpoint accepts DIDComm v2 compliant messages: - For encrypted messages: POST the JWE (JSON Web Encryption) object directly with Content-Type: application/didcomm-encrypted+json - For signed messages: POST the JWS (JSON Web Signature) object directly with Content-Type: application/didcomm-signed+json - For plaintext messages: POST the plaintext DIDComm message object with Content-Type: application/json POST /messaging/{did}/receive

Create messaging decrypt. Decrypts a JSON Web Message POST /messaging/decrypt

Create messaging encrypt. Messaging encrypt POST /messaging/encrypt

Create messaging send. Sends a DIDComm message using our relay service and DID service endpoints, it also returns a URL for QR code scanning. Supports encrypted, plaintext and signed DIDComm messages. You can generate an encrypted DIDComm message by calling the /messaging/encrypt route POST /messaging/send

Create messaging sign. Signs a DIDComm message as a base64 encoded JWT POST /messaging/sign

Create messaging verify. Verifies a JWS in its compacted form POST /messaging/verify

OpenID credential retrieve endpoint. Retrieves a verifiable credential issued by an OpenID issuer. This endpoint is used to obtain the credential in a specified format after the issuance process. POST /openid/credential

Create openid credential offers. Generates and returns a credential offer URI for OpenID4VCI. This endpoint is used to initiate the credential issuance process. POST /openid/credential-offers

Create a new OpenID issuer. Creates a new OpenID issuer configuration in the system. This endpoint is used to add an issuer that can later be used for credential issuance and authentication. POST /openid/issuers

OpenID token endpoint. Handles the exchange of an authorization code for an access token, ID token, and optionally a refresh token. This endpoint is a key part of the OpenID Connect flow. POST /openid/issuers/{id}/token

OID4VP callback submit. Handles the submission of a callback for an OID4VP proof request. This endpoint processes the proof and returns the result to the client. POST /openid/vp/{id}

Get proof request in OID4VP deep link or QR code format. Creates and returns a deep link or QR code for an OID4VP proof request, allowing for easy scanning or clicking by users to initiate the proof process. POST /openid/vp/{id}/request-url

Create a Profile. POST /profiles

Create a new proof request. Create a proof request POST /proof-requests

Sends presentation to proof request. Sends a presentation to the request POST /proof-requests/{id}/send-presentation

Create a new proof template. Create a proof template POST /proof-templates

Creates proof request. Creates a proof request from this template POST /proof-templates/{id}/request

Create Registry. Create a Revocation registry on the blockchain. More info about [Registry Creation](https://docs.truvera.io/developer-documentation/truvera-api/registries) POST /registries

Revoke/Unrevoke Credential. Credential revocation is managed with on-chain revocation registries. To revoke a credential, its id (or hash of its id) must be added to the credential. More info about [Revoke/Unrevoke Credentials](https://docs.truvera.io/developer-documentation/truvera-api/registries#revoke-unrevoke-credential) POST /registries/{id}

Create Credential Schema. Creates a JSON schema on the blockchain. More info about [Schema Creation](https://docs.truvera.io/developer-documentation/truvera-api/credential-schemas#create-schema) POST /schemas

Create a Sub-account. POST /subaccounts

Creates an API key for a subaccount. POST /subaccounts/{id}/keys

Accept invitation to be a team member. POST /teams/accept-member-invite

Cancel the current invitation. POST /teams/{id}/invitations/{invitation_id}/cancel

Resend the invitation email. POST /teams/{id}/invitations/{invitation_id}/resend

Send email invitations to a list of emails. POST /teams/{id}/invite

Create a template. POST /templates

Create Trust Registry. Creates a new trust registry. You must be on a Custom plan to do this. POST /trust-registries

Invites a Trust Registry participant. POST /trust-registries/{registryId}/participants

Assigns a proof template to a trust registry. POST /trust-registries/{registryId}/proof-templates

Creates or updates a price for a schema ID with given currency and digits on a per issuer basis. POST /trust-registries/{registryId}/schemas/{schemaId}/price

Accepts an invite to an ecosystem. POST /trust-registries/invitations/accept

Decline the invitation of joining a trust registry. POST /trust-registries/invitations/decline

Snooze the invitation of joining a trust registry. POST /trust-registries/invitations/snooze

Query all trust registries. POST /trust-registries/query

Verify a credential or presentation. Verifies a VCDM credential or presentation as JSON or JWT string. More info about [Verify Credentials/Presentations](https://docs.truvera.io/developer-documentation/truvera-api/presentations) POST /verify

Create a Webhook. POST /webhooks