Retrieve a customer

curl --request GET \
  --url https://dev.sbx.imprint.co/v2/customers/{customer_id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "9B5E1EE0-2E1C-46E7-81B9-3C3917204BE4",
  "email": "[email protected]",
  "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"
}

GET

customers

{customer_id}

Retrieve a customer

curl --request GET \
  --url https://dev.sbx.imprint.co/v2/customers/{customer_id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "9B5E1EE0-2E1C-46E7-81B9-3C3917204BE4",
  "email": "[email protected]",
  "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

string

required

Unique identifier for the customer

Example:

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

string<email>

Customer's email address

Example:

"[email protected]"

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.

Show child attributes

statuses.{key}

enum<string>

Status of a customer within a card program.

Available options:

OPEN,

CLOSED

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

Show child attributes

date_of_birth.year

integer

Year of birth

Required range: x >= 1900

Example:

1990

date_of_birth.month

integer

Month of birth

Required range: 1 <= x <= 12

Example:

1

date_of_birth.day

integer

Day of birth

Required range: 1 <= x <= 31

Example:

1

address

object

Mailing address information

Show child attributes

address.street_line1

string

Primary street address

Example:

"123 Main St"

address.street_line2

string

Secondary street address (apartment, suite, etc.)

Example:

"Apt 4B"

address.city

string

City name

Example:

"San Francisco"

address.state

string

State or province

Example:

"CA"

address.postal_code

string

ZIP or postal code

Example:

"94105"

address.country

string

ISO-3166-1 alpha-3 Country Code

Example:

"USA"

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"

Search for customers Update a customer

⌘I

Basics

API Reference

Retrieve a customer

Authorizations

Path Parameters

Response