{ "unified_schema": { "description": "Schema supported by all document types, except for the ones listed under specific_document_schemas. Each field is returned only when the document carries it and the extraction engine reads it, so any given response contains a subset of these fields.", "fields": { "number": "Document number as printed on the document.", "identifier": "National identification number of the holder. Digits only.", "fullName": "Full name of the holder.", "firstName": "Given name(s) of the holder.", "lastName": "Family name(s) of the holder.", "gender": "Sex of the holder, as printed on the document.", "filiation": "Array of parents' names. Mother first, then father, when both are extracted.", "naturality": "Place of birth of the holder. Same source as placeOfBirth.", "address": "Residential address of the holder.", "placeOfBirth": "Place of birth of the holder. Same source as naturality.", "placeOfIssue": "Place where the document was issued. Reserved in the schema; not currently populated by the extraction engine.", "countryOfIssue": "Country that issued the document, taken from the document classification. Same source as classCountry.", "dateOfBirth": "Date of birth. RFC 3339 timestamp in UTC.", "dateOfExpiry": "Expiration date of the document. RFC 3339 timestamp in UTC.", "dateOfIssue": "Issue date of the document. RFC 3339 timestamp in UTC.", "issuingAuthority": "Authority that issued the document.", "mrzCode": "Raw machine-readable zone (MRZ) as read from the document. Returned only for documents that carry an MRZ.", "mrzData": "Parsed machine-readable zone (MRZ) data. Reserved in the schema; not currently populated by the extraction engine — the mrz* fields below carry the parsed values.", "middleName": "Middle name(s) of the holder.", "additionalNameInformation": "Additional name information printed on the document, such as a suffix or an alternate spelling.", "localizedName": "Holder's name in the document's local script, when it differs from the Latin transliteration.", "maidenName": "Maiden name of the holder.", "husbandName": "Husband's name, on documents that print it.", "mothersName": "Mother's name, as printed on the document.", "fathersName": "Father's name, as printed on the document.", "parentsFirstName": "Given name(s) of the holder's parents, on documents that print them as a single combined field.", "parentsLastName": "Family name(s) of the holder's parents, on documents that print them as a single combined field.", "personalIdNumber": "National identification number of the holder, as printed. Complements identifier: it preserves letters and separators, so it is the complete value for countries whose national ID is alphanumeric.", "documentAdditionalNumber": "Secondary document number printed on the document.", "documentOptionalAdditionalNumber": "Third document number, on documents that print more than two.", "additionalPersonalIdNumber": "Secondary personal identification number of the holder.", "nationalInsuranceNumber": "National insurance or social insurance number of the holder.", "certificateNumber": "Certificate number printed on the document.", "cardAccessNumber": "Card access number (CAN) used to access the document's electronic chip.", "socialSecurityNumber": "Social security number of the holder.", "documentSubtype": "Subtype of the document, when the issuer defines more than one variant of the same type.", "remarks": "Free-text remarks or observations printed on the document.", "residencePermitType": "Type of residence permit, on residence permit documents.", "specificDocumentValidity": "Validity qualifier printed on the document, when it restricts where or for what the document is valid.", "eligibilityCategory": "Eligibility category printed on the document.", "legalStatus": "Legal status of the holder, as printed on the document.", "socialSecurityStatus": "Social security status of the holder, as printed on the document.", "residentialStatus": "Residential status of the holder, as printed on the document.", "maritalStatus": "Marital status of the holder, as printed on the document.", "expiryIsPermanent": "Boolean. true when the document is printed as never expiring.", "visaType": "Type of visa, on visa documents.", "sponsor": "Sponsor named on the document, on visa and residence documents.", "numberOfEntries": "Number of entries the visa permits.", "durationOfStay": "Duration of stay the visa permits.", "dateOfEntry": "Date of entry. RFC 3339 timestamp in UTC.", "effectiveDate": "Date the document becomes effective. RFC 3339 timestamp in UTC.", "nationality": "Nationality of the holder, as printed on the document. For the three-letter ICAO code read from the machine-readable zone, see mrzNationality.", "race": "Race of the holder, on documents that print it.", "religion": "Religion of the holder, on documents that print it.", "profession": "Profession of the holder, on documents that print it.", "employer": "Employer of the holder, on documents that print it.", "bloodType": "Blood type of the holder, on documents that print it.", "additionalAddressInformation": "Additional address information printed on the document.", "additionalOptionalAddressInformation": "Further address information, on documents that print more than two address blocks.", "addressStreet": "Street component of the holder's address.", "addressCity": "City component of the holder's address.", "addressPostalCode": "Postal code component of the holder's address.", "addressJurisdiction": "Jurisdiction (state or province) component of the holder's address.", "countryCode": "Country code printed on the document.", "stateName": "Name of the issuing state or province.", "stateCode": "Code of the issuing state or province.", "localityCode": "Locality code of the holder's registration.", "municipalityCode": "Municipality code of the holder's registration.", "municipalityOfRegistration": "Municipality where the holder is registered.", "pollingStationCode": "Polling station code, on electoral documents.", "registrationCenterCode": "Registration center code, on electoral documents.", "sectionCode": "Electoral section code, on electoral documents.", "vehicleClass": "Vehicle class of the licence's first class entry.", "licenceType": "Licence type of the licence's first class entry.", "classEffectiveDate": "Date the first class entry became effective. RFC 3339 timestamp in UTC.", "classExpiryDate": "Expiration date of the first class entry. RFC 3339 timestamp in UTC.", "restrictions": "Restrictions printed on the licence.", "endorsements": "Endorsements printed on the licence.", "conditions": "Conditions printed on the licence.", "vehicleType": "Type of vehicle the licence covers.", "vehicleOwner": "Owner of the vehicle, on documents that print it.", "manufacturingYear": "Manufacturing year of the vehicle, on documents that print it.", "workRestriction": "Work restriction printed on the document.", "additionalVehicleClass": "Vehicle class of the licence's second class entry. Class entries beyond the second are not returned.", "additionalLicenceType": "Licence type of the licence's second class entry.", "additionalClassEffectiveDate": "Date the second class entry became effective. RFC 3339 timestamp in UTC.", "additionalConditions": "Conditions attached to the licence's second class entry. Reserved in the schema; not currently populated by the extraction engine.", "additionalClassExpiryDate": "Expiration date of the second class entry. RFC 3339 timestamp in UTC.", "dependentFullName": "Full name of the first dependent listed. Dependents beyond the first are not returned.", "dependentDateOfBirth": "Date of birth of the first dependent listed. RFC 3339 timestamp in UTC.", "dependentSex": "Sex of the first dependent listed, as printed on the document.", "dependentDocumentNumber": "Document number of the first dependent listed.", "classCountry": "Country the document was classified as. Same source as countryOfIssue.", "classRegion": "Region or state the document was classified as, for documents issued sub-nationally.", "classType": "Document type the document was classified as.", "isoAlpha2CountryCode": "ISO 3166-1 alpha-2 code of the issuing country.", "isoAlpha3CountryCode": "ISO 3166-1 alpha-3 code of the issuing country.", "isoNumericCountryCode": "ISO 3166-1 numeric code of the issuing country.", "mrzDocumentCode": "Document code from the machine-readable zone.", "mrzDocumentNumber": "Document number from the machine-readable zone. Read only from the MRZ, so it can be compared against number, which is read by OCR.", "mrzDocumentType": "Document type derived from the machine-readable zone.", "mrzIssuer": "Issuing authority code from the machine-readable zone.", "mrzIssuerName": "Issuing authority name resolved from the machine-readable zone issuer code.", "mrzNationality": "Three-letter ICAO nationality code from the machine-readable zone.", "mrzNationalityName": "Nationality name resolved from the machine-readable zone nationality code.", "mrzGender": "Sex from the machine-readable zone. Read only from the MRZ, so it can be compared against gender, which is read by OCR.", "mrzOpt1": "First optional data field of the machine-readable zone.", "mrzOpt2": "Second optional data field of the machine-readable zone.", "mrzPrimaryId": "Primary identifier (family name) from the machine-readable zone.", "mrzSecondaryId": "Secondary identifier (given names) from the machine-readable zone.", "mrzDateOfBirth": "Date of birth from the machine-readable zone. RFC 3339 timestamp in UTC.", "mrzDateOfExpiry": "Expiration date from the machine-readable zone. RFC 3339 timestamp in UTC.", "barcodePayload": "Raw payload of the document's barcode. Reserved in the schema; not currently populated by the extraction engine." } }, "specific_document_schemas": { "description": "Existing document-specific contracts preserved for backward compatibility.", "by_document_type": { "unico.moja.dictionary.br.cnh.v2.Cnh": { "numero": "Driver's license registration number.", "rgNumero": "RG number printed on the license.", "cpfNumero": "CPF of the holder. Digits only, validated before being returned.", "nomeCivil": "Full civil name of the holder.", "filiacao": "Array of parents' names. Mother first, then father, when both are extracted.", "dataNascimento": "Date of birth. RFC 3339 timestamp in UTC.", "dataHabilitacao": "Date the holder was first licensed. RFC 3339 timestamp in UTC.", "dataExpiracao": "Expiration date of the license. RFC 3339 timestamp in UTC.", "dataEmissao": "Issue date of the license. RFC 3339 timestamp in UTC.", "localEmissao": "Place where the license was issued.", "categoria": "License category, for example A, B or AB.", "renachNumero": "RENACH number." }, "unico.moja.dictionary.br.rg.v2.Rg": { "numero": "RG number.", "orgaoEmissor": "Issuing authority, for example SSP.", "ufEmissor": "Issuing state, returned as the UF enum name, for example UF_SP. Omitted when the state could not be identified.", "cpfNumero": "CPF of the holder. Digits only, validated before being returned.", "carteiraProfissionalNumero": "Professional card number.", "certificadoMilitarNumero": "Military certificate number.", "cnsNumero": "CNS (national health card) number.", "nisPisPasepNumero": "NIS/PIS/PASEP number.", "ctpsNumero": "Work card (CTPS) number.", "ctpsSerie": "Work card (CTPS) series.", "ctpsUf": "Work card (CTPS) state, returned as the UF enum name, for example UF_SP.", "tituloEleitorNumero": "Voter registration number.", "nomeCivil": "Full civil name of the holder.", "nomeSocial": "Social name of the holder.", "filiacao": "Array of parents' names. Mother first, then father, when both are extracted.", "dataNascimento": "Date of birth. RFC 3339 timestamp in UTC.", "dataEmissao": "Issue date of the document. RFC 3339 timestamp in UTC.", "naturalidade": "Place of birth of the holder. Falls back to the issuing country when not printed.", "sexo": "Sex of the holder, as printed on the document." }, "unico.moja.dictionary.br.cin.v1.Cin": { "rgNumero": "RG number. Not populated for CIN — the document number is the CPF, returned in cpfNumero.", "cpfNumero": "CPF of the holder. Digits only, validated before being returned.", "nomeCivil": "Full civil name of the holder.", "nomeSocial": "Social name of the holder.", "filiacao": "Array of parents' names. Mother first, then father, when both are extracted.", "dataNascimento": "Date of birth. RFC 3339 timestamp in UTC.", "dataExpiracao": "Expiration date of the document. RFC 3339 timestamp in UTC.", "dataEmissao": "Issue date of the document. RFC 3339 timestamp in UTC.", "orgaoEmissor": "Issuing authority.", "localEmissao": "Place where the document was issued, derived from the issuing state.", "naturalidade": "Place of birth of the holder.", "nacionalidade": "Nationality of the holder." }, "unico.moja.dictionary.br.passaporte.v1.Passaporte": { "numero": "Passport number. Read from the machine-readable zone when available.", "nome": "Given name(s) of the holder. Falls back to the full name when the name is not split on the document.", "sobrenome": "Family name(s) of the holder.", "paisEmissor": "Issuing country.", "nacionalidade": "Nationality of the holder, read from the machine-readable zone.", "naturalidade": "Place of birth of the holder.", "filiacao": "Array of parents' names. Supported by the schema but not currently extracted for Brazilian passports.", "dataNascimento": "Date of birth. RFC 3339 timestamp in UTC. Read from the machine-readable zone when available.", "dataEmissao": "Issue date of the passport. RFC 3339 timestamp in UTC.", "dataExpiracao": "Expiration date of the passport. RFC 3339 timestamp in UTC.", "autoridade": "Authority that issued the passport.", "cpfNumero": "CPF of the holder. Digits only, validated before being returned.", "sexo": "Sex of the holder, as printed on the document." }, "unico.moja.dictionary.mx.ine.v1.Ine": { "claveElector": "Clave de elector, the 18-character voter key. Omitted when it fails format validation.", "curp": "CURP (Clave Única de Registro de Población). Omitted when it fails format or check-digit validation.", "nombre": "Full name of the holder, normalized to given name followed by surnames.", "sexo": "Sex of the holder, as printed on the credential.", "fechaNacimiento": "Date of birth. RFC 3339 timestamp in UTC.", "anoRegistro": "Year the holder registered with the electoral roll.", "domicilio": "Residential address of the holder. Line breaks are normalized to spaces.", "estado": "State code of the holder's electoral district.", "municipio": "Municipality code of the holder's electoral district.", "seccion": "Electoral section number.", "localidad": "Locality code of the holder's electoral district.", "emision": "Year the credential was issued, as a four-digit string.", "vigencia": "Year through which the credential is valid, as a four-digit string.", "cic": "CIC (Código Identificador de Credencial). Derived from the machine-readable zone when present.", "ocr": "OCR number printed on the back of the credential. Derived from the machine-readable zone when present.", "mrz": "Raw machine-readable zone of the credential, with line breaks and spaces removed." }, "unico.moja.dictionary.mx.lpc.v1.Lpc": { "numero": "License number.", "tipo": "License type.", "nombre": "Full name of the holder.", "curp": "CURP (Clave Única de Registro de Población).", "sexo": "Sex of the holder, as printed on the license.", "fechaNacimiento": "Date of birth. RFC 3339 timestamp in UTC.", "fechaExpedicion": "Issue date of the license. RFC 3339 timestamp in UTC." }, "unico.moja.dictionary.mx.pasaporte.v1.Pasaporte": { "numero": "Passport number.", "tipo": "Passport type.", "nombres": "Given name(s) of the holder.", "apellidos": "Family name(s) of the holder.", "curp": "CURP (Clave Única de Registro de Población).", "sexo": "Sex of the holder, as printed on the passport.", "fechaNacimiento": "Date of birth. RFC 3339 timestamp in UTC.", "fechaCaducidad": "Expiration date of the passport. RFC 3339 timestamp in UTC.", "fechaExpedicion": "Issue date of the passport. RFC 3339 timestamp in UTC.", "lugarNacimiento": "Place of birth of the holder.", "nacionalidad": "Nationality of the holder.", "paisExpedicion": "Issuing country." } } } }