Mexican Voter ID Back Extraction
Extracts name, surname, date of birth, sex, document number, expiry date, nationality and code from the back of a Mexican Voter ID (INE) card.
Content-Type: application/json
Headers
| Header | Type | Required | Description |
|---|---|---|---|
key | string | Yes | API key issued for authentication. |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
recordId | string | Yes | Unique ID you assign to correlate the request with the response. |
image | string | Yes | Base64 string / data URI of the Mexican Voter ID back image. |
Example
POST/pcs/MexicanVoterIdBack
curl --location 'https://sandbox/pcs/MexicanVoterIdBack' \
--header 'key: <your-api-key>' \
--header 'Content-Type: application/json' \
--data '{
"recordId": "1",
"image": "data:image/png;base64,<BASE64_STRING>"
}'200
{
"status": "success",
"recordId": "1",
"data": {
"name": "name-string",
"surname": "surname-string",
"DOB": "31/01/96",
"sex": "Female",
"document_no": "131116052",
"expiry_date": "31/12/27",
"nationality": "MEX",
"code": ""
},
"utc_time_stamp": "29/10/2024, 07:23:03"
}Response
| Field | Type | Description |
|---|---|---|
status | string | success when data was extracted. |
recordId | string | Echoes the recordId sent in the request. |
data.name | string | Holder's given name. |
data.surname | string | Holder's surname. |
data.DOB | string | Date of birth. |
data.sex | string | Holder's sex. |
data.document_no | string | Document / OCR number. |
data.expiry_date | string | Expiry date. |
data.nationality | string | Holder's nationality, e.g. MEX. |
data.code | string | MRZ code line, where present. |
utc_time_stamp | string | UTC timestamp of the response, DD/MM/YYYY, HH:mm:ss. |
Error handling
200 on success, 422 on a validation error — see
Error handling for the common error shape.