Get customer by externalId
Returns very basic information about a customer based on their external customer ID. For you to be able to retrieve a customer, they must have at least one session initiated with your API-Key. Please note that this endpoint returns an array of objects because we cannot ensure the uniqueness of the external customer ID.
Authorizations
Your secret API key, passed as Authorization: Api-Key <secret key>, for example Authorization: Api-Key sk_test_key. Secret keys are prefixed with sk_test_ (sandbox) or sk_live_ (production) and must only be used server-side. Never expose them in client code. Find your keys on the API keys page of the dashboard. See Authentication.
Path Parameters
A valid external customer ID.
Response
Successful response: an array of customer objects matching the external customer ID.
Unique identifier for the customer.
"2fcbcea3-6b62-49f1-b9d1-026d9bfd00b6"
Time at which the object was created. Returned as an ISO 8601 string.
"2024-02-17T18:24:45.206Z"
Time at which the object was last updated. Returned as an ISO 8601 string.
"2024-02-17T18:24:45.206Z"
true if the customer was created in live mode, false if created in sandbox.
true
Unique identifier of the customer's default fiat currency.
"71435a8d-211c-4664-a59e-2a5361a6c5a7"
Code of the customer's default fiat currency. May be omitted if no default currency is set.
"eur"
An identifier associated with the customer, provided by you.
Status of the customer's identity verification.
no_kyc, pending, completed, rejected "completed"
The customer's identity verification level. 0 if the customer has not completed an identity check.
1