Skip to main content
GET
Get customer detail

Authorizations

Authorization
string
header
required

Integration-key Basic Auth (clientId:clientSecret) as documented in docs/public/AUTHENTICATION.md.

Path Parameters

customerId
string
required

System-generated customer UUID for the customer record addressed by this endpoint.

Response

Customer detail returned.

Public customer-detail response. ppvAddress is current-state readback only, uses plain localPart@ppvDomain form when present, and remains null until a customer payment address is explicitly issued.

id
string
required

Stable customer identifier.

platformId
string
required

Platform identifier that owns this customer.

platformCustomerId
string
required

Platform-provided customer identifier stored for this customer.

customerType
enum<string>
required

Customer type for this customer.

Available options:
INDIVIDUAL,
ENTITY
fullName
string
required

Public customer name stored for this customer.

ppvAddress
string | null
required

Public PPV address in plain localPart@ppvDomain format.

kycStatus
enum<string>
required

Current KYC status for the customer.

Available options:
PENDING,
APPROVED,
REJECTED
createdAt
string<date-time>
required

Creation timestamp.

updatedAt
string<date-time>
required

Last update timestamp.

birthDate
string<date> | null

Customer birth date in YYYY-MM-DD format when available.

nationality
string | null

Customer nationality or citizenship code when available.

address
object | null

Customer address when available.