Skip to main content
POST
/
core
/
accounts
Create account
curl --request POST \
  --url https://api.enterprise.sandbox.uphold.com/core/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "My BTC account",
  "asset": "BTC",
  "metadata": {
    "externalId": 123
  }
}
'
{
  "account": {
    "id": "555a99a1-620d-4431-a0ac-b43e1aad2bdc",
    "ownerId": "1e32fca3-23f7-40ed-bc1b-de10c790182d",
    "label": "My BTC account",
    "asset": "BTC",
    "balance": {
      "total": "0",
      "available": "0"
    },
    "createdAt": "2024-06-01T00:00:00.000Z",
    "updatedAt": "2024-07-15T00:00:00.000Z"
  }
}
You can optionally include custom entity metadata in the metadata field to store your own business data (e.g., account purpose, configuration, custom labels). If not provided during creation, you can add it later using Set metadata.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication.

Body

application/json
​
label
string
required

The label of the account.

Maximum string length: 140
Pattern: ^\S.*\S$|^\S$
​
asset
string
required

The asset in which the account will be denominated.

​
metadata
object

Additional data for the account.

Response

Account created.

​
account
object
required
​
errors
object

Additional contextual errors that occurred while processing the request.