Skip to main content
GET
Get customer

Authorizations

X-API-Key
string
header
required

Includes an API key in the HTTP headers to authenticate the client.

X-API-Secret
string
header
required

Includes an API secret in the HTTP headers to authenticate the client.

Path Parameters

id
string
required

A valid Customer ID

Pattern: ^cus_[a-zA-Z0-9]{27}$
Example:

"cus_2ofTA13AD0xBtbEvBl20aEb1hEu"

Response

The retrieved customer object

Complete customer schema

type
string
required
Minimum string length: 1
Minimum string length: 1
businessTradeName
string
required
Minimum string length: 1
industry
string
required
Minimum string length: 1
identifications
object[]
required
Minimum array length: 1
registeredDate
string
required
Minimum string length: 1
registeredAddress
object
required

Address information

Example:
operatingAddress
object
required

Address information

Example:
paymentMethods
(Bank Payment Method Response · object | object)[]
required
Example:
id
string

A valid Customer ID

Pattern: ^cus_[a-zA-Z0-9]{27}$
Example:

"cus_2ofTA13AD0xBtbEvBl20aEb1hEu"

email
string<email>
phone
string
entityType
enum<string>

The type of entity

Available options:
Bank,
Insurance Company,
Securities Broker or Dealer,
Investment Company or other Passive Investment Vehicle,
Trust Company,
Hedge Fund,
Other
Example:

"Bank"

website
string<uri>
documents
object[]
createdAt
string
updatedAt
string
status
enum<string>
Available options:
active,
in_compliance_review,
compliance_rejected,
created,
kyb_in_progress,
kyb_expired,
kyb_missing_information,
account_onboarding_pending,
failed_to_create
tags
string[] | null
isFinancialInstitution
boolean
controlPersons
object[]
eddFormId
string