Skip to main content
GET
Retrieve a customer

Authorizations

Authorization
string
header
required

Basic HTTP authentication. Allowed headers-- Authorization: Basic <base64(api_key_id:api_key_secret)>

Path Parameters

customer_id
string
required

The unique identifier for the customer

Example:

"BBB815E9-F654-438D-9AD3-3F7BB8136FC0"

Response

Customer retrieved successfully

Represents a customer in the Imprint system

id
string
required

Unique identifier for the customer

Example:

"9B5E1EE0-2E1C-46E7-81B9-3C3917204BE4"

email
string<email>

Customer's email address

Example:

"customer@example.com"

phone
string

Customer's phone number in E.164 format

Example:

"+14155552671"

statuses
object

Map of the customer's enrolled card program name to the customer's status.

Example:
first_name
string

The customer's first name.

Example:

"John"

last_name
string

The customer's last name.

Example:

"Doe"

preferred_language
string

Customer's preferred language code as defined by ISO 639-1

Example:

"en"

ssn4
string

Customer's Social Security Number in 4 digits

Example:

"1234"

date_of_birth
object

Customer's date of birth

address
object

Mailing address information

partner_customer_id
string

The unique identifier for the customer in the partner's system

Example:

"PARTNER_USER_456"

metadata
object

Set of key-value pairs for storing additional information about the customer.

Example:
created_at
string

the RFC-3339 date when the customer was created

Example:

"2025-02-13T19:08:07.000Z"

updated_at
string

the RFC-3339 date when the customer was created

Example:

"2025-02-13T19:08:07.000Z"