Skip to main content
GET
Get a customer

Authorizations

Authorization
string
header
required

A JWT signed using your CDP API Key Secret, encoded in base64. Refer to the Generate Bearer Token section of our Authentication docs for information on how to generate your Bearer Token.

Path Parameters

customerId
string
required

The ID of the customer. The ID of the Customer, which is a UUID prefixed by customer_.

Pattern: ^customer_[a-f0-9\-]{36}$
Example:

"customer_af2937b0-9846-4fe7-bfe9-ccc22d935114"

Response

Successfully retrieved customer.

A customer record returned on read (Get / Create / Update Customer).

customerId
string
required

The ID of the Customer, which is a UUID prefixed by customer_.

Pattern: ^customer_[a-f0-9\-]{36}$
Example:

"customer_af2937b0-9846-4fe7-bfe9-ccc22d935114"

type
enum<string>
required

The type of the Customer.

Available options:
individual
Example:

"individual"

capabilities
object
required

Current state of each capability for this customer. Each capability shows whether it has been requested and its current status.

Example:
requirements
object
required

Map of requirements to be submitted. Each key is the field name, with values to describe its state. Requirements are only shown for requested capabilities. When a requirement is fulfilled, it disappears from this map.

Example:
createdAt
string<date-time>
read-only

Timestamp when the customer was created.

Example:

"2026-01-10T14:25:00Z"

updatedAt
string<date-time>
read-only

Timestamp when the customer was last updated.

Example:

"2026-01-10T14:30:00Z"

individual
object

Individual customer data returned on read — the individual object on Get / Create / Update Customer responses. Only contact-identity fields are echoed back; every other field accepted on the IndividualInput object (address, ssnLast4, dateOfBirth, fullSsn, citizenship, phoneNumber, and the CDD fields) is ingestion-only and never returned.

Example:
projectIds
string<uuid>[]

The project IDs that this customer is associated with.

The ID of the Project, a UUID v4.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
Example:
tosAcceptances
object[]

Terms of Service acceptances recorded for the customer.

Example: