Skip to main content
GET
/
v2
/
customers
/
{customer_id}
Retrieve a customer
curl --request GET \
  --url https://dev.sbx.imprint.co/v2/customers/{customer_id}
{
  "id": "9B5E1EE0-2E1C-46E7-81B9-3C3917204BE4",
  "email": "customer@example.com",
  "phone": "+14155552671",
  "statuses": {
    "Card Program Name": "OPEN"
  },
  "first_name": "John",
  "last_name": "Doe",
  "preferred_language": "en",
  "ssn4": "1234",
  "date_of_birth": {
    "year": 1990,
    "month": 1,
    "day": 1
  },
  "address": {
    "street_line1": "123 Main St",
    "street_line2": "Apt 4B",
    "city": "San Francisco",
    "state": "CA",
    "postal_code": "94105",
    "country": "USA"
  },
  "partner_customer_id": "PARTNER_USER_456",
  "metadata": {
    "preferred_language": "en"
  },
  "created_at": "2025-02-13T19:08:07.000Z",
  "updated_at": "2025-02-13T19:08:07.000Z"
}

Authorizations

​
Authorization
string
header
required

Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>

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:
{ "Card Program Name": "OPEN" }
​
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:
{ "preferred_language": "en" }
​
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"