Get KYC Status

Results Explained

Attribute

Type

Description

userID

string

user identifier

firstname

string

user first name

lastname

string

user last name

identity

object

object containing user ID info

identity.type

string

ID number type

identity.number

string

ID number

identity.dob

string

user date of birth

accounts

array

an array containing an object of account level information

accounts.id

string

account identifier

accounts.accountNo

string

account number

accounts.nickname

string

account nickname

accounts.accountStatus

object

object containing current status of the account

accounts.accountStatus.name

string

current account status name

accounts.accountStatus.description

string

description of the current account status

accounts.accountType

string

account type

accounts.accountMgmtType

string

account management type

accounts.TradingType

string

account trading type

accounts.leverage

number

current leverage

kyc

object

an object containing the current KYC details of a user

kyc.status

object

an object containing the current KYC status of a user

kyc.status.name

string

current KYC status of a user

kyc.status.code

string

current KYC status failure code

kyc.status.description

string

description of the current KYC status

kyc.approved

object

object containing the details of the approval status

kyc.approved.timestamp

string

timestamp of when user kyc had been approved

kyc.approved.approvedBy

string

userID of the approver

kyc.accepted

object

object containing the details of the KYC approver

kyc.accepted.acceptedBy

string

name of the approver

kyc.accepted.timestamp

string

timestamp of when KYC was approved

kyc.errors

array

an array containing objects of KYC error reasons specific to the user

kyc.errors.name

string

name of the current KYC error status

kyc.errors.code

string

code that relates to the KYC error status

kyc.errors.description

string

description of the KYC error reason

status

object

an object containing the current user status of the user

status.name

string

user status

status.description

string

description of current user status

partnerID

object

an object containing the details of the referring partner

partnerID.id

string

user identifier of the referring partner

partnerID.name

string

name of the referring partner

Language
Authentication