Skip to main content
GET
Get a customer by ID

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

Response

The requested customer

id
string
required

Unique customer identifier

Pattern: ^cus_[0-9A-Za-z]{22}$
applicationId
string
required

ID of the onboarding application that created this customer.

Pattern: ^app_[0-9A-Za-z]{22}$
createdAt
string<date-time>
required

Timestamp when the customer was created

Example:

"2026-01-15T09:30:00.000Z"

updatedAt
string<date-time>
required

Timestamp when the customer was last modified

Example:

"2026-01-15T09:30:00.000Z"

features
object[]
required

List of features enabled for this customer

isHouseAccount
boolean
required

Whether this customer is the organization's own house account rather than an external customer. Read-only.

Example:

false

type
enum<string>
required
Available options:
business

Registered legal name of the business

Example:

"Acme Payments Inc."

taxId
string
required

Government-issued tax identifier (e.g. EIN for US businesses).

Example:

"12-3456789"

registeredAddress
object
required

Registered office address. Same nested shape the onboarding request submits, so it round-trips field-for-field.

dateOfIncorporation
string<date>
required

Date the business was incorporated (YYYY-MM-DD)

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Example:

"2020-03-15"

Legal structure of the business — the local jurisdiction name the customer declared at onboarding (e.g. 'Sociedade Limitada', 'GmbH', 'C-Corporation'). Free-form string; the available options are jurisdiction-specific and surfaced by the requirements discovery endpoint.

Example:

"Sociedade Limitada"

contactEmail
string
required

Primary business contact email

Example:

"compliance@acmepay.com"

clientReferenceId
string

Client-provided external identifier for cross-referencing. 1-255 characters from A-Za-z, 0-9, underscore, hyphen, colon, and period — no spaces.

Pattern: ^[A-Za-z0-9_\-:.]{1,255}$
Example:

"client-cus-001"

tradeName
string

Doing-business-as name. Omitted if same as legal name.

Example:

"Acme Pay"

registrationNumber
string

Business registration or incorporation number

Example:

"12345678"

website
string

Business website URL

Example:

"https://acmepay.com"

coreIndustry
enum<string>

Primary industry classification of the business

Available options:
Agriculture,
Mining,
Manufacturing,
Retail/Wholesale,
Healthcare,
Real Estate,
Transport/Logistics,
Energy,
Education,
Financial Technology,
Professional Services,
Hospitality,
Construction,
Telecommunications,
Other
Example:

"Financial Technology"

contactPhone
string

Primary business contact phone number

Example:

"+14155551234"