Sub-accounts

Sub-accounts are a feature of the Truvera API that allows Truvera's enterprise customers to segregate their data within the Truvera platform based on their own customers. Each sub-account can have its own keys, organization profiles, credential designs and verification templates conveniently organized to help with tracking and auditing of the activity performed by each.

When using a sub-account the parent account will set up separate API keys for each sub-account and then use the sub-account specific API key for the transactions associated with that sub-account.

In order to easier manage sub-account assets Ecosystem Tools can be used.

Sample sub-account Postman collection

Download the collection here.

This Postman collection shows a simple example of sub-account set up in 5 steps:

1. Creating a sub-account

2. Creating an API key for a sub-account

3. Creating a DID for the sub-account

4. Inviting sub-account as a participant in an already existing ecosystem

5. Accepting the invite

Create sub-account

Create a Sub-account

post

Authorizations

bearerAuthaccessTokennextAuth

Body

namestringrequired

The sub account name

imagestringoptional

The sub account image

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api-testnet.truvera.io/subaccounts' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "image": "text"
  }'

200

400

402

200

{
  "id": 1,
  "name": "text",
  "email": "text",
  "image": "text",
  "createdAt": "2024-09-20T11:13:03.445Z"
}

Subaccount has been created

List sub-accounts

List all Subaccounts

get

Authorizations

bearerAuthaccessTokennextAuth

Query parameters

newFormatboolean · default: falseoptional

Whether to use updated array format for the response

offsetinteger · int32 · default: 0optional

How many items to offset by for pagination

limitinteger · int32 · min: 1 · max: 64 · default: 64optional

How many items to return at one time (max 64)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api-testnet.truvera.io/subaccounts' \
  --header 'Authorization: Bearer JWT'

200

200

[
  {
    "id": 1,
    "name": "text",
    "email": "text",
    "image": "text",
    "createdAt": "2024-09-20T11:13:03.445Z"
  }
]

A paged array of subaccounts

Get sub-account by ID

Info for a specific sub-account by ID

get

Authorizations

bearerAuthaccessTokennextAuth

Path parameters

idintegerrequired

An subaccount ID

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api-testnet.truvera.io/subaccounts/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

404

200

{
  "id": 1,
  "name": "text",
  "email": "text",
  "image": "text",
  "createdAt": "2024-09-20T11:13:03.445Z"
}

Expected response to a valid request

Update the specified sub-account

Update a sub-account

patch

Authorizations

bearerAuthaccessTokennextAuth

Path parameters

idstringrequired

An ID

Body

namestringrequired

The sub account name

imagestringoptional

The sub account image

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api-testnet.truvera.io/subaccounts/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "image": "text"
  }'

200

400

401

402

200

{
  "id": 1,
  "name": "text",
  "email": "text",
  "image": "text",
  "createdAt": "2024-09-20T11:13:03.445Z"
}

Subaccount has been updated

Deletes the specified sub-account

Deletes a single sub-account

delete

Authorizations

bearerAuthaccessTokennextAuth

Path parameters

idstringrequired

An ID

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api-testnet.truvera.io/subaccounts/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

404

200

No body

Subaccount deleted

Get sub-account usage

Get details about the activity that this sub-account has performed in the system.

Lists transaction usage for this sub account

get

Authorizations

bearerAuthaccessTokennextAuth

Path parameters

idintegerrequired

An subaccount ID

Query parameters

startTimestring · date-timeoptional

Timestamp for the start of the range (ISO 8601)

endTimestring · date-timeoptional

Timestamp for the end of the range (ISO 8601)

offsetinteger · int32 · default: 0optional

How many items to offset by for pagination

limitinteger · int32 · min: 1 · max: 64 · default: 64optional

How many items to return at one time (max 64)

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api-testnet.truvera.io/subaccounts/{id}/usage' \
  --header 'Authorization: Bearer JWT'

200

400

401

200

[
  {}
]

A paged array of subaccount transaction usage metadata

Create sub-account API key

Creates an API key for a sub-account. In order for activity to be associated with the given sub-account an API key needs to be created for that sub-account and then that key must be used for all transactions related to that sub-account.

Creates an API key for a subaccount

post

Authorizations

bearerAuthaccessTokennextAuth

Path parameters

idinteger · int32required

An subaccount ID

Body

objectoptional

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api-testnet.truvera.io/subaccounts/{id}/keys' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

400

401

402

200

{
  "code": 1
}

Subaccoun API key created

List sub-account API keys

List all subaccount keys

get

Authorizations

bearerAuthaccessTokennextAuth

Path parameters

idstringrequired

An ID

Query parameters

offsetinteger · int32 · default: 0optional

How many items to offset by for pagination

limitinteger · int32 · min: 1 · max: 64 · default: 64optional

How many items to return at one time (max 64)

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api-testnet.truvera.io/subaccounts/{id}/keys' \
  --header 'Authorization: Bearer JWT'

200

400

401

200

[
  {}
]

A paged array of subaccount key metadata

Delete a sub-account API key

Delete the specified API key for the given sub-account.

Deletes a sub-account API key

delete

Authorizations

bearerAuthaccessTokennextAuth

Path parameters

idinteger · int32required

An subaccount ID

keyIdstringrequired

An API key ID

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api-testnet.truvera.io/subaccounts/{id}/keys/{keyId}' \
  --header 'Authorization: Bearer JWT'

200

400

401

404

200

No body

Subaccount API key deleted