---
title: "Fetch ocr data v2"
method: GET
path: "/omni/get/ocr-data/v2"
tags: ["Id capture"]
---

# Fetch ocr data v2

`GET /omni/get/ocr-data/v2`

Returns data about user read from id and address statement wrapped in ocrData object.

## Query parameters

- `id` string

## Headers

- `api-version` string, required

## Response `200`

OK

- OcrDataResponsePacked
  - `ocrData` OcrDataResponse
    - `name` NameBean
      - `fullName` string
      - `fullNameNativeScript` string
      - `firstNameNativeScript` string
      - `paternalLastNameNativeScript` string
      - `maternalLastNameNativeScript` string
      - `machineReadableFullName` string — Full name from Barcode or MRZ
      - `firstName` string
      - `middleName` string
      - `givenName` string
      - `givenNameMrz` string
      - `nameSuffix` string
      - `paternalLastName` string
      - `maternalLastName` string
      - `lastNameMrz` string
      - `familyName` string
    - `address` string — Address as read from id. Address can have two or three lines. Lines are separated by \n
    - `addressFields` AddressBean
      - `street` string — Street line in the way it is read from address string.
      - `streetName` string — Street name without exterior and interior numbers.
      - `colony` string — Colony line the way it is read from address string. (Not applicable for all countries)
      - `postalCode` string — Postal code in the way it is read from address string.
      - `city` string — City in the way it is read from address string.
      - `state` string — State in the way it is read from address string.
      - `stateName` string — Full StateName.
      - `district` string — District in the way it is read from address string.
      - `stateCode` string — State code if applicable.
      - `addressCountryCode` string — Address country code if applicable.
      - `label` string — Full address label.
      - `exteriorNumber` string — Exterior street number.
      - `interiorNumber` string — Interior street number.
      - `addressLine1` string — The primary line in the address that contains the most essential details for locating a place.
      - `streetType` string — Street type
    - `fullAddress` boolean — This field is set to true if address from id is full (has three lines) or not (For Mexican Voter IDs only).
    - `invalidAddress` boolean — 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)
    - `checkedAddress` string — Address as obtained after processing with geocoder geolocation api.
    - `checkedAddressBean` AddressBean
      - `street` string — Street line in the way it is read from address string.
      - `streetName` string — Street name without exterior and interior numbers.
      - `colony` string — Colony line the way it is read from address string. (Not applicable for all countries)
      - `postalCode` string — Postal code in the way it is read from address string.
      - `city` string — City in the way it is read from address string.
      - `state` string — State in the way it is read from address string.
      - `stateName` string — Full StateName.
      - `district` string — District in the way it is read from address string.
      - `stateCode` string — State code if applicable.
      - `addressCountryCode` string — Address country code if applicable.
      - `label` string — Full address label.
      - `exteriorNumber` string — Exterior street number.
      - `interiorNumber` string — Interior street number.
      - `addressLine1` string — The primary line in the address that contains the most essential details for locating a place.
      - `streetType` string — Street type
    - `exteriorNumber` string — Exterior street number.
    - `interiorNumber` string — Interior street number.
    - `addressFromStatement` string — Address as read from address statement. Lines are separated by \n.
    - `addressFieldsFromStatement` AddressBean
      - `street` string — Street line in the way it is read from address string.
      - `streetName` string — Street name without exterior and interior numbers.
      - `colony` string — Colony line the way it is read from address string. (Not applicable for all countries)
      - `postalCode` string — Postal code in the way it is read from address string.
      - `city` string — City in the way it is read from address string.
      - `state` string — State in the way it is read from address string.
      - `stateName` string — Full StateName.
      - `district` string — District in the way it is read from address string.
      - `stateCode` string — State code if applicable.
      - `addressCountryCode` string — Address country code if applicable.
      - `label` string — Full address label.
      - `exteriorNumber` string — Exterior street number.
      - `interiorNumber` string — Interior street number.
      - `addressLine1` string — The primary line in the address that contains the most essential details for locating a place.
      - `streetType` string — Street type
    - `invalidAddressFromStatement` boolean — 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)
    - `addressStatementEmissionDate` integer — Issue date of address statement. The value is presented in UTC milliseconds.
    - `documentType` 'a1' | 'aggm' | 'apg' | 'energieAg' | 'cre' | 'aforeAzteca' | 'amd' | 'amicsa' | 'att' | 'axtel' | 'bancoppel' | 'bancoAzteca' | 'banorte' | 'bbva' | 'cab' | 'caev' | 'capa' | 'cea' | 'cfe' | 'citibanamex' | 'cmapa' | 'cmapaGrande' | 'cmapas' | 'cmas' | 'cmasBlue' | 'comapa' | 'comapaRed' | 'coppel' | 'dapa' | 'dhc' | 'drenaje' | 'ecogas' | 'engie' | 'gasNatural' | 'h' | 'hsbc' | 'inbursa' | 'infonavit' | 'interapas' | 'isagas' | 'izzi' | 'jad' | 'japam' | 'japama' | 'japami' | 'japay' | 'jiapaz' | 'jmas' | 'jras' | 'jumapac' | 'jumapam' | 'lerdo' | 'liverpool' | 'mas' | 'megacable' | 'naturgy' | 'oapas' | 'odapas' | 'ooapas' | 'opdm' | 'oroapa' | 'sacmex' | 'sacmexCdmx' | 'santander' | 'sapa' | 'sapal' | 'sapamuy' | 'sapasa' | 'sapasma' | 'scotiabank' | 'seapal' | 'siapa' | 'simapag' | 'simapas' | 'simas' | 'smapa' | 'smapac' | 'smapam' | 'smapas' | 'spectrum' | 'stori' | 'sura' | 'tam' | 'telcel' | 'telmex' | 'totalplay' | 'veolia' | 'victoria' | 'wizz' | 'asylumSeeker' | 'refugeeId' | 'refugeeStatus' | 'ute' | 'telkom' | 'tmobile' | 'verizon' | 'xfinity' | 'aforeCoppel' | 'americanExpress' | 'ap' | 'telnor' | 'wellsFargo' | 'otherPoa' — 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
    - `addressStatementTimestamps` AddressStatementDate[]
      - `get_version` integer
      - `dateType` string — Description of timestamp.
      - `addressStatementTimestamp` integer — UTC timestamp.
    - `poaName` string — Extracted name from address statement.
    - `typeOfId` 'Unknown' | 'Passport' | 'Visa' | 'DriversLicense' | 'IdentificationCard' | 'Permit' | 'Currency' | 'ResidenceDocument' | 'TravelDocument' | 'BirthCertificate' | 'VehicleRegistration' | 'Other' | 'WeaponLicense' | 'TribalIdentification' | 'VoterIdentification' | 'Military' | 'TaxIdentification' | 'FederalID' | 'MedicalCard'
    - `documentFrontSubtype` string — Additional info about ID type (front side)
    - `documentBackSubtype` string — Additional info about ID type (back side)
    - `issueFront` integer — Issue year (per classification model) of the ID (front side)
    - `issueBack` integer — Issue year (per classification model) of the ID (back side)
    - `birthDate` integer — Date of birth is presented in UTC milliseconds.
    - `gender` 'M' | 'F' | 'X' — Gender values are presented in English. "M" for male, "F" for female and "X" for non-binary.
    - `claveDeElector` string — Clave de elector as read from id. For Mexican IDs only.
    - `curp` string — Curp as read form id. For Mexican IDs only.
    - `numeroEmisionCredencial` string — Numero Emision Credencial as read from id. (For Mexican IDs only).
    - `cic` string — Cic as read from id. (This field is read from back side of id; For Mexican IDs only).
    - `ocr` string — Ocr as read from id. (This field is read from back side of id; For Mexican IDs only).
    - `documentNumber` string — Document number.
    - `documentNumberSource` 'FORM' | 'OCR' — Document number source.
    - `personalNumber` string — Personal number.
    - `nationalNumber` string — National number.
    - `refNumber` string — Document Reference Number.
    - `taxIdNumber` string — Personal tax identification number.
    - `nue` string — NUE number as read from id. (for Resident Cards)
    - `externalId` string — External user id.
    - `issuedAt` string — Date of issue UTC timestamp.
    - `expireAt` string — Expiration date UTC timestamp.
    - `expirationDate` integer — Expiration year of id.
    - `issueDate` integer — Issue year of id.
    - `registrationDate` integer — Registration date read from id.
    - `dlClassDetails` DLClassDetails[]
      - `dlClass` string — Driver's license class.
      - `validFromDate` integer — DL class valid from UTC timestamp
      - `validToDate` integer — DL class valid to UTC timestamp.
      - `additionalCodes` string — Additional codes associated with DL class.
      - `restrictions` string[] — Restriction codes associated with DL class.
    - `issuingCountry` string — Issuing country of document.
    - `issuingState` string — Issuing state of document.
    - `birthPlace` string — Birth place as read from id.
    - `issuingAuthority` string — Issuing Authority as read from id.
    - `height` string — Person's height as read from id.
    - `weight` string — Person's weight.
    - `eyeColor` string — Person's eye color.
    - `hairColor` string — Person's hair color.
    - `religion` string — Person's religion.
    - `bloodType` string — Person's blood type.
    - `maritalStatus` string — Person's marital status.
    - `nationality` string — Person's nationality.
    - `race` string — Person's race.
    - `nationalityMrz` string — Person's nationality as it appears in MRZ (if present).
    - `nationalityAlpha3` string — Person's nationality Alpha3 code format. Only for Brazilian IDs.
    - `governmentComparisonResults` GovernmentComparisonResults — Government validation data. Only for supported government validation countries.
      - `paternalLastNameValid` boolean — Indicates validity of person's paternal last name through government validation apis.
      - `maternalLastNameValid` boolean — Indicates validity of person's maternal last name through government validation apis.
      - `firstNameValid` boolean — Indicates validity of person's first name through government validation apis.
      - `curpValid` boolean — Indicates CURP validity through RENAPO/CURP provider validation.
      - `ineCurpValid` boolean — Indicates CURP validity through INE government validation (separate from RENAPO).
      - `ocrValid` boolean — Indicates ocr validity through government validation apis.
      - `claveDeElectorValid` boolean — Indicates "clave de elector" validity through government validation apis.
      - `numeroEmisionCredencialValid` boolean — Indicates "numero emision credencial" validity through government validation apis.
      - `registrationDateValid` boolean — Indicates registration date validity through government validation apis.
      - `issueDateValid` boolean — Indicates issue date validity through government validation apis.
    - `notExtracted` integer — Number of not extracted OCR fields. Only for Mexican IDs.
    - `notExtractedDetails` string[]
    - `classes` string — Person's driver licence classes.
    - `cond` string — Person's driver licence conditions.
    - `mentions` string — Person's driver licence mentions.
    - `restrictions` string — Person's driver licence restrictions.
    - `mrz1` string — First MRZ line.
    - `mrz2` string — Second MRZ line.
    - `mrz3` string — Third MRZ line.
    - `fullNameMrz` string — Person's full name read from MRZ.
    - `documentNumberCheckDigit` string — Document number check digit read from MRZ.
    - `dateOfBirthCheckDigit` string — Date of birth check digit read from MRZ.
    - `expirationDateCheckDigit` string — Expiration date check digit read from MRZ.
    - `barcodeRawData` string — Full unformatted data read from 2D barcode.
    - `fathersName` string — Person's father's name. Only for Brazilian and Indian IDs.
    - `mothersName` string — Person's mother's name. Only for Brazilian IDs.
    - `fathersIdNumber` string — Person's father's Id Number. In the context of minors identity validation.
    - `mothersIdNumber` string — Person's mother's Id Number. In the context of minors identity validation.
    - `spouseName` string — Person's spouse's name.
    - `federalRevenueNumber` string — Federal revenue number. Only for Brazilian IDs.
    - `originDocumentId` string — Origin document ID. Only for Brazilian IDs.
    - `driversLicenseCategory` string — Driver's licence category. Only for Brazilian IDs.
    - `controlNumber` string — Control number. Only for Brazilian IDs.
    - `renach` string — Renach. Only for Brazilian IDs.
    - `additionalAttrs` string[] — Additional document attributes.
    - `ocrDataConfidence` OcrDataConfidence — Structure containing ocr reliability confidence for each extracted ocr field. Confidence values are Floats between 0 and 1.
      - `birthDateConfidence` number, float
      - `nameConfidence` number, float
      - `nameNativeScriptConfidence` number, float
      - `firstNameNativeScriptConfidence` number, float
      - `paternalLastNameNativeScriptConfidence` number, float
      - `maternalLastNameNativeScriptConfidence` number, float
      - `givenNameConfidence` number, float
      - `firstNameConfidence` number, float
      - `middleNameConfidence` number, float
      - `nameSuffixConfidence` number, float
      - `mothersSurnameConfidence` number, float
      - `fathersSurnameConfidence` number, float
      - `nickNameConfidence` number, float
      - `fullNameMrzConfidence` number, float
      - `mothersNameConfidence` number, float
      - `fathersNameConfidence` number, float
      - `mothersIdNumberConfidence` number, float
      - `fathersIdNumberConfidence` number, float
      - `spouseNameConfidence` number, float
      - `birthNameConfidence` number, float
      - `addressConfidence` number, float
      - `streetConfidence` number, float
      - `colonyConfidence` number, float
      - `postalCodeConfidence` number, float
      - `cityConfidence` number, float
      - `stateConfidence` number, float
      - `districtConfidence` number, float
      - `stateCodeConfidence` number, float
      - `countryCodeConfidence` number, float
      - `genderConfidence` number, float
      - `issueDateConfidence` number, float
      - `expirationDateConfidence` number, float
      - `issuedAtConfidence` number, float
      - `expireAtConfidence` number, float
      - `issuingAuthorityConfidence` number, float
      - `mrz1Confidence` number, float
      - `mrz2Confidence` number, float
      - `mrz3Confidence` number, float
      - `mrzFullConfidence` number, float
      - `documentNumberConfidence` number, float
      - `backNumberConfidence` number, float
      - `personalNumberConfidence` number, float
      - `nationalNumberConfidence` number, float
      - `claveDeElectorConfidence` number, float
      - `numeroEmisionCredencialConfidence` number, float
      - `curpConfidence` number, float
      - `nueConfidence` number, float
      - `registrationDateConfidence` number, float
      - `heightConfidence` number, float
      - `birthPlaceConfidence` number, float
      - `bloodTypeConfidence` number, float
      - `eyeColorConfidence` number, float
      - `classesConfidence` number, float
      - `condConfidence` number, float
      - `mentionsConfidence` number, float
      - `refNumberConfidence` number, float
      - `weightConfidence` number, float
      - `hairConfidence` number, float
      - `restrictionsConfidence` number, float
      - `nationalityConfidence` number, float
      - `nationalityMrzConfidence` number, float
      - `nationalityAlpha3Confidence` number, float
      - `maritalStatusConfidence` number, float
      - `raceConfidence` number, float
      - `taxIdNumberConfidence` number, float
      - `jurisdictionCodeConfidence` number, float
    - `additionalDocumentAttempts` AdditionalDocumentAttemptDto[]
      - `status` 'SUCCESS' | 'VALIDATION_ERROR' | 'FAIL'
      - `attemptTimestamp` integer
      - `imagesUrl` string[]
      - `attemptType` 'POA' | 'DOCUMENT_CAPTURE'
      - `documentType` string, required
    - `documentSubmissionMethod` 'CAPTURED_DOCUMENT' | 'UPLOADED_FILE' | 'IMPORTED_CREDENTIAL' — Method used to submit the document.
    - `credentialsProvider` 'APPLE' | 'GOOGLE' | 'DIGILOCKER' | 'SAMSUNG' — Credentials provider used when documentSubmissionMethod is IMPORTED_CREDENTIAL.

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.net/incode/apis/incode-omni-api.md) · [All operations](https://skmtc.net/incode/apis/incode-omni-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/incode/incode-omni-api/revisions/30cd6d926ea3/schema)