react-native-scanbot-sdk

import { Field, GenericDocument } from './GenericDocument'; export type DocumentsModelRootType = typeof MRZDocumentType | typeof ParsedDeAddressDocumentType | typeof DeIdCardFrontDocumentType | typeof DeIdCardBackDocumentType | typeof DePassportDocumentType | typeof EuropeanDriverLicenseFrontDocumentType | typeof EuropeanDriverLicenseBackDocumentType | typeof DeResidencePermitFrontDocumentType | typeof DeResidencePermitBackDocumentType | typeof EuropeanHealthInsuranceCardDocumentType | typeof DeHealthInsuranceCardFrontDocumentType | typeof BrIdCardFrontDocumentType | typeof BrIdCardBackDocumentType | typeof BrIdCardFrontPhotoOnlyDocumentType | typeof CnEntryAndExitPermitBackDocumentType | typeof CnEntryAndExitPermitFrontDocumentType | typeof CnPermanentResidentCardFrontDocumentType | typeof HkIdentityCardFrontDocumentType | typeof TwEntryAndExitPermitDocumentType | typeof MoIdentityCardBackDocumentType | typeof MoIdentityCardFrontDocumentType; export declare const MRZDocumentType = "MRZ"; export declare const ParsedDeAddressDocumentType = "ParsedDeAddress"; export declare const DeIdCardFrontDocumentType = "DeIdCardFront"; export declare const DeIdCardBackDocumentType = "DeIdCardBack"; export declare const DePassportDocumentType = "DePassport"; export declare const EuropeanDriverLicenseFrontDocumentType = "EuropeanDriverLicenseFront"; export declare const EuropeanDriverLicenseBackDocumentType = "EuropeanDriverLicenseBack"; export declare const EuropeanDriverLicenseBackCategoryDocumentType = "Category"; export declare const EuropeanDriverLicenseBackCategoriesDocumentType = "Categories"; export declare const EuropeanDriverLicenseBackCategoriesADocumentType = "A"; export declare const EuropeanDriverLicenseBackCategoriesA1DocumentType = "A1"; export declare const EuropeanDriverLicenseBackCategoriesA2DocumentType = "A2"; export declare const EuropeanDriverLicenseBackCategoriesAMDocumentType = "AM"; export declare const EuropeanDriverLicenseBackCategoriesBDocumentType = "B"; export declare const EuropeanDriverLicenseBackCategoriesB1DocumentType = "B1"; export declare const EuropeanDriverLicenseBackCategoriesBEDocumentType = "BE"; export declare const EuropeanDriverLicenseBackCategoriesCDocumentType = "C"; export declare const EuropeanDriverLicenseBackCategoriesC1DocumentType = "C1"; export declare const EuropeanDriverLicenseBackCategoriesC1EDocumentType = "C1E"; export declare const EuropeanDriverLicenseBackCategoriesCEDocumentType = "CE"; export declare const EuropeanDriverLicenseBackCategoriesDDocumentType = "D"; export declare const EuropeanDriverLicenseBackCategoriesD1DocumentType = "D1"; export declare const EuropeanDriverLicenseBackCategoriesD1EDocumentType = "D1E"; export declare const EuropeanDriverLicenseBackCategoriesDEDocumentType = "DE"; export declare const EuropeanDriverLicenseBackCategoriesLDocumentType = "L"; export declare const EuropeanDriverLicenseBackCategoriesTDocumentType = "T"; export declare const DeResidencePermitFrontDocumentType = "DeResidencePermitFront"; export declare const DeResidencePermitBackDocumentType = "DeResidencePermitBack"; export declare const EuropeanHealthInsuranceCardDocumentType = "EuropeanHealthInsuranceCard"; export declare const DeHealthInsuranceCardFrontDocumentType = "DeHealthInsuranceCardFront"; export declare const BrIdCardFrontDocumentType = "BrIdCardFront"; export declare const BrIdCardBackDocumentType = "BrIdCardBack"; export declare const BrIdCardFrontPhotoOnlyDocumentType = "BrIdCardFrontPhotoOnly"; export declare const CnEntryAndExitPermitBackDocumentType = "CnEntryAndExitPermitBack"; export declare const CnEntryAndExitPermitFrontDocumentType = "CnEntryAndExitPermitFront"; export declare const CnPermanentResidentCardFrontDocumentType = "CnPermanentResidentCardFront"; export declare const HkIdentityCardFrontDocumentType = "HkIdentityCardFront"; export declare const TwEntryAndExitPermitDocumentType = "TwEntryAndExitPermit"; export declare const MoIdentityCardBackDocumentType = "MoIdentityCardBack"; export declare const MoIdentityCardFrontDocumentType = "MoIdentityCardFront"; /** MRZ part of the document */ export declare class MRZ { private _document; get document(): GenericDocument; constructor(document: GenericDocument); requiredDocumentType(): string; /** Birth date */ get birthDate(): Field; /** Check digit birth date */ get checkDigitBirthDate(): Field | undefined; /** Check digit document number */ get checkDigitDocumentNumber(): Field | undefined; /** Check digit expiry date */ get checkDigitExpiryDate(): Field | undefined; /** Check digit general */ get checkDigitGeneral(): Field | undefined; /** Check digit personal number */ get checkDigitPersonalNumber(): Field | undefined; /** Date of issuance */ get dateOfIssuance(): Field | undefined; /** Document number */ get documentNumber(): Field | undefined; /** Document type from the DocumentType enum */ get documentType(): Field; /** Document type code */ get documentTypeCode(): Field | undefined; /** Expiry date */ get expiryDate(): Field | undefined; /** Gender */ get gender(): Field | undefined; /** Given names */ get givenNames(): Field; /** Issuing authority */ get issuingAuthority(): Field | undefined; /** Language code */ get languageCode(): Field | undefined; /** Nationality */ get nationality(): Field; /** Office of issuance */ get officeOfIssuance(): Field | undefined; /** TD1 Optional field (line 2) */ get optional1(): Field | undefined; /** TD1 Optional field (line 3) */ get optional2(): Field | undefined; /** PIN code */ get pinCode(): Field | undefined; /** Personal number */ get personalNumber(): Field | undefined; /** Surname */ get surname(): Field; /** Travel document type */ get travelDocType(): Field | undefined; /** Travel document type variant */ get travelDocTypeVariant(): Field | undefined; /** Unknown */ get unknown(): Field | undefined; /** Version number */ get versionNumber(): Field | undefined; /** MRV-A/MRV-B (Travel Visa) Optional field */ get visaOptional(): Field | undefined; } /** Parsed German Address part of the document */ export declare class ParsedDeAddress { private _document; get document(): GenericDocument; constructor(document: GenericDocument); requiredDocumentType(): string; /** District or city area corresponding to postal code */ get district(): Field | undefined; /** Additional information to district or city area (e.g. Ortsteil, Stadtteil) */ get districtAddition(): Field | undefined; /** House number */ get houseNumber(): Field | undefined; /** postal code */ get postalCode(): Field | undefined; /** Street name */ get streetName(): Field | undefined; } /** German ID card, front side */ export declare class DeIdCardFront { private _document; get document(): GenericDocument; constructor(document: GenericDocument); requiredDocumentType(): string; /** Birth date */ get birthDate(): Field; /** Birthplace */ get birthplace(): Field; /** Six digit card access number */ get cardAccessNumber(): Field; /** Expiry date */ get expiryDate(): Field; /** Given names */ get givenNames(): Field; /** Document ID number (in the top-right corner) */ get id(): Field; /** Maiden name */ get maidenName(): Field | undefined; /** Nationality */ get nationality(): Field; /** Photo image */ get photo(): Field; /** Series of the document. The format is YYMM. */ get series(): Field; /** Signature image */ get signature(): Field; /** Surname */ get surname(): Field; } /** German ID card, back side */ export declare class DeIdCardBack { private _document; get document(): GenericDocument; constructor(document: GenericDocument); requiredDocumentType(): string; /** Raw Address text value */ get address(): Field; /** Eye color */ get eyeColor(): Field; /** Height */ get height(): Field; /** Issue date */ get issueDate(): Field; /** Issuing authority */ get issuingAuthority(): Field; /** Pseudonym */ get pseudonym(): Field | undefined; /** Raw MRZ text value */ get rawMRZ(): Field; /** Series of the document. The format is YYMM. */ get series(): Field; /** The child document of type "MRZ". */ get mrz(): MRZ; /** The child document of type "ParsedDeAddress". */ get parsedDeAddress(): ParsedDeAddress; } export declare namespace DeIdCardBack { } /** German travel passport (Reisepass) */ export declare class DePassport { private _document; get document(): GenericDocument; constructor(document: GenericDocument); requiredDocumentType(): string; /** Birth date */ get birthDate(): Field; /** Birthplace */ get birthplace(): Field; /** Country code */ get countryCode(): Field; /** Expiry date */ get expiryDate(): Field; /** Gender */ get gender(): Field; /** Given names */ get givenNames(): Field; /** Document ID number (in the top-right corner) */ get id(): Field; /** Issue date */ get issueDate(): Field; /** Issuing authority */ get issuingAuthority(): Field; /** Maiden name */ get maidenName(): Field | undefined; /** Nationality */ get nationality(): Field; /** Passport type */ get passportType(): Field; /** Photo image */ get photo(): Field; /** Raw MRZ text value */ get rawMRZ(): Field; /** Signature image */ get signature(): Field; /** Surname */ get surname(): Field; /** The child document of type "MRZ". */ get mrz(): MRZ; } export declare namespace DePassport { } /** European driver license, front side */ export declare class EuropeanDriverLicenseFront { private _document; get document(): GenericDocument; constructor(document: GenericDocument); requiredDocumentType(): string; /** Address (Field 8.) */ get address(): Field | undefined; /** Administrative number (Field 10.) */ get administrativeNumber(): Field | undefined; /** Barcode */ get barcode(): Field | undefined; /** Birth date (Field 3.) */ get birthDate(): Field; /** Birthplace (Field 3.) */ get birthplace(): Field | undefined; /** Citizenship (Field 4f.) */ get citizenship(): Field | undefined; /** Country of the driver license */ get country(): Field; /** Expiry date (Field 4b.) */ get expiryDate(): Field; /** Gender (Field 4e.) */ get gender(): Field | undefined; /** Given names (Field 2.) */ get givenNames(): Field; /** Document ID number (in the top-right corner, Field 5.) */ get id(): Field; /** Issue date (Field 4a.) */ get issueDate(): Field | undefined; /** Issuing authority (Field 4c.) */ get issuingAuthority(): Field | undefined; /** Driver's license categories (Field 9.) */ get licenseCategories(): Field | undefined; /** MRZ part of the document */ get mrz(): Field | undefined; /** Photo image */ get photo(): Field; /** Restrictions applied for the driver's license (Field 12.) */ get restrictions(): Field | undefined; /** Serial number (Field 5b. on Driver Qualification Card) */ get serialNumber(): Field | undefined; /** Signature image (Field 7.) */ get signature(): Field; /** Surname (Field 1.) */ get surname(): Field; } /** European driver license, back side */ export declare class EuropeanDriverLicenseBack { private _document; get document(): GenericDocument; constructor(document: GenericDocument); requiredDocumentType(): string; /** Country of the driver license */ get country(): Field; /** Restrictions applied for the driver's license (Field 12.) */ get restrictions(): Field | undefined; /** The child document of type "Categories". */ get categories(): EuropeanDriverLicenseBack.Categories; } export declare namespace EuropeanDriverLicenseBack { /** A category row from the categories table */ abstract class Category { private _document; get document(): GenericDocument; constructor(document: GenericDocument); abstract requiredDocumentType(): string; /** Restrictions (Column 12.) */ get restrictions(): Field | undefined; /** Valid from (Column 10.) */ get validFrom(): Field | undefined; /** Valid until (Column 11.) */ get validUntil(): Field | undefined; } /** Categories table row container */ class Categories { private _document; get document(): GenericDocument; constructor(document: GenericDocument); requiredDocumentType(): string; /** The child document of type "A". */ get a(): EuropeanDriverLicenseBack.Categories.A; /** The child document of type "A1". */ get a1(): EuropeanDriverLicenseBack.Categories.A1; /** The child document of type "A2". */ get a2(): EuropeanDriverLicenseBack.Categories.A2; /** The child document of type "AM". */ get am(): EuropeanDriverLicenseBack.Categories.AM; /** The child document of type "B". */ get b(): EuropeanDriverLicenseBack.Categories.B; /** The child document of type "B1". */ get b1(): EuropeanDriverLicenseBack.Categories.B1 | undefined; /** The child document of type "BE". */ get be(): EuropeanDriverLicenseBack.Categories.BE; /** The child document of type "C". */ get c(): EuropeanDriverLicenseBack.Categories.C; /** The child document of type "C1". */ get c1(): EuropeanDriverLicenseBack.Categories.C1; /** The child document of type "C1E". */ get c1E(): EuropeanDriverLicenseBack.Categories.C1E; /** The child document of type "CE". */ get ce(): EuropeanDriverLicenseBack.Categories.CE; /** The child document of type "D". */ get d(): EuropeanDriverLicenseBack.Categories.D; /** The child document of type "D1". */ get d1(): EuropeanDriverLicenseBack.Categories.D1; /** The child document of type "D1E". */ get d1E(): EuropeanDriverLicenseBack.Categories.D1E; /** The child document of type "DE". */ get de(): EuropeanDriverLicenseBack.Categories.DE; /** The child document of type "L". */ get l(): EuropeanDriverLicenseBack.Categories.L; /** The child document of type "T". */ get t(): EuropeanDriverLicenseBack.Categories.T; } namespace Categories { /** EuropeanDriverLicenseBack.Categories.A */ class A extends Category { constructor(document: GenericDocument); requiredDocumentType(): string; } /** EuropeanDriverLicenseBack.Categories.A1 */ class A1 extends Category { constructor(document: GenericDocument); requiredDocumentType(): string; } /** EuropeanDriverLicenseBack.Categories.A2 */ class A2 extends Category { constructor(document: GenericDocument); requiredDocumentType(): string; } /** EuropeanDriverLicenseBack.Categories.AM */ class AM extends Category { constructor(document: GenericDocument); requiredDocumentType(): string; } /** EuropeanDriverLicenseBack.Categories.B */ class B extends Category { constructor(document: GenericDocument); requiredDocumentType(): string; } /** EuropeanDriverLicenseBack.Categories.B1 */ class B1 extends Category { constructor(document: GenericDocument); requiredDocumentType(): string; } /** EuropeanDriverLicenseBack.Categories.BE */ class BE extends Category { constructor(document: GenericDocument); requiredDocumentType(): string; } /** EuropeanDriverLicenseBack.Categories.C */ class C extends Category { constructor(document: GenericDocument); requiredDocumentType(): string; } /** EuropeanDriverLicenseBack.Categories.C1 */ class C1 extends Category { constructor(document: GenericDocument); requiredDocumentType(): string; } /** EuropeanDriverLicenseBack.Categories.C1E */ class C1E extends Category { constructor(document: GenericDocument); requiredDocumentType(): string; } /** EuropeanDriverLicenseBack.Categories.CE */ class CE extends Category { constructor(document: GenericDocument); requiredDocumentType(): string; } /** EuropeanDriverLicenseBack.Categories.D */ class D extends Category { constructor(document: GenericDocument); requiredDocumentType(): string; } /** EuropeanDriverLicenseBack.Categories.D1 */ class D1 extends Category { constructor(document: GenericDocument); requiredDocumentType(): string; } /** EuropeanDriverLicenseBack.Categories.D1E */ class D1E extends Category { constructor(document: GenericDocument); requiredDocumentType(): string; } /** EuropeanDriverLicenseBack.Categories.DE */ class DE extends Category { constructor(document: GenericDocument); requiredDocumentType(): string; } /** EuropeanDriverLicenseBack.Categories.L */ class L extends Category { constructor(document: GenericDocument); requiredDocumentType(): string; } /** EuropeanDriverLicenseBack.Categories.T */ class T extends Category { constructor(document: GenericDocument); requiredDocumentType(): string; } } } /** German Residence Permit (Aufenthaltstitel), Front side */ export declare class DeResidencePermitFront { private _document; get document(): GenericDocument; constructor(document: GenericDocument); requiredDocumentType(): string; /** Birth date (Geburtsdatum) */ get birthDate(): Field | undefined; /** Six digit card access number */ get cardAccessNumber(): Field; /** Expiry date (Gültig bis) */ get expiryDate(): Field; /** Gender (Geschlecht) */ get gender(): Field | undefined; /** Given names */ get givenNames(): Field; /** Document ID number (in the top-right corner) */ get id(): Field; /** Nationality (Staatsangehörigkeit) */ get nationality(): Field | undefined; /** Photo image */ get photo(): Field; /** Place of issue (Ausstellungsort) */ get placeOfIssue(): Field | undefined; /** Remarks (Anmerkungen) */ get remarks(): Field; /** Signature image */ get signature(): Field; /** Surname */ get surname(): Field; /** Title type (Art des Titels) */ get titleType(): Field; /** Valid from date (Gültig ab) */ get validFrom(): Field | undefined; } /** German Residence Permit (Aufenthaltstitel), Back side */ export declare class DeResidencePermitBack { private _document; get document(): GenericDocument; constructor(document: GenericDocument); requiredDocumentType(): string; /** Address (Anschrift) */ get address(): Field; /** Birth date (Geburtsdatum) */ get birthDate(): Field | undefined; /** Birthplace (Geburtsort) */ get birthplace(): Field; /** Eye color (Augenfarbe) */ get eyeColor(): Field; /** Gender (Geschlecht) */ get gender(): Field | undefined; /** Height (Größe) */ get height(): Field; /** Issuing authority (Ausländerbehörde) */ get issuingAuthority(): Field; /** Nationality (Staatsangehörigkeit) */ get nationality(): Field | undefined; /** Raw MRZ text value */ get rawMRZ(): Field; /** Remarks (Anmerkungen) */ get remarks(): Field | undefined; /** The child document of type "MRZ". */ get mrz(): MRZ; /** The child document of type "ParsedDeAddress". */ get parsedDeAddress(): ParsedDeAddress; } export declare namespace DeResidencePermitBack { } /** European Health Insurance Card (EHIC). Supports formats with both four and five lines of data. */ export declare class EuropeanHealthInsuranceCard { private _document; get document(): GenericDocument; constructor(document: GenericDocument); requiredDocumentType(): string; /** Barcode image (only present in some formats) */ get barcode(): Field | undefined; /** Birth date */ get birthDate(): Field; /** Card number */ get cardNumber(): Field; /** Country code (ISO 3166-1 alpha-2) */ get countryCode(): Field; /** Expiry date */ get expiryDate(): Field; /** Given names */ get givenNames(): Field; /** Issuer name */ get issuerName(): Field; /** Issuer number */ get issuerNumber(): Field; /** Personal number */ get personalNumber(): Field; /** Signature image */ get signature(): Field | undefined; /** Surname */ get surname(): Field; } /** Front side of the German health insurance card (elektronische Gesundheitskarte). For the backside, see EuropeanHealthInsuranceCard. */ export declare class DeHealthInsuranceCardFront { private _document; get document(): GenericDocument; constructor(document: GenericDocument); requiredDocumentType(): string; /** Six digit card access number */ get cardAccessNumber(): Field | undefined; /** Issuer name */ get issuerName(): Field; /** Issuer number (Versicherung bzw. Kennnummer des Trägers) */ get issuerNumber(): Field; /** Full name with title */ get name(): Field; /** Personal number (Versichertennummer) */ get personalNumber(): Field; } /** Brazilian National Identity Card (Registro Geral) */ export declare class BrIdCardFront { private _document; get document(): GenericDocument; constructor(document: GenericDocument); requiredDocumentType(): string; /** Código de Barras - Barcode */ get barcode(): Field | undefined; /** Birth date */ get birthDate(): Field; /** Birthplace */ get birthplace(): Field; /** Tipo Sanguíneo/Fator RH - Blood type and RH factor */ get bloodType(): Field | undefined; /** Dados do Registro Civil - Civil Registry Details */ get civilRegistryDetails(): Field | undefined; /** CNH (Carteira Nacional de Habilitação) - Driver’s license number */ get driverLicenseNumber(): Field | undefined; /** Expiry date */ get expiryDate(): Field | undefined; /** Polegar Direito - Right thumbprint */ get fingerprint(): Field | undefined; /** Gender */ get gender(): Field | undefined; /** Given names */ get givenNames(): Field; /** CNS (Cartão Nacional de Saúde) - National Health Card number */ get healthCardNumber(): Field | undefined; /** DNI (Documento Nacional de Identidade) - National Identity Document number */ get id(): Field | undefined; /** Data de Expedição - Date the document was issued */ get issueDate(): Field | undefined; /** Órgão Expedidor - Issuing Authority */ get issuingAuthority(): Field | undefined; /** Assinatura do Diretor - Signature of the issuing authority */ get issuingAuthoritySignature(): Field | undefined; /** Certificado Militar - Military certificate number */ get militaryCertificateNumber(): Field | undefined; /** Nacionalidade - Nationality */ get nationality(): Field | undefined; /** Observações - Observations */ get observations(): Field | undefined; /** Pais - Parents */ get parents(): Field | undefined; /** Registro Geral (RG) - General Registration number, main ID number */ get personalNumber(): Field | undefined; /** Photo image */ get photo(): Field | undefined; /** Local de Emissão - Place of Issue */ get placeOfIssue(): Field | undefined; /** Identidade Profissional - Professional identity number */ get professionalIdentityNumber(): Field | undefined; /** Assinatura - Signature */ get signature(): Field; /** NIS/PIS/PASEP - Social Security and Employment benefits number */ get socialSecurityNumber(): Field | undefined; /** UF - Brazilian state code for the Work Card */ get stateCode(): Field | undefined; /** Surname */ get surname(): Field | undefined; /** CPF (Cadastro de Pessoas Físicas) - Brazilian taxpayer number */ get taxpayerNumber(): Field | undefined; /** Título de Eleitor - Voter registration number */ get voterRegistrationNumber(): Field | undefined; /** CTPS (Carteira de Trabalho e Previdência Social) - Work Card number */ get workCardNumber(): Field | undefined; /** Série - Series number associated with the Work Card */ get workCardSeries(): Field | undefined; } /** Brazilian National Identity Card (Registro Geral), back side */ export declare class BrIdCardBack { private _document; get document(): GenericDocument; constructor(document: GenericDocument); requiredDocumentType(): string; /** Barcode */ get barcode(): Field | undefined; /** Date of Birth */ get birthDate(): Field | undefined; /** Birthplace */ get birthplace(): Field | undefined; /** Dados do Registro Civil - Civil Registry Details */ get civilRegistryDetails(): Field | undefined; /** CNH (Carteira Nacional de Habilitação) - Driver’s license number */ get driverLicenseNumber(): Field | undefined; /** Expiry Date */ get expiryDate(): Field | undefined; /** Fingerprint */ get fingerprint(): Field | undefined; /** Given Names */ get givenNames(): Field | undefined; /** CNS (Cartão Nacional de Saúde) - National Health Card number */ get healthCardNumber(): Field | undefined; /** DNI (Documento Nacional de Identidade) - National Identity Document number */ get id(): Field | undefined; /** Issue Date */ get issueDate(): Field; /** Órgão Expedidor - Issuing Authority */ get issuingAuthority(): Field | undefined; /** Certificado Militar - Military certificate number */ get militaryCertificateNumber(): Field | undefined; /** Page Number of the document */ get pageNumber(): Field | undefined; /** Filiação - Parents */ get parents(): Field | undefined; /** Registro Geral (RG) - General Registration number, main ID number */ get personalNumber(): Field | undefined; /** Photo */ get photo(): Field | undefined; /** Local de Emissão - Place where the identity card was issued */ get placeOfIssue(): Field | undefined; /** Naturalidade - Place of Origin */ get placeOfOrigin(): Field | undefined; /** Identidade Profissional - Professional identity number */ get professionalIdentityNumber(): Field | undefined; /** Raw MRZ text value */ get rawMRZ(): Field | undefined; /** Assinatura - Signature */ get signature(): Field | undefined; /** NIS/PIS/PASEP - Social Security and Employment benefits number */ get socialSecurityNumber(): Field | undefined; /** UF - Brazilian state code related to the Work Card */ get stateCode(): Field | undefined; /** CPF (Cadastro de Pessoas Físicas) - Brazilian taxpayer number */ get taxpayerNumber(): Field | undefined; /** Título de Eleitor - Voter registration number */ get voterRegistrationNumber(): Field | undefined; /** CTPS (Carteira de Trabalho e Previdência Social) - Work Card number */ get workCardNumber(): Field | undefined; /** Série - Series number associated with the Work Card */ get workCardSeries(): Field | undefined; /** The child document of type "MRZ". */ get mrz(): MRZ; } export declare namespace BrIdCardBack { } /** BrIdCardFrontPhotoOnly */ export declare class BrIdCardFrontPhotoOnly { private _document; get document(): GenericDocument; constructor(document: GenericDocument); requiredDocumentType(): string; /** Fingerprint */ get fingerprint(): Field; /** Photo */ get photo(): Field; } /** CnEntryAndExitPermitBack */ export declare class CnEntryAndExitPermitBack { private _document; get document(): GenericDocument; constructor(document: GenericDocument); requiredDocumentType(): string; /** Barcode on the bottom of the document */ get barcodeBottom(): Field | undefined; /** Barcode on the top of the document */ get barcodeTop(): Field | undefined; /** Hong Kong Valid From Date */ get hongKongValidFrom(): Field | undefined; /** Hong Kong Valid Until Date */ get hongKongValidUntil(): Field | undefined; /** Macao Valid From Date */ get macaoValidFrom(): Field | undefined; /** Macao Valid Until Date */ get macaoValidUntil(): Field | undefined; /** Raw MRZ text value */ get rawMRZ(): Field | undefined; /** Taiwan Identification Number */ get taiwanIDNumber(): Field | undefined; /** The child document of type "MRZ". */ get mrz(): MRZ; } export declare namespace CnEntryAndExitPermitBack { } /** CnEntryAndExitPermitFront */ export declare class CnEntryAndExitPermitFront { private _document; get document(): GenericDocument; constructor(document: GenericDocument); requiredDocumentType(): string; /** Date of Birth */ get birthDate(): Field; /** Business Type */ get business(): Field | undefined; /** Destinations */ get destinations(): Field | undefined; /** Gender */ get gender(): Field | undefined; /** Given Names */ get givenNames(): Field; /** Identity Document Number */ get id(): Field; /** Date when the permit was issued */ get issueDate(): Field | undefined; /** MRZ text value */ get mrzLine(): Field | undefined; /** Photo */ get photo(): Field; /** Place where the permit was issued */ get placeOfIssue(): Field | undefined; /** Ports where the cardholder can enter or exit */ get portsOfExitAndEntry(): Field | undefined; /** Raw MRZ text value */ get rawMRZ(): Field | undefined; /** Number of times the cardholder has exited or entered */ get timesOfExitAndEntry(): Field | undefined; /** Start date of the permit validity */ get validFrom(): Field; /** End date of the permit validity */ get validUntil(): Field; /** The child document of type "MRZ". */ get mrz(): MRZ; } export declare namespace CnEntryAndExitPermitFront { } /** CnPermanentResidentCardFront */ export declare class CnPermanentResidentCardFront { private _document; get document(): GenericDocument; constructor(document: GenericDocument); requiredDocumentType(): string; /** Date of Birth */ get birthDate(): Field; /** Gender */ get gender(): Field; /** Given Names */ get givenNames(): Field; /** Identity Document Number */ get id(): Field; /** Authority issuing the card */ get issuingAuthority(): Field | undefined; /** Nationality */ get nationality(): Field; /** Photo */ get photo(): Field; /** Start date of the validity of the card */ get validFrom(): Field; /** End date of the validity of the card */ get validUntil(): Field; } /** HkIdentityCardFront */ export declare class HkIdentityCardFront { private _document; get document(): GenericDocument; constructor(document: GenericDocument); requiredDocumentType(): string; /** Date of Birth */ get birthDate(): Field; /** Gender */ get gender(): Field; /** Given Names */ get givenNames(): Field; /** Given Names represented in Chinese code */ get givenNamesInChineseCode(): Field; /** Identity Document Number */ get id(): Field; /** ID Symbols */ get idSymbols(): Field; /** Date when the cardholder was initially registered */ get initialRegistrationDate(): Field; /** Date when the identity card was issued */ get issueDate(): Field; /** Photo */ get photo(): Field; } /** TwEntryAndExitPermit */ export declare class TwEntryAndExitPermit { private _document; get document(): GenericDocument; constructor(document: GenericDocument); requiredDocumentType(): string; /** Barcode on the left of the document */ get barcodeLeft(): Field | undefined; /** Barcode on the right of the document */ get barcodeRight(): Field | undefined; /** Date of Birth */ get birthDate(): Field; /** Country Code */ get countryCode(): Field | undefined; /** Country of Residency */ get countryOfResidency(): Field | undefined; /** Document Type */ get documentType(): Field | undefined; /** Entry inspection information */ get entryInspection(): Field | undefined; /** Exit inspection information */ get exitInspection(): Field | undefined; /** Expiry Date of the permit */ get expiryDate(): Field; /** Gender */ get gender(): Field; /** Given Names */ get givenNames(): Field | undefined; /** Identity Document Number */ get id(): Field; /** Date when the permit was issued */ get issueDate(): Field; /** Passport Number */ get passportNumber(): Field | undefined; /** Personal number */ get personalNumber(): Field; /** Photograph */ get photo(): Field; /** Raw MRZ text value */ get rawMRZ(): Field | undefined; /** Remarks section of the permit */ get remarks(): Field | undefined; /** The child document of type "MRZ". */ get mrz(): MRZ; } export declare namespace TwEntryAndExitPermit { } /** MoIdentityCardBack */ export declare class MoIdentityCardBack { private _document; get document(): GenericDocument; constructor(document: GenericDocument); requiredDocumentType(): string; /** Raw MRZ text value */ get rawMRZ(): Field; /** Validation Photo */ get validationPhoto(): Field; /** The child document of type "MRZ". */ get mrz(): MRZ; } export declare namespace MoIdentityCardBack { } /** MoIdentityCardFront */ export declare class MoIdentityCardFront { private _document; get document(): GenericDocument; constructor(document: GenericDocument); requiredDocumentType(): string; /** Date of Birth */ get birthDate(): Field; /** Gender */ get gender(): Field; /** Given Names */ get givenNames(): Field; /** Identity Document Number */ get id(): Field; /** Photo */ get photo(): Field; /** Signature */ get signature(): Field; /** Surname */ get surname(): Field; /** Start date of the card validity */ get validFrom(): Field; /** End date of the card validity */ get validUntil(): Field; /** Validation photo */ get validationPhoto(): Field; } //# sourceMappingURL=DocumentsModel.d.ts.map