Create user

POST

users

curl --request POST \
  --url https://{host}/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "firstName": "John",
  "lastName": "Doe",
  "dateOfBirth": "1990-05-15",
  "residencyCountry": "GB"
}
'

{
  "id": "64f0c51e7fb3fc001234a001",
  "email": "[email protected]",
  "firstName": "John",
  "lastName": "Doe",
  "dateOfBirth": "1990-05-15",
  "residencyCountry": "GB",
  "emailVerified": false,
  "kycStatus": "pending",
  "createdAt": "2024-10-03T10:30:00Z",
  "updatedAt": "2024-10-03T10:30:00Z"
}

Authorizations

Authorization

string

header

required

Auth0-issued access token that includes the scopes listed for the endpoint.

Body

application/json

string<email>

required

User's email address (must be unique)

Example:

"[email protected]"

firstName

string

required

User's first name

Required string length: 1 - 100

Example:

"John"

lastName

string

required

User's last name

Required string length: 1 - 100

Example:

"Doe"

dateOfBirth

string<date>

required

User's date of birth (YYYY-MM-DD)

Example:

"1990-05-15"

residencyCountry

string

required

Two-letter ISO country code for user's country of residence

Example:

"GB"

address

object

User's residential address

Show child attributes

address.line1

string

First line of address

Example:

"123 High Street"

address.line2

string

Second line of address (optional)

Example:

"Apartment 4B"

address.city

string

City or town

Example:

"London"

address.postalCode

string

Postal or ZIP code

Example:

"SW1A 1AA"

address.countryCode

string

Two-letter ISO country code

Example:

"GB"

taxResidency

object

Tax residency information

Show child attributes

taxResidency.countryCode

string

Two-letter ISO country code for tax residency

Example:

"GB"

taxResidency.proofType

string

Type of tax identification (e.g., NINO, UTR, SSN)

Example:

"NINO"

taxResidency.value

string

Tax identification number

Example:

"AB123456C"

Response

User created successfully

string

required

MongoDB ObjectId of the created user

Example:

"64f0c51e7fb3fc001234a001"

string<email>

required

Example:

"[email protected]"

emailVerified

boolean

required

Whether the email has been verified

Example:

false

kycStatus

enum<string>

required

KYC verification status

Available options:

pending,

failed,

passed

Example:

"pending"

createdAt

string<date-time>

required

Timestamp when the user was created

Example:

"2024-10-03T10:30:00Z"

updatedAt

string<date-time>

required

Timestamp when the user was last updated

Example:

"2024-10-03T10:30:00Z"

firstName

string

Example:

"John"

lastName

string

Example:

"Doe"

dateOfBirth

string<date>

Example:

"1990-05-15"

residencyCountry

string

Example:

"GB"

address

object

Show child attributes

address.line1

string

address.line2

string

address.city

string

address.postalCode

string

address.countryCode

string

taxResidency

object

Show child attributes

taxResidency.countryCode

string

taxResidency.proofType

string

taxResidency.value

string

Get user cash balanceRetrieve available cash balance across one or more currencies.

⌘I

curl --request POST \
  --url https://{host}/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "firstName": "John",
  "lastName": "Doe",
  "dateOfBirth": "1990-05-15",
  "residencyCountry": "GB"
}
'

{
  "id": "64f0c51e7fb3fc001234a001",
  "email": "[email protected]",
  "firstName": "John",
  "lastName": "Doe",
  "dateOfBirth": "1990-05-15",
  "residencyCountry": "GB",
  "emailVerified": false,
  "kycStatus": "pending",
  "createdAt": "2024-10-03T10:30:00Z",
  "updatedAt": "2024-10-03T10:30:00Z"
}

API documentation

Authentication

Universe Configuration

Users

Cash

Savings Vault

Bank Accounts

Deposits

Wallets

Withdrawals

Portfolios

Daily Summaries

Investment Products

Investment Orders

Savings Orders

Learn

Test

Authorizations

Body

Response