Skip to main content
GET
Retrieve a customer

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The ID of the customer.

Response

OK

address
Address · object | null
required

Customer's primary address.

created_at
string<date-time>
required

The timestamp (in ISO-8601 format) of when the resource was created.

customer_type
any
required

Customer classification.

date_of_birth
string<date-time> | null
required

Customer's date and time of birth.

Example:

"1988-04-12T00:00:00Z"

first_name
string
required

Customer's first name.

full_name
string
required

Customer's full display name.

id
string
required

Unique resource identifier.

id_number
string | null
required

Masked national identity number.

last_name
string
required

Customer's last name.

mifid_category
string | null
required

Customer's MiFID classification.

modified_at
string<date-time>
required

The timestamp (in ISO-8601 format) of when the resource was last modified.

nationalities
string[] | null
required

ISO 3166-1 alpha-2 nationality codes.

onboarding
string | null
required

ID of the customer's onboarding process.

passport_number
string | null
required

Masked passport number.

phone_number
string | null
required

Customer's primary phone number.

reference
string | null
required

Customer-visible reference.

referrer_code
string | null
required

Referral code associated with the customer.

risk_profile
string | null
required

Customer's assigned risk profile.

risk_score
string | null
required

Customer's risk score.

Example:

"42.50"

status
enum<string>
required

Current customer status.

Available options:
active,
suspended,
closing,
closed
tax_number
string | null
required

Masked tax identification number.