Account

The account API, given an end user's accountId, will give you a holistic view of the account status, funds, and any actions that must be taken on an Account (e.g. Upload KYC docs)

Note, only accountId's that are created under your organization will be accessible.

1. Get user account details
2. Create user account details
3. Edit user account details

Get user account details

URL : /v1/account/<accountId>

Method : GET

Auth required : Yes (API key and secret are required)

Permissions required : None

Success Response

Code : 200 OK

Sample response return:

{  "accountId": "12345",  "email": "testuser@gmail.com",  "full_name": "Michael Winter",  "full_address": "123 Main St, Chicago, IL 90874",  "create_datetime": "2021-11-06 12:11:01 GMT-06:00",  "currency": "USD",  "account_trade_status": "LIVE",  "account_blocked": false,  "account_cash_funds": 2532.12,  "account_portfolio_value": 6534.12,  "account_kyc_status": "CANNOT_WITHDRAW_KYC_REQUIRED"}

- accountId - String. The accountId of the returned account

- email - String. The email of the returned account

- full_name - String. The full name of the owner of the returned account

- full_address - String. The full address of the returned account

- create_datetime - String, datetime. The epoch datetime when the account was created. GMT timezone

- currency - String. The currency of the cash account

- account_trade_status - Enum that denotes the status of the account. Possible responses: LIVE, BLOCKED, UNDER_REVIEW

- account_blocked - Boolean that represents if the account is blocked or not. TRUE if account is blocked and not able to trade or withdraw, FALSE if account is not blocked

- account_cash_funds - Double. The amount of cash funds of the account

- account_portfolio_value - Double. The value of the total portfolio, including crypto and cash positions, returned in USD.

- account_kyc_status - Enum that represents the status of KYC (and any implications with withdrawal status). Depends on KYC status. Possible responses: READY_TO_WITHDRAW, CANNOT_WITHDRAW_KYC_REQUIRED, CANNOT_WITHDRAW_KYC_FAILED, UNDER_REVIEW. If response is CANNOT_WITHDRAW_KYC_REQUIRED, that means user has not completed KYC yet.

Error Response

Code : 400 BAD REQUEST

Condition : If accountId is invalid or if organization does not have access to this account(for security reasons).

Create user account details

URL : /v1/account/<accountId>

Method : POST

Auth required : Yes (API key and secret are required)

Permissions required : None

Body payload

Sample body payload:

{  "email": "testuser@gmail.com",  "full_name": "Michael Winter",  "full_address": "123 Main St, Chicago, IL 90874"}

- email - String. The email of the returned account

- full_name - String. The full name of the owner of the returned account

- full_address - String. The full address of the returned account

Success Response

Code : 200 OK

Error Response

Code : 400 BAD REQUEST

Condition : If accountId is invalid or if organization does not have access to this account(for security reasons).

Edit user account details

URL : /v1/account/edit/<accountId>

Method : PUT

Auth required : Yes (API key and secret are required)

Permissions required : None

Body payload

Sample body payload:

{  "email": "testuser123@gmail.com",  "full_name": "Josh Winter",  "full_address": "456 Main St, Chicago, IL 90874"}

- email - String. The email of the returned account

- full_name - String. The full name of the owner of the returned account

- full_address - String. The full address of the returned account

Success Response

Code : 200 OK

Error Response

Code : 400 BAD REQUEST

Condition : If accountId is invalid or if organization does not have access to this account(for security reasons).