Get Account Details

Account

This API allows you to retrieve the details of a user's account.

Endpoint Information

  • Request Header: X-BH-TOKEN: ******

  • Request Method: GET

  • Request Path: /v2/user/account

  • Authorization Required: Yes

Response Structure

The response will include the following fields:

{
  "code": 200,                      // (number: response code)
  "msg": "SUCCESS",                 // (string: message)
  "data": {                         // (object: account details)
    "userId": 0,                    // (number: user ID)
    "country": "",                  // (string: name of the country)
    "companyName": "",              // (string: name of the company)
    "kycPassed": false,             // (boolean: whether the user passed KYC)
    "buyAmountLimit": 0.0,          // (number: buy amount limit)
    "buyAmountUsed": 0.0,           // (number: buy amount used)
    "sellAmountLimit": 0.0,         // (number: sell amount limit)
    "sellAmountUsed": 0.0            // (number: sell amount used)
  }
}

Example Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "userId": 1,
    "country": "Argentina",
    "companyName": "velafi",
    "kycPassed": true,
    "buyAmountLimit": 250000.0,
    "buyAmountUsed": 0.0,
    "sellAmountLimit": 250000.0,
    "sellAmountUsed": 0.0
  }
}

Notes

  • Ensure that you include the necessary authorization tokens in the request headers for successful execution.

  • The kycPassed field indicates whether the user has completed the KYC (Know Your Customer) process.

Last updated