Navigation
- General Information
- User Information
- Orders History
- Referral Orders History
- Investments History
- Make Investments
- List of Payment Details
- Saving Payment Details
- Deleting Payment Details
- Verification Information
- Verification Process
- Pay from Balance During Exchange
- Password Change
- 2FA Setup
- List of Filled Fields
To work with the User API, you need to generate a secret key in the user profile.
Example request:
curl -X POST 'https://YOUR.DOMAIN/user-api-get-info' \
--header 'X-Authorization: SECRET_KEY'
/user-api-get-info
Returns a user object.
/user-api-get-orders
Optional search parameters: "id", "token", "status", "exchange_id", "send_currency_id", "receive_currency_id".
Returns an order object.
/user-api-get-referral-orders
Optional search parameters: "id", "token", "status", "exchange_id", "send_currency_id", "receive_currency_id".
Returns an order object.
/user-api-get-investments
Optional search parameters: "id", "token", "active".
Returns an investment object.
/user-api-create-investments
| Parameter | Description |
|---|---|
| tariff | Tariff ID |
| amount | Amount |
| two_factor_authentication_password | 2FA Password (if 2FA is enabled) |
Returns an investment object.
/user-api-get-details
Optional search parameters: "currency_id", "value".
Returns the user payment details object.
/user-api-create-details
| Parameter | Description |
|---|---|
| currency_id | Currency ID |
| value | Payment Details |
Returns the user payment details object.
/user-api-delete-details
| Parameter | Description |
|---|---|
| ids[] | ID or IDs |
/user-api-get-verification
Returns a verification request object.
/user-api-submit-verification
For bank card verification, the required fields are card number, first name, last name, and photos.
| Parameter | Description |
|---|---|
| id_type | Document ID |
| id_number | Document Number |
| card_number | Bank Card Number |
| first_name | First Name |
| last_name | Last Name |
| middle_name | Middle Name |
| birth_date | Date of Birth (format: dd.mm.yyyy) |
| phone | Phone Number |
| country | Country |
| city | City |
| address | Address |
| zip_code | Postal Code |
| photos[] | Photos (maximum: 9000 KB) |
Returns a verification request object.
/user-api-spend-balance
| Parameter | Description |
|---|---|
| token | Order Token |
| two_factor_authentication_password | 2FA Password (if 2FA is enabled) |
/user-api-change-password
| Parameter | Description |
|---|---|
| password | Current Password |
| new_password | New Password |
| two_factor_authentication_password | 2FA Password (if 2FA is enabled) |
/user-api-setup-two-factor-authentication
| Parameter | Description |
|---|---|
| two_factor_authentication_token | Secret Key |
| two_factor_authentication_enable | Status (1: enable, 0: disable) |
| two_factor_authentication_password | 2FA Password |
/user-api-get-inputs
Returns an array with the exchange direction field ID as the key and its content.