Skip to main content
GET
Receive information about the client

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

200 response

name
string
required

Client name

Required string length: 1 - 15
Example:

"John"

surname
string
required

Client surname

Required string length: 1 - 30
Example:

"Doe"

nationality
string
required

Country ISO 3166-1 Alpha-3 code

Required string length: 3
Example:

"UKR"

birthday
string<date>
required

Client birthday in RFC 3339 (section 5.6)

Example:

"2017-07-21"

phone
string
required

Customer phone number

Example:

"+380689873682"

client
string<uuid>

Internal client ID

Example:

"73f86631-3aa8-4df3-a769-ed820761da8c"

adm
enum<string>

Administrative status

Available options:
adm:active,
adm:blocked,
adm:suspended
Example:

"adm:active"

kyc
enum<string>

Verification status

Available options:
kyc:unconfirmed,
kyc:confirmed,
kyc:pending,
kyc:rejected,
kyc:resubmission
Example:

"kyc:unconfirmed"

verifier
string

The service that verifies an applicant

Example:

"sumsub"

applicant
string

Applicant ID in the verification service

Example:

"628f44511a86170001268e99"

agent
string<uuid>

Internal agent ID

Example:

"39eab26c-8788-4375-810c-9807aaf98191"

context
string

Subset of the client information

Example:

"profile"

created
string<date-time>

When the client profile was created in RFC 3339 (section 5.6)

Example:

"2022-07-06T13:42:24.094Z"

updated
string<date-time>

Time of the last update in RFC 3339 (section 5.6)

Example:

"2022-07-06T13:42:24.094Z"

contract
string

User contract

Example:

"BasicContract"

termsVersion
string

User terms version accepted

Example:

"2022-07-06T13:42:24.094Z"

termsAcceptedTs
string

User terms accepted timestamp

Example:

"2022-07-06T13:42:24.094Z"

address
object