Skip to main content
GET
cURL
Requires a SERVER API key. Pass document_number, phone, email, or any combination. When more than one is sent, the customer must match all of them. email is matched case-insensitively. document_type is optional and only valid together with document_number. CLIENT keys receive 403.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

document_type
enum<string>

The customer's document type. Only valid together with document_number; sending it alone returns 400. Identity document code. The value is {ISO country code}_{type} (for example CL_RUT). A name without the prefix, such as RUT, is rejected with 422. When this field is set, document_number is required. The prefix is not checked against country.

Available options:
AR_DNI,
AR_CUIT,
AR_CUIL,
AR_PASSPORT,
AR_DRIVER_LICENSE,
AR_OTHER,
BO_CI,
BO_NIT,
BO_PASSPORT,
BO_DRIVER_LICENSE,
BO_OTHER,
BR_RG,
BR_CPF,
BR_PASSPORT,
BR_DRIVER_LICENSE,
BR_OTHER,
CL_RUN,
CL_RUT,
CL_PASSPORT,
CL_DRIVER_LICENSE,
CL_OTHER,
CO_CC,
CO_RUT,
CO_NIT,
CO_PASSPORT,
CO_DRIVER_LICENSE,
CO_OTHER,
CR_CI,
CR_PASSPORT,
CR_DRIVER_LICENSE,
CR_OTHER,
DO_CI,
DO_PASSPORT,
DO_DRIVER_LICENSE,
DO_OTHER,
EC_CC,
EC_RUC,
EC_PASSPORT,
EC_DRIVER_LICENSE,
EC_OTHER,
SV_DUI,
SV_NIT,
SV_PASSPORT,
SV_DRIVER_LICENSE,
SV_OTHER,
GT_DPI,
GT_PASSPORT,
GT_DRIVER_LICENSE,
GT_OTHER,
HN_CI,
HN_RTN,
HN_PASSPORT,
HN_DRIVER_LICENSE,
HN_OTHER,
MX_CURP,
MX_RFC,
MX_INE,
MX_PASSPORT,
MX_DRIVER_LICENSE,
MX_OTHER,
NI_CI,
NI_PASSPORT,
NI_DRIVER_LICENSE,
NI_OTHER,
PA_CIP,
PA_PASSPORT,
PA_DRIVER_LICENSE,
PA_OTHER,
PY_CI,
PY_RUC,
PY_PASSPORT,
PY_DRIVER_LICENSE,
PY_OTHER,
PE_DNI,
PE_RUC,
PE_PASSPORT,
PE_DRIVER_LICENSE,
PE_OTHER,
UY_CI,
UY_RUT,
UY_PASSPORT,
UY_DRIVER_LICENSE,
UY_OTHER,
VE_CI,
VE_RIF,
VE_PASSPORT,
VE_DRIVER_LICENSE,
VE_OTHER
Example:

"CL_RUT"

document_number
string

The customer's document number (exact match). Can be sent alone or with document_type. When other filters are also sent, the customer must match all of them.

Maximum string length: 50
phone
string

The customer's phone, 10 to 15 digits. Matched as the same number regardless of format: spaces, dashes, +, the country code, a leading 0, a 0 kept after the country code and the mobile 9 (Argentina, Brazil) are ignored. For example +593 99 123 4567, 0991234567 and +5930991234567 find the same customer. When other filters are also sent, the customer must match all of them.

Example:

"+593 99 123 4567"

email
string<email>

The customer's email. Case-insensitive exact match. When other filters are also sent, the customer must match all of them.

Example:

"jane@example.com"

Response

Ok

data
object