Skip to main content
GET
Search for an existing customer belonging to your business by email and/or phone number. Use this to look up a Soap customer_id before creating a checkout, or to check whether a customer already exists. Results are always scoped to the merchant whose API key is used.
At least one of email or phone_number must be supplied. When both are provided, the customer must match both values (AND semantics). Email matching is case-insensitive; phone numbers are normalized to 10 digits (a leading +1 and any non-digit characters are stripped).

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key

Query Parameters

email
string

Customer email. Case-insensitive. At least one of email or phone_number must be supplied.

Example:

"john@acme.com"

phone_number
string

US phone number. Non-digit characters and a leading +1 are stripped; the normalized form must be 10 digits. At least one of email or phone_number must be supplied.

Example:

"8008001234"

Response

Search results. Always returns a results array, possibly empty.

results
object[]