Fetch ocr data
Returns data about user read from id and address statement.
Query parameters
Id of onboarding for which data are requested. If not present, it will be extracted from token.
Headers
Response
OK
Address as read from id. Address can have two or three lines. Lines are separated by \n
This field is set to true if address from id is full (has three lines) or not (For Mexican Voter IDs only).
This field checks for a valid street, numeric postal code with 5 digits, and that both colony and city have values. (Only checked for Mexican IDs)
Address as obtained after processing with geocoder geolocation api.
Exterior street number.
Interior street number.
Address as read from address statement. Lines are separated by \n.
This field checks for a valid street, numeric postal code with 5 digits, and tha both colony and city have values. (Only checked for Mexican POA)
Issue date of address statement. The value is presented in UTC milliseconds.
Type of address statement document. Possible values:
- Mexico: liverpool, citibanamex, cfe, telcel, izzi, axtel, telmex, oapas, sacmex, opdm, naturgy, drenaje, totalplay, dhc, att, cea, smapa, megacable, jmas, amicsa, caev
- Bolivia: cre
- Uruguay: ute
- Unknown document: otherPoa
Extracted name from address statement.
Additional info about ID type (front side)
Additional info about ID type (back side)
Issue year (per classification model) of the ID (front side)
Issue year (per classification model) of the ID (back side)
Date of birth is presented in UTC milliseconds.
Gender values are presented in English. "M" for male, "F" for female and "X" for non-binary.
Clave de elector as read from id. For Mexican IDs only.
Curp as read form id. For Mexican IDs only.
Numero Emision Credencial as read from id. (For Mexican IDs only).
Cic as read from id. (This field is read from back side of id; For Mexican IDs only).
Ocr as read from id. (This field is read from back side of id; For Mexican IDs only).
Document number.
Document number source.
Personal number.
National number.
Document Reference Number.
Personal tax identification number.
NUE number as read from id. (for Resident Cards)
External user id.
Date of issue UTC timestamp.
Expiration date UTC timestamp.
Expiration year of id.
Issue year of id.
Registration date read from id.
Issuing country of document.
Issuing state of document.
Birth place as read from id.
Issuing Authority as read from id.
Person's height as read from id.
Person's weight.
Person's eye color.
Person's hair color.
Person's religion.
Person's blood type.
Person's marital status.
Person's nationality.
Person's race.
Person's nationality as it appears in MRZ (if present).
Person's nationality Alpha3 code format. Only for Brazilian IDs.
Number of not extracted OCR fields. Only for Mexican IDs.
Person's driver licence classes.
Person's driver licence conditions.
Person's driver licence mentions.
Person's driver licence restrictions.
First MRZ line.
Second MRZ line.
Third MRZ line.
Person's full name read from MRZ.
Document number check digit read from MRZ.
Date of birth check digit read from MRZ.
Expiration date check digit read from MRZ.
Full unformatted data read from 2D barcode.
Person's father's name. Only for Brazilian and Indian IDs.
Person's mother's name. Only for Brazilian IDs.
Person's father's Id Number. In the context of minors identity validation.
Person's mother's Id Number. In the context of minors identity validation.
Person's spouse's name.
Federal revenue number. Only for Brazilian IDs.
Origin document ID. Only for Brazilian IDs.
Driver's licence category. Only for Brazilian IDs.
Control number. Only for Brazilian IDs.
Renach. Only for Brazilian IDs.
Additional document attributes.
Method used to submit the document.
Credentials provider used when documentSubmissionMethod is IMPORTED_CREDENTIAL.