multipart/form-data
PartnerApiKey (string) - API key associated with the partner.
| Field | Type | Required | Description |
|---|---|---|---|
userId | string | ✅ | The unique identifier of the user for whom the verification is sent. |
country | string | ✅ | ISO 3166-1 alpha-2 country code. Must be in SupportedCountry. |
documentType | string | ✅ | The document type submitted (e.g., VOTER_ID). |
frontId | file | ✅ | Front image of the identification document. |
backId | file | ✅ | Back image of the identification document. |
selfie | file | ✅ | Selfie of the user holding their ID. |
personalInfo | JSON (stringified) | ⛔ Conditional | Required only if country = "MX". See below for format. |
personalInfo structure| Field | Type | Required | Description |
|---|---|---|---|
profession | string | ✅ | User profession. See supported values below. |
phoneNumber | string | ✅ | User’s phone number in international format. |
birthCountry | string | ✅ | ISO 3166-1 alpha-2 code for user’s birth country. |
taxId | string | ✅ | User’s RFC (Mexican tax ID). RFC Format Info |
MX, and the user’s personal information such as profession, phoneNumber, and birthCountry.
Api key for the affiliated partner that is performing the request
The userId we gave to the partner when they onboarded their user with us
"2da954cd-2fda-49c2-ad77-6208c5ab71d6"
The country code for the partner
@description The country must be a valid ISO 3166-1 alpha-2 country code, see: @link https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
MX, DO, US, AT, BE, BG, HR, CY, CZ, DK, EE, FI, FR, DE, GR, HU, IE, IT, LV, LT, LU, MT, NL, PL, PT, RO, SK, SI, ES, SE, IS, LI, NO, CH, GB, MC, SM, AD, VA "DO"
The type of document the user is uploading
@description The documentType must be a valid DOCUMENT_TYPE, see: @link {@link RawSupportedDocumentType}
NATIONAL_ID, VOTER_ID, PASSPORT "NATIONAL_ID"
Personal information for regulatory purposes