CRM Open API DocumentationCRM Open API Documentation
REST API
Webhooks
PSP Open API
External Exchange Rates
REST API
Webhooks
PSP Open API
External Exchange Rates
  • REST API Introduction
  • Authentication
  • Authentication V2
  • Clients API

    • Get List of Client
    • Get Client Information
    • Get Client Registration Details
    • Get Client KYC Details
    • Validate User's Credentials
    • Create Client
    • Get Uplines Information of client
    • Get Downlines Information of client
  • Leads API

    • Create Lead
  • Trading Servers Connections API

    • Get CRM Trading Platform Connections
  • MT4 API

    • Get MT4 Connection Information
    • Get MT4 Accounts
    • Create MT4 Account
    • Deposit into MT4 Account
    • Withdraw from MT4 Account
    • Get MT4 Trades
  • MT5 API

    • Get MT5 Connection Information
    • Get MT5 Accounts
    • Create MT5 Account
  • cTrader API

    • Get cTrader Connection Information
    • Get cTrader Accounts
  • Reports API

    • Get Fixed Commission Report
    • Get Flexible Commission Report
    • Get Transactions Report
  • Wallets API

    • Get Wallet Information
    • Update Wallet Balance
    • Get Update Wallet Balance Order status
  • Payments API

    • Get All Bankcards
  • Trading Competitions API

    • Get Trading Competition Leader Board
  • Requests API

    • Approve Withdrawal Requests
    • Reject Withdrawal Requests
  • Accounts API

    • Send Registration Request for OTP
    • Send Multi-Step Registration Request for Approval
  • Configurations API

    • Get Countries
    • Get States
    • Get Cities
  • Forms API

    • Get Trader Registration Form
    • Get User Kyc Form Collections
    • Get User Kyc Form
    • Get AWS S3 signature
  • TradingAccounts API

    • Get CRM Trading Account Types
  • Annex

    • Language Codes

Get Client KYC Details

GET /public/v1/users/{id}/kyc

Path Variables

NameTypeRequiredRuleDescription
idstringMandatorylength 8the unique ID of client

Expected HTTP status code

  • 200

Response

NameTypeDescription
[].keystringSystem unique key of the field
[].typestringType of the field
[].labelstringLabel of the field
[].label.[language-code]stringLabel of the field in different languages
[].valuestring/object/arrayValue of the field

Language Codes

CodeLanguage
en-usEnglish (United States)
zh-cnChinese (Simplified)
zh-twChinese (Traditional)
viVietnamese
jaJapanese
thThai
idIndonesian
deGerman
esSpanish

Error

CodeTypeDescription
400user_not_foundCannot find user from user_id
Last Updated:: 8/26/24, 7:57 AM
Prev
Get Client Registration Details
Next
Validate User's Credentials