Returns data about user read from id and address statement wrapped in ocrData object.
API reference, Id capture
Fetch ocr data v2
GET
https://demo-api.incodesmile.com/omni/get/ocr-data/v2Query parameters
Id of onboarding for which data are requested. If not present, it will be extracted from token.
Headers
Responses
Response body (application/json)
Full name from Barcode or MRZ
Initials as returned by bank-ID schemes (e.g. iDIN) — the only given-name evidence they provide
Address as read from id. Address can have two or three lines. Lines are separated by \\n
Street line in the way it is read from address string.
Street name without exterior and interior numbers.
Colony line the way it is read from address string. (Not applicable for all countries)
Postal code in the way it is read from address string.
City in the way it is read from address string.
State in the way it is read from address string.
Full StateName.
District in the way it is read from address string.
State code if applicable.
Address country code if applicable.
Full address label.
Exterior street number.
Interior street number.
The primary line in the address that contains the most essential details for locating a place.
Street type
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.
Street line in the way it is read from address string.
Street name without exterior and interior numbers.
Colony line the way it is read from address string. (Not applicable for all countries)
Postal code in the way it is read from address string.
City in the way it is read from address string.
State in the way it is read from address string.
Full StateName.
District in the way it is read from address string.
State code if applicable.
Address country code if applicable.
Full address label.
Exterior street number.
Interior street number.
The primary line in the address that contains the most essential details for locating a place.
Street type
Exterior street number.
Interior street number.
Address as read from address statement. Lines are separated by \\n.
Street line in the way it is read from address string.
Street name without exterior and interior numbers.
Colony line the way it is read from address string. (Not applicable for all countries)
Postal code in the way it is read from address string.
City in the way it is read from address string.
State in the way it is read from address string.
Full StateName.
District in the way it is read from address string.
State code if applicable.
Address country code if applicable.
Full address label.
Exterior street number.
Interior street number.
The primary line in the address that contains the most essential details for locating a place.
Street type
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
enum
a1aggmapgenergieAgcreaforeAztecaamdamicsaattaxtelbancoppelbancoAztecabanortebbvacabcaevcapaceacfecitibanamexcmapacmapaGrandecmapascmascmasBluecomapacomapaRedcoppeldapadhcdrenajeecogasengiegasNaturalhhsbcinbursainfonavitinterapasisagasizzijadjapamjapamajapamijapayjiapazjmasjrasjumapacjumapamlerdoliverpoolmasmegacablenaturgyoapasodapasooapasopdmoroapasacmexsacmexCdmxsantandersapasapalsapamuysapasasapasmascotiabankseapalsiapasimapagsimapassimassmapasmapacsmapamsmapasspectrumstorisuratamtelceltelmextotalplayveoliavictoriawizzasylumSeekerrefugeeIdrefugeeStatusutetelkomtmobileverizonxfinityaforeCoppelamericanExpressaptelnorwellsFargootherPoaDescription of timestamp.
UTC timestamp.
Extracted name from address statement.
enum
UnknownPassportVisaDriversLicenseIdentificationCardPermitCurrencyResidenceDocumentTravelDocumentBirthCertificateVehicleRegistrationOtherWeaponLicenseTribalIdentificationVoterIdentificationMilitaryTaxIdentificationFederalIDMedicalCardAdditional 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.
enum
MFXClave 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.
enum
FORMOCRPersonal 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.
Driver's license class.
DL class valid from UTC timestamp
DL class valid to UTC timestamp.
Additional codes associated with DL class.
Restriction codes associated with DL class.
Issuing country of document.
Issuing state of document.
Birth place as read from id.
Printing number (número de impresión) printed below the barcode on Colombian IDs.
Number of duplicates (número de duplicados) printed below the barcode on Colombian IDs.
Preparation number (número de preparación) printed below the barcode on Colombian IDs.
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.
Government validation data. Only for supported government validation countries.
Indicates validity of person's paternal last name through government validation apis.
Indicates validity of person's maternal last name through government validation apis.
Indicates validity of person's first name through government validation apis.
Indicates CURP validity through RENAPO/CURP provider validation.
Indicates CURP validity through INE government validation (separate from RENAPO).
Indicates ocr validity through government validation apis.
Indicates "clave de elector" validity through government validation apis.
Indicates "numero emision credencial" validity through government validation apis.
Indicates registration date validity through government validation apis.
Indicates issue date validity through government validation apis.
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.
enum
DOCUMENTO_INFANTILIDADE_PRE_ESCOLARMENOR_DE_ANOSNAO_ASSINAEM_FASE_DE_ALFABETIZACAOIMPOSSIBILITADO_DE_ASSINARLIMITED_TERMFEDERAL_LIMITS_APPLYPERMISO_PARA_TRABAJAREXTRANJEROINDIA_DIGITAL_VIDVETERANMOTORCYCLE_LICENSENON_DOMICILEDCOMMERCIAL_LICENSERESIDENTEMIGRANTETEMPORALVISITANTETRAMITERUEXINDIGENAAFROMEXICANAINDIA_DIGITAL_TAXIDStructure containing ocr reliability confidence for each extracted ocr field. Confidence values are Floats between 0 and 1.
enum
SUCCESSVALIDATION_ERRORFAILenum
POADOCUMENT_CAPTUREenum
PASSFAILNOT_EXECUTEDMethod used to submit the document.
enum
CAPTURED_DOCUMENTUPLOADED_FILEIMPORTED_CREDENTIALCredentials provider used when documentSubmissionMethod is IMPORTED_CREDENTIAL.
enum
APPLEGOOGLEDIGILOCKERSAMSUNGTRINSICNETHERLANDS_IDINFINNISH_TRUST_NETWORKResponse body (application/json)
UTC timestamp in milliseconds
Custom error code or HTTP status code
HTTP status error
Custom error message
Endpoint path
Custom error details