API Endpoints
Search Customers
Look up an existing customer by email or phone number
GET
Search for an existing customer belonging to your business by email and/or phone number. Use this to look up a Soap
Your API key is in the Soap Dashboard under the Developers section. It looks like
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.
Every Soap API request is authenticated with a bearer token in the Authorization header:
key_....
Requests with a missing or invalid API key return 422 — never 401 — with a JSON error field, usually {"error": "API key not found."}. Branch on the status code rather than the message: GET /api/v1/device_pings/latest_geo_check does not yet return the same wording.
Never expose your API key in client-side code — it is server-side only.
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
Bearer token authentication using your API key (key_...). Used for every endpoint except POST /api/v1/device_pings.
Query Parameters
Customer email. Case-insensitive. At least one of email or phone_number must be supplied.
Example:
"john@acme.com"
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.

