Skip to main content
POST
/
accounts
Create Account
curl --request POST \
  --url https://access.utgl.io/v1/accounts \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assets": [
    "HKD",
    "USD",
    "BTC",
    "ETH",
    "BUSD",
    "USDT",
    "USDC"
  ],
  "name": "Acme Inc Treasury",
  "xmetadata": {
    "key1": "value1",
    "key2": [
      "value2.1",
      "value2.2"
    ]
  },
  "xid": "<string>",
  "idempotencyKey": "xeev1she5eegh9daiviethahchoo1muW"
}
'
{
  "id": "<string>",
  "xid": "<string>",
  "xmetadata": {},
  "name": "<string>",
  "accountNumber": "<string>",
  "description": "<string>"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
assets
string[]
required

The list of assets to be associated with the account. Assets are used to determine the account balance.

Example:
[
  "HKD",
  "USD",
  "BTC",
  "ETH",
  "BUSD",
  "USDT",
  "USDC"
]
​
name
string
required

A human-friendly non unique name for a account

Maximum string length: 128
Example:

"Acme Inc Treasury"

​
xmetadata
object

External metadata

Example:
{
  "key1": "value1",
  "key2": ["value2.1", "value2.2"]
}
​
xid
string

External identifier, unique across all resources created under this account.

​
idempotencyKey
string<string>

Unique idempotency key for ensuring exactly-once execution of mutating requests.

Example:

"xeev1she5eegh9daiviethahchoo1muW"

Response

Account created successfully

An account

​
id
string

Account id

​
xid
string

Account external id

​
xmetadata
object

Account metadata

​
name
string

Account name

​
accountNumber
string

Account Number

​
description
string

Account description