Sub-accounts

Sub-accounts are a feature of the Dock Certs API that allows Dock enterprise customers to segregate their data within Dock's platform based on their own customers. Each sub-account can have its own keys, organization profiles, credential designs and verification templates conviently 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

POSThttps://api-testnet.dock.io/subaccounts

Body

application/json

Subaccount object

name*string

The sub account name

imagestring

The sub account image

Response

200400402

Subaccount has been created

Body

application/json

id*integer

The sub account ID

name*string

The sub account name

emailstring

The sub account email

imagestring

The sub account image

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.dock.io/subaccounts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

200400402

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

List sub-accounts

List all Subaccounts

GEThttps://api-testnet.dock.io/subaccounts

Query parameters

Response

200

A paged array of subaccounts

Body

application/json

id*integer

The sub account ID

name*string

The sub account name

emailstring

The sub account email

imagestring

The sub account image

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.dock.io/subaccounts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "name": "text",
    "email": "text",
    "image": "text"
  }
]

Get sub-account by ID

Info for a specific sub-account by ID

GEThttps://api-testnet.dock.io/subaccounts/{id}

Path parameters

id*integer

An subaccount ID

Response

200400401404

Expected response to a valid request

Body

application/json

id*integer

The sub account ID

name*string

The sub account name

emailstring

The sub account email

imagestring

The sub account image

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.dock.io/subaccounts/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401404

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

Update the specified sub-account

Update a sub-account

PATCHhttps://api-testnet.dock.io/subaccounts/{id}

Path parameters

id*string

An ID

Body

application/json

Subaccount properties

name*string

The sub account name

imagestring

The sub account image

Response

200400401402

Subaccount has been updated

Body

application/json

id*integer

The sub account ID

name*string

The sub account name

emailstring

The sub account email

imagestring

The sub account image

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.dock.io/subaccounts/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

200400401402

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

Deletes the specified sub-account

Deletes a single sub-account

DELETEhttps://api-testnet.dock.io/subaccounts/{id}

Path parameters

id*string

An ID

Response

200400401404

Subaccount deleted

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.dock.io/subaccounts/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401404

{
  "type": "text",
  "message": "text"
}

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

GEThttps://api-testnet.dock.io/subaccounts/{id}/usage

Path parameters

id*integer

An subaccount ID

Query parameters

Response

200400401

A paged array of subaccount transaction usage metadata

Body

application/json

ArrayResponse (array of object)

Default response

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.dock.io/subaccounts/{id}/usage', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401

[]

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

POSThttps://api-testnet.dock.io/subaccounts/{id}/keys

Path parameters

id*integer (int32)

An subaccount ID

Body

application/json

Subaccount properties

object

Response

200400401402

Subaccoun API key created

Body

application/json

codeinteger

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.dock.io/subaccounts/{id}/keys', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

200400401402

{}

List sub-account API keys

List all subaccount keys

GEThttps://api-testnet.dock.io/subaccounts/{id}/keys

Path parameters

id*string

An ID

Query parameters

Response

200400401

A paged array of subaccount key metadata

Body

application/json

ArrayResponse (array of object)

Default response

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.dock.io/subaccounts/{id}/keys', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401

[]

Delete a sub-account API key

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

Deletes a sub-account API key

DELETEhttps://api-testnet.dock.io/subaccounts/{id}/keys/{keyId}

Path parameters

id*integer (int32)

An subaccount ID

keyId*string

An API key ID

Response

200400401404

Subaccount API key deleted

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.dock.io/subaccounts/{id}/keys/{keyId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401404

{
  "type": "text",
  "message": "text"
}