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 root account can set up separate API keys for each sub-account. By using the sub-account specific API key it will ensure all the transactions are attributed to that sub-account.

Create Sub-Account

Parameters

Name	In	Type	Required	Description
body	body	object	true	Subaccount object
» name	body	string	true	The sub account name
» image	body	string	false	The sub account image

Responses

Status	Meaning	Description	Schema
200	OK	Subaccount has been created	Subaccount
400	Bad Request	Error creating subaccount	Error
402	Payment Required	Transaction limit reached or upgrade required to proceed	Error

POST /subaccounts REQUEST CURL

curl -X POST https://api-testnet.dock.io/subaccounts \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'DOCK-API-TOKEN: API_KEY'

Body parameter

{
  "name": "string",
  "image": "string"
}

200 Response

{
  "id": 0,
  "name": "string",
  "email": "string",
  "image": "string"
}

List Sub-Accounts

Parameters

Name	In	Type	Required	Description
offset	query	integer(int32)	false	How many items to offset by for pagination
limit	query	integer(int32)	false	How many items to return at one time (max 64)

Responses

Status	Meaning	Description	Schema
200	OK	A paged array of subaccounts	Subaccounts

GET /subaccounts REQUEST CURL

curl -X GET https://api-testnet.dock.io/subaccounts \
  -H 'Accept: application/json' \
  -H 'DOCK-API-TOKEN: API_KEY'

200 Response

[
  {
    "id": 0,
    "name": "string",
    "email": "string",
    "image": "string"
  }
]

Get Sub-Account by ID

Parameters

Name	In	Type	Required	Description
id	path	string	true	An ID

GET /subaccounts/{id} REQUEST CURL

curl -X GET https://api-testnet.dock.io/subaccounts/{id} \
  -H 'Accept: application/json' \
  -H 'DOCK-API-TOKEN: API_KEY'

200 Response

{
  "id": 0,
  "name": "string",
  "email": "string",
  "image": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Expected response to a valid request	Subaccount
400	Bad Request	Error getting subaccount	Error
401	Unauthorized	You do not own this subaccount	Error
404	Not Found	Subaccount was not found	Error

Update the specified sub-account.

Parameters

Name	In	Type	Required	Description
id	path	string	true	An ID
body	body	object	true	Subaccount properties
» name	body	string	true	The sub account name
» image	body	string	false	The sub account image

Responses

Status	Meaning	Description	Schema
200	OK	Subaccount has been updated	Subaccount
400	Bad Request	Error creating subaccount	Error
401	Unauthorized	You do not own this subaccount	Error
402	Payment Required	Transaction limit reached or upgrade required to proceed	Error

PATCH /subaccounts/{id} REQUEST CURL

curl -X PATCH https://api-testnet.dock.io/subaccounts/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'DOCK-API-TOKEN: API_KEY'

Body parameter

{
  "name": "string",
  "image": "string"
}

200 Response

{
  "id": 0,
  "name": "string",
  "email": "string",
  "image": "string"
}

Deletes the specified sub-account.

Parameters

Name	In	Type	Required	Description
id	path	string	true	An ID

Responses

Status	Meaning	Description	Schema
200	OK	Subaccount deleted	None
400	Bad Request	Error deleting subaccount	Error
401	Unauthorized	You do not own this subaccount	Error
404	Not Found	Subaccount was not found	Error

DELETE /subaccounts/{id} REQUEST CURL

curl -X DELETE https://api-testnet.dock.io/subaccounts/{id} \
  -H 'Accept: application/json' \
  -H 'DOCK-API-TOKEN: API_KEY'

400 Response

{
  "status": 0,
  "type": "string",
  "message": "string"
}

Get Sub-Account Usage

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

Parameters

Name	In	Type	Required	Description
id	path	string	true	An ID
startTime	query	string(date-time)	false	Timestamp for the start of the range (ISO 8601)
endTime	query	string(date-time)	false	Timestamp for the end of the range (ISO 8601)
offset	query	integer(int32)	false	How many items to offset by for pagination
limit	query	integer(int32)	false	How many items to return at one time (max 64)

Responses

Status	Meaning	Description	Schema
200	OK	A paged array of subaccount transaction usage metadata	ArrayResponse
401	Unauthorized	You do not own this subaccount	Error

GET /subaccounts/{id}/usage REQUEST CURL

curl -X GET https://api-testnet.dock.io/subaccounts/{id}/usage \
  -H 'Accept: application/json' \
  -H 'DOCK-API-TOKEN: API_KEY'

200 Response

[
  {}
]

Create Sub-Account API Key

Creates an API key for a subaccount. 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.

Parameters

Name	In	Type	Required	Description
id	path	string	true	An ID
body	body	object	false	Subaccount properties

Responses

Status	Meaning	Description	Schema
200	OK	Subaccount API key created	Response
400	Bad Request	Error creating subaccount API key	Error
401	Unauthorized	You do not own this subaccount	Error
402	Payment Required	Transaction limit reached or upgrade required to proceed	Error

POST /subaccounts/{id}/keys REQUEST CURL

curl -X POST https://api-testnet.dock.io/subaccounts/{id}/keys \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'DOCK-API-TOKEN: API_KEY'

200 Response

{
  "code": 0
}

List Sub-Account API Keys

Parameters

Name	In	Type	Required	Description
id	path	string	true	An ID
offset	query	integer(int32)	false	How many items to offset by for pagination
limit	query	integer(int32)	false	How many items to return at one time (max 64)

Responses

Status	Meaning	Description	Schema
200	OK	A paged array of subaccount key metadata	ArrayResponse
401	Unauthorized	You do not own this subaccount	Error

GET /subaccounts/{id}/keys REQUEST CURL

curl -X GET https://api-testnet.dock.io/subaccounts/{id}/keys \
  -H 'Accept: application/json' \
  -H 'DOCK-API-TOKEN: API_KEY'

200 Response

[
  {}
]

Delete a Sub-Account API Key

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

Parameters

Name	In	Type	Required	Description
id	path	string	true	An ID
keyId	path	string	true	An API key ID

Responses

Status	Meaning	Description	Schema
200	OK	Subaccount API key deleted	None
400	Bad Request	Error deleting subaccount API key	Error
401	Unauthorized	You do not own this subaccount	Error
404	Not Found	Subaccount API key was not found	Error

DELETE /subaccounts/{id}/keys/{keyId} REQUEST CURL

curl -X DELETE https://api-testnet.dock.io/subaccounts/{id}/keys/{keyId} \
  -H 'Accept: application/json' \
  -H 'DOCK-API-TOKEN: API_KEY'

400 Response

{
  "status": 0,
  "type": "string",
  "message": "string"
}