Skip to content

sub-accounts.md

Latest commit

 

History

History
84 lines (52 loc) · 3.72 KB

sub-accounts.md

File metadata and controls

84 lines (52 loc) · 3.72 KB

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.

{% openapi src="https://swagger-api.truvera.io/openapi.yaml" path="/subaccounts" method="post" %} https://swagger-api.truvera.io/openapi.yaml {% endopenapi %}

List sub-accounts

{% openapi src="https://swagger-api.truvera.io/openapi.yaml" path="/subaccounts" method="get" %} https://swagger-api.truvera.io/openapi.yaml {% endopenapi %}

Get sub-account by ID

{% openapi src="https://swagger-api.truvera.io/openapi.yaml" path="/subaccounts/{id}" method="get" %} https://swagger-api.truvera.io/openapi.yaml {% endopenapi %}

Update the specified sub-account

{% openapi src="https://swagger-api.truvera.io/openapi.yaml" path="/subaccounts/{id}" method="patch" %} https://swagger-api.truvera.io/openapi.yaml {% endopenapi %}

Deletes the specified sub-account

{% openapi src="https://swagger-api.truvera.io/openapi.yaml" path="/subaccounts/{id}" method="delete" %} https://swagger-api.truvera.io/openapi.yaml {% endopenapi %}

Get sub-account usage

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

{% openapi src="https://swagger-api.truvera.io/openapi.yaml" path="/subaccounts/{id}/usage" method="get" %} https://swagger-api.truvera.io/openapi.yaml {% endopenapi %}

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.

{% openapi src="https://swagger-api.truvera.io/openapi.yaml" path="/subaccounts/{id}/keys" method="post" %} https://swagger-api.truvera.io/openapi.yaml {% endopenapi %}

List sub-account API keys

{% openapi src="https://swagger-api.truvera.io/openapi.yaml" path="/subaccounts/{id}/keys" method="get" %} https://swagger-api.truvera.io/openapi.yaml {% endopenapi %}

Delete a sub-account API key

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

{% openapi src="https://swagger-api.truvera.io/openapi.yaml" path="/subaccounts/{id}/keys/{keyId}" method="delete" %} https://swagger-api.truvera.io/openapi.yaml {% endopenapi %}