Skip to main content

Accounts

Accounts represent organizational units within a node. Each account can hold multiple wallets. Accounts are scoped to the node associated with your API key -- you can only manage accounts belonging to your node.

Account Model

FieldTypeDescription
idstring (UUID)Unique account identifier
namestringAccount name (2-255 characters)
node_idstring (UUID)The node this account belongs to
typestringAccount type (see below)
statusintegerAccount status (see below)
created_atstring (ISO 8601)Creation timestamp
updated_atstring (ISO 8601)Last update timestamp
deleted_atstring (ISO 8601) | nullSoft deletion timestamp (null if active)

Account Types

ValueDescription
organisationStandard organisation account
customer-omnibusPooled customer account
customer-segregatedIndividual customer account
staking-organisationOrganisation staking account
staking-omnibusPooled staking account
staking-segregatedIndividual staking account

Account Statuses

ValueLabel
1Active
2Passive

Endpoints

MethodPathDescription
POST/v1/accountsCreate a new account
GET/v1/accountsList accounts (paginated)
GET/v1/accounts/{id}Get account by ID
PUT/v1/accounts/{id}Update an account
DELETE/v1/accounts/{id}Delete an account (soft delete)