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

Sub-accounts are limited to 5 for trial users. The amount of sub-accounts for customers with subscription varies depending on the subscription plan.

Create a Sub-account

post

https://api-testnet.truvera.iohttps://api.truvera.io

/subaccounts

Authorizations

bearerAuthaccessTokennextAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

namestringRequired

The sub account name

imagestringOptional

The sub account image

Responses

200

Subaccount has been created

application/json

idintegerRequired

The sub account ID

namestringRequired

The sub account name

emailstringOptional

The sub account email

imagestringOptional

The sub account image

createdAtstring · date-timeOptional

The date and time when the subaccount was created

Example: 2024-09-20T11:13:03.445Z

400

Error creating subaccount

application/json

402

Transaction limit reached or upgrade required to proceed

application/json

post

/subaccounts

HTTPcURLJavaScriptPython

POST /subaccounts HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 30

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

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

List sub-accounts

List all Subaccounts

get

https://api-testnet.truvera.iohttps://api.truvera.io

/subaccounts

Authorizations

bearerAuthaccessTokennextAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

newFormatbooleanOptional

Whether to use updated array format for the response

Default: false

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 subaccounts

application/json

or

get

/subaccounts

HTTPcURLJavaScriptPython

GET /subaccounts HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

A paged array of subaccounts

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

Get sub-account by ID

Info for a specific sub-account by ID

get

https://api-testnet.truvera.iohttps://api.truvera.io

/subaccounts/{id}

Authorizations

bearerAuthaccessTokennextAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

An subaccount ID

Responses

200

Expected response to a valid request

application/json

idintegerRequired

The sub account ID

namestringRequired

The sub account name

emailstringOptional

The sub account email

imagestringOptional

The sub account image

createdAtstring · date-timeOptional

The date and time when the subaccount was created

Example: 2024-09-20T11:13:03.445Z

400

Error getting subaccount

application/json

401

You do not own this subaccount

application/json

404

Subaccount was not found

application/json

get

/subaccounts/{id}

HTTPcURLJavaScriptPython

GET /subaccounts/{id} HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Update the specified sub-account

Update a sub-account

patch

https://api-testnet.truvera.iohttps://api.truvera.io

/subaccounts/{id}

Authorizations

bearerAuthaccessTokennextAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

An ID

Body

application/json

namestringRequired

The sub account name

imagestringOptional

The sub account image

Responses

200

Subaccount has been updated

application/json

idintegerRequired

The sub account ID

namestringRequired

The sub account name

emailstringOptional

The sub account email

imagestringOptional

The sub account image

createdAtstring · date-timeOptional

The date and time when the subaccount was created

Example: 2024-09-20T11:13:03.445Z

400

Error creating subaccount

application/json

401

You do not own this subaccount

application/json

402

Transaction limit reached or upgrade required to proceed

application/json

patch

/subaccounts/{id}

HTTPcURLJavaScriptPython

PATCH /subaccounts/{id} HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 30

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

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

Deletes the specified sub-account

Deletes a single sub-account

delete

https://api-testnet.truvera.iohttps://api.truvera.io

/subaccounts/{id}

Authorizations

bearerAuthaccessTokennextAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

An ID

Responses

200

Subaccount deleted

No content

400

Error deleting subaccount

application/json

401

You do not own this subaccount

application/json

404

Subaccount was not found

application/json

delete

/subaccounts/{id}

HTTPcURLJavaScriptPython

DELETE /subaccounts/{id} HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

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

https://api-testnet.truvera.iohttps://api.truvera.io

/subaccounts/{id}/usage

Authorizations

bearerAuthaccessTokennextAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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 · 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 subaccount transaction usage metadata

application/json

object[]Optional

Default response

400

Application error

application/json

401

You do not own this subaccount

application/json

get

/subaccounts/{id}/usage

HTTPcURLJavaScriptPython

GET /subaccounts/{id}/usage HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {}
]

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

https://api-testnet.truvera.iohttps://api.truvera.io

/subaccounts/{id}/keys

Authorizations

bearerAuthaccessTokennextAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idinteger · int32Required

An subaccount ID

Body

application/json

objectOptional

Responses

200

Subaccoun API key created

application/json

Default response

codeintegerOptional

400

Error creating subaccount API key

application/json

401

You do not own this subaccount

application/json

402

Transaction limit reached or upgrade required to proceed

application/json

post

/subaccounts/{id}/keys

HTTPcURLJavaScriptPython

POST /subaccounts/{id}/keys HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{
  "code": 1
}

List sub-account API keys

List all subaccount keys

get

https://api-testnet.truvera.iohttps://api.truvera.io

/subaccounts/{id}/keys

Authorizations

bearerAuthaccessTokennextAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

An ID

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 subaccount key metadata

application/json

object[]Optional

Default response

400

Application error

application/json

401

You do not own this subaccount

application/json

get

/subaccounts/{id}/keys

HTTPcURLJavaScriptPython

GET /subaccounts/{id}/keys HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {}
]

Delete a sub-account API key

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

Deletes a sub-account API key

delete

https://api-testnet.truvera.iohttps://api.truvera.io

/subaccounts/{id}/keys/{keyId}

Authorizations

bearerAuthaccessTokennextAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idinteger · int32Required

An subaccount ID

keyIdstringRequired

An API key ID

Responses

200

Subaccount API key deleted

No content

400

Error deleting subaccount API key

application/json

401

You do not own this subaccount

application/json

404

Subaccount API key was not found

application/json

delete

/subaccounts/{id}/keys/{keyId}

HTTPcURLJavaScriptPython

DELETE /subaccounts/{id}/keys/{keyId} HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content