scanbot-web-sdk 8.1.0-alpha.1 → 8.1.0-beta.2

package/@types/core/compiled/DocumentQualityAnalyzerTypes.d.ts

@@ -53,6 +53,44 @@ export declare class DocumentQualityThreshold {
     constructor(source?: DeepPartial<DocumentQualityThreshold>);
 }
 /**
+Configuration for processing image by tiles.
+This can be used to make the document quality analyzer processing faster with lower memory consumption,
+but prediction can be less accurate.
+*/
+export declare class ProcessByTileConfiguration {
+    /**
+    Enable processing by tiles.
+    @defaultValue true;
+    */
+    enabled: boolean;
+    /**
+    At least this fraction of the image will be processed, range is from 0 to 1.
+    Decreasing this value below 1.0 can lead to faster processing but may result in
+    less accurate prediction, as only a subset of the image tiles will be analyzed.
+    @defaultValue 1.0;
+    */
+    minProcessedFraction: number;
+    /**
+    At most this fraction of the image will be processed, range is from 0 to 1.
+    Decreasing this value below 1.0 can lead to faster processing but may result in
+    less accurate prediction, as only a subset of the image tiles will be analyzed.
+    @defaultValue 1.0;
+    */
+    maxProcessedFraction: number;
+    /**
+    If this number of symbols is found and minProcessedFraction of the image is processed, the processing stops.
+    @defaultValue 100;
+    */
+    minNumberOfRequiredSymbols: number;
+    /**
+    Image will be processed in tiles of this size; will be ignored if image is small.
+    @defaultValue 300;
+    */
+    tileSize: number;
+    /** @param source {@displayType `DeepPartial<ProcessByTileConfiguration>`} */
+    constructor(source?: DeepPartial<ProcessByTileConfiguration>);
+}
+/**
 Document Quality Analyzer configuration.
 */
 export declare class DocumentQualityAnalyzerConfiguration {
@@ -91,7 +129,7 @@ export declare class DocumentQualityAnalyzerConfiguration {
     */
     inspectSmallText: boolean;
     /**
-    Maximum image size in pixels, if image is bigger, it will be resized.
+    Maximum image size in pixels, if image is bigger, it will be resized. Zero or negative value means no limit.
     @defaultValue 2000;
     */
     maxImageSize: number;
@@ -101,24 +139,10 @@ export declare class DocumentQualityAnalyzerConfiguration {
     */
     minEstimatedNumberOfSymbolsForDocument: number;
     /**
-    At least this fraction of the image will be processed, range is from 0 to 1.
-    Decreasing this value below 1.0 can lead to faster processing but may result in
-    less accurate prediction, as only a subset of the image tiles will be analyzed.
-    @defaultValue 1.0;
+    Configuration for processing image by tiles.
+    @defaultValue new ProcessByTileConfiguration({});
     */
-    minProcessedFraction: number;
-    /**
-    At most this fraction of the image will be processed, range is from 0 to 1.
-    Decreasing this value below 1.0 can lead to faster processing but may result in
-    less accurate prediction, as only a subset of the image tiles will be analyzed.
-    @defaultValue 1.0;
-    */
-    maxProcessedFraction: number;
-    /**
-    If this number of symbols is found and minProcessedFraction of the image is processed, the processing stops.
-    @defaultValue 100;
-    */
-    minNumberOfRequiredSymbols: number;
+    processByTileConfiguration: ProcessByTileConfiguration;
     /**
     If detectOrientation is True, minNumberOfRequiredSymbols is found, and orientationConfidence is bigger than this threshold, the processing stops.
     If the maxProcessedFraction part of the image is processed and orientationConfidence is lower than the threshold, the returned orientation will be 0.
@@ -126,11 +150,6 @@ export declare class DocumentQualityAnalyzerConfiguration {
     */
     minRequiredOrientationConfidence: number;
     /**
-    Image will be processed in tiles of this size; will be ignored if image is small.
-    @defaultValue 300;
-    */
-    tileSize: number;
-    /**
     If true, will return the quality heatmap as a part of the result.
     In this case, the entire image will be processed and the minProcessedFraction will be ignored.
     Useful for debugging situations where the returned quality doesn't appear to match the perceived quality.
@@ -166,7 +185,7 @@ export declare class DocumentQualityAnalyzerResult {
       * Document contains text with multiple orientations.
       * Text on the document is poorly readable.
       * Text on the document is on the edge of detectable text range (text is too small or too big).
-      * Insufficient statistics because only part of the image was processed. See minProcessedFraction, maxProcessedFraction, and earlyStopIfNSymbolsFound options in the DocumentQualityAnalyzerConfiguration.
+      * Insufficient statistics because only part of the image was processed. See ProcessByTileConfiguration options in the DocumentQualityAnalyzerConfiguration.
     */
     readonly orientationConfidence: number | null;
     /**

package/@types/core/compiled/DocumentScannerTypes.d.ts

@@ -140,26 +140,26 @@ export declare class DocumentScannerConfiguration {
     constructor(source?: DeepPartial<DocumentScannerConfiguration>);
 }
 /**
-The displacement of the document from the image center if the document is partially visible.
+The direction towards the center of the document if the document is partially visible.
 
 - `NONE`:
    The document is fully visible.
 - `UP`:
-   The document is partially visible and occupies the upper part of the image.
+   The document is partially visible. Move the camera up to capture the full document.
 - `UPPER_RIGHT`:
-   The document is partially visible and occupies the upper right part of the image.
+   The document is partially visible. Move the camera up and to the right to capture the full document.
 - `RIGHT`:
-   The document is partially visible and occupies the right part of the image.
+   The document is partially visible. Move the camera to the right to capture the full document.
 - `LOWER_RIGHT`:
-   The document is partially visible and occupies the lower right part of the image.
+   The document is partially visible. Move the camera down and to the right to capture the full document.
 - `DOWN`:
-   The document is partially visible and occupies the lower part of the image.
+   The document is partially visible. Move the camera down to capture the full document.
 - `LOWER_LEFT`:
-   The document is partially visible and occupies the lower left part of the image.
+   The document is partially visible. Move the camera down and to the left to capture the full document.
 - `LEFT`:
-   The document is partially visible and occupies the left part of the image.
+   The document is partially visible. Move the camera to the left to capture the full document.
 - `UPPER_LEFT`:
-   The document is partially visible and occupies the upper left part of the image.
+   The document is partially visible. Move the camera up and to the left to capture the full document.
 */
 export type DocumentDisplacement = 
 /**
@@ -167,35 +167,35 @@ The document is fully visible.
 */
 "NONE" | 
 /**
-The document is partially visible and occupies the upper part of the image.
+The document is partially visible. Move the camera up to capture the full document.
 */
 "UP" | 
 /**
-The document is partially visible and occupies the upper right part of the image.
+The document is partially visible. Move the camera up and to the right to capture the full document.
 */
 "UPPER_RIGHT" | 
 /**
-The document is partially visible and occupies the right part of the image.
+The document is partially visible. Move the camera to the right to capture the full document.
 */
 "RIGHT" | 
 /**
-The document is partially visible and occupies the lower right part of the image.
+The document is partially visible. Move the camera down and to the right to capture the full document.
 */
 "LOWER_RIGHT" | 
 /**
-The document is partially visible and occupies the lower part of the image.
+The document is partially visible. Move the camera down to capture the full document.
 */
 "DOWN" | 
 /**
-The document is partially visible and occupies the lower left part of the image.
+The document is partially visible. Move the camera down and to the left to capture the full document.
 */
 "LOWER_LEFT" | 
 /**
-The document is partially visible and occupies the left part of the image.
+The document is partially visible. Move the camera to the left to capture the full document.
 */
 "LEFT" | 
 /**
-The document is partially visible and occupies the upper left part of the image.
+The document is partially visible. Move the camera up and to the left to capture the full document.
 */
 "UPPER_LEFT";
 /** @hidden */
@@ -385,12 +385,12 @@ export declare class DocumentDetectionResult {
     */
     readonly averageBrightness: number;
     /**
-    The displacement of the document from the image center if the document is partially visible.
+    The direction towards the center of the document if the document is partially visible.
     @defaultValue "NONE";
     */
     readonly displacement: DocumentDisplacement;
     /**
-    The displacement vector of the document from the image center if the document is partially visible
+    The direction vector towards the center of the document if the document is partially visible
     in normalized coordinates.
     */
     readonly displacementVector: Point;

package/@types/core/compiled/DocumentsModel.d.ts

@@ -1505,4 +1505,446 @@ export declare class MoIdentityCardFront {
 }
 export declare namespace MoIdentityCardFront {
 }
-export type DocumentsModelRootType = typeof Metadata.DOCUMENT_TYPE | typeof MRZ.DOCUMENT_TYPE | typeof ParsedDeAddress.DOCUMENT_TYPE | typeof DeIdCardFront.DOCUMENT_TYPE | typeof DeIdCardBack.DOCUMENT_TYPE | typeof DePassport.DOCUMENT_TYPE | typeof EuropeanDriverLicenseFront.DOCUMENT_TYPE | typeof EuropeanDriverLicenseBack.DOCUMENT_TYPE | typeof DeResidencePermitFront.DOCUMENT_TYPE | typeof DeResidencePermitBack.DOCUMENT_TYPE | typeof EuropeanHealthInsuranceCard.DOCUMENT_TYPE | typeof DeHealthInsuranceCardFront.DOCUMENT_TYPE | typeof BrIdCardFront.DOCUMENT_TYPE | typeof BrIdCardBack.DOCUMENT_TYPE | typeof BrIdCardFrontPhotoOnly.DOCUMENT_TYPE | typeof CnEntryAndExitPermitBack.DOCUMENT_TYPE | typeof CnEntryAndExitPermitFront.DOCUMENT_TYPE | typeof CnPermanentResidentCardFront.DOCUMENT_TYPE | typeof HkIdentityCardFront.DOCUMENT_TYPE | typeof TwEntryAndExitPermit.DOCUMENT_TYPE | typeof MoIdentityCardBack.DOCUMENT_TYPE | typeof MoIdentityCardFront.DOCUMENT_TYPE;
+/** RoIdCardTD3 */
+export declare class RoIdCardTD3 {
+    private _document;
+    get document(): GenericDocument;
+    static readonly DOCUMENT_TYPE = "RoIdCardTD3";
+    static readonly ADDRESS_FIELD_NAME = "Address";
+    static readonly ADDRESS_FIELD_NAME_NORMALIZED = "RoIdCardTD3.Address";
+    static readonly BIRTHPLACE_FIELD_NAME = "Birthplace";
+    static readonly BIRTHPLACE_FIELD_NAME_NORMALIZED = "RoIdCardTD3.Birthplace";
+    static readonly EXPIRY_DATE_FIELD_NAME = "ExpiryDate";
+    static readonly EXPIRY_DATE_FIELD_NAME_NORMALIZED = "RoIdCardTD3.ExpiryDate";
+    static readonly GENDER_FIELD_NAME = "Gender";
+    static readonly GENDER_FIELD_NAME_NORMALIZED = "RoIdCardTD3.Gender";
+    static readonly GIVEN_NAMES_FIELD_NAME = "GivenNames";
+    static readonly GIVEN_NAMES_FIELD_NAME_NORMALIZED = "RoIdCardTD3.GivenNames";
+    static readonly ID_FIELD_NAME = "ID";
+    static readonly ID_FIELD_NAME_NORMALIZED = "RoIdCardTD3.ID";
+    static readonly ISSUING_AUTHORITY_FIELD_NAME = "IssuingAuthority";
+    static readonly ISSUING_AUTHORITY_FIELD_NAME_NORMALIZED = "RoIdCardTD3.IssuingAuthority";
+    static readonly NATIONALITY_FIELD_NAME = "Nationality";
+    static readonly NATIONALITY_FIELD_NAME_NORMALIZED = "RoIdCardTD3.Nationality";
+    static readonly PERSONAL_NUMBER_FIELD_NAME = "PersonalNumber";
+    static readonly PERSONAL_NUMBER_FIELD_NAME_NORMALIZED = "RoIdCardTD3.PersonalNumber";
+    static readonly PHOTO_FIELD_NAME = "Photo";
+    static readonly PHOTO_FIELD_NAME_NORMALIZED = "RoIdCardTD3.Photo";
+    static readonly RAW_MRZ_FIELD_NAME = "RawMRZ";
+    static readonly RAW_MRZ_FIELD_NAME_NORMALIZED = "RoIdCardTD3.RawMRZ";
+    static readonly SURNAME_FIELD_NAME = "Surname";
+    static readonly SURNAME_FIELD_NAME_NORMALIZED = "RoIdCardTD3.Surname";
+    static readonly VALID_FROM_DATE_FIELD_NAME = "ValidFromDate";
+    static readonly VALID_FROM_DATE_FIELD_NAME_NORMALIZED = "RoIdCardTD3.ValidFromDate";
+    constructor(document: GenericDocument);
+    requiredDocumentType(): string;
+    /** Address */
+    get address(): Field;
+    /** Birthplace */
+    get birthplace(): Field;
+    /** Expiry date */
+    get expiryDate(): Field;
+    /** Gender */
+    get gender(): Field;
+    /** Given Names */
+    get givenNames(): Field;
+    /** Series and number of the ID card */
+    get id(): Field;
+    /** Issuing authority */
+    get issuingAuthority(): Field;
+    /** Nationality */
+    get nationality(): Field;
+    /** Personal Number (CNP) */
+    get personalNumber(): Field;
+    /** Photo image */
+    get photo(): Field;
+    /** Raw MRZ text value */
+    get rawMRZ(): Field;
+    /** Surname */
+    get surname(): Field;
+    /** Valid from date */
+    get validFromDate(): Field;
+    /** The child document of type "MRZ". */
+    get mrz(): MRZ;
+    /** The child document of type "Metadata". */
+    get metadata(): Metadata;
+}
+export declare namespace RoIdCardTD3 {
+}
+/** ItIdCardFront */
+export declare class ItIdCardFront {
+    private _document;
+    get document(): GenericDocument;
+    static readonly DOCUMENT_TYPE = "ItIdCardFront";
+    static readonly BIRTH_DATE_FIELD_NAME = "BirthDate";
+    static readonly BIRTH_DATE_FIELD_NAME_NORMALIZED = "ItIdCardFront.BirthDate";
+    static readonly BIRTHPLACE_FIELD_NAME = "Birthplace";
+    static readonly BIRTHPLACE_FIELD_NAME_NORMALIZED = "ItIdCardFront.Birthplace";
+    static readonly CARD_ACCESS_NUMBER_FIELD_NAME = "CardAccessNumber";
+    static readonly CARD_ACCESS_NUMBER_FIELD_NAME_NORMALIZED = "ItIdCardFront.CardAccessNumber";
+    static readonly EXPIRY_DATE_FIELD_NAME = "ExpiryDate";
+    static readonly EXPIRY_DATE_FIELD_NAME_NORMALIZED = "ItIdCardFront.ExpiryDate";
+    static readonly GENDER_FIELD_NAME = "Gender";
+    static readonly GENDER_FIELD_NAME_NORMALIZED = "ItIdCardFront.Gender";
+    static readonly GIVEN_NAMES_FIELD_NAME = "GivenNames";
+    static readonly GIVEN_NAMES_FIELD_NAME_NORMALIZED = "ItIdCardFront.GivenNames";
+    static readonly HEIGHT_FIELD_NAME = "Height";
+    static readonly HEIGHT_FIELD_NAME_NORMALIZED = "ItIdCardFront.Height";
+    static readonly ID_FIELD_NAME = "ID";
+    static readonly ID_FIELD_NAME_NORMALIZED = "ItIdCardFront.ID";
+    static readonly ISSUE_DATE_FIELD_NAME = "IssueDate";
+    static readonly ISSUE_DATE_FIELD_NAME_NORMALIZED = "ItIdCardFront.IssueDate";
+    static readonly NATIONALITY_FIELD_NAME = "Nationality";
+    static readonly NATIONALITY_FIELD_NAME_NORMALIZED = "ItIdCardFront.Nationality";
+    static readonly PHOTO_FIELD_NAME = "Photo";
+    static readonly PHOTO_FIELD_NAME_NORMALIZED = "ItIdCardFront.Photo";
+    static readonly PLACE_OF_ISSUE_FIELD_NAME = "PlaceOfIssue";
+    static readonly PLACE_OF_ISSUE_FIELD_NAME_NORMALIZED = "ItIdCardFront.PlaceOfIssue";
+    static readonly SIGNATURE_FIELD_NAME = "Signature";
+    static readonly SIGNATURE_FIELD_NAME_NORMALIZED = "ItIdCardFront.Signature";
+    static readonly SURNAME_FIELD_NAME = "Surname";
+    static readonly SURNAME_FIELD_NAME_NORMALIZED = "ItIdCardFront.Surname";
+    constructor(document: GenericDocument);
+    requiredDocumentType(): string;
+    /** Date of Birth */
+    get birthDate(): Field;
+    /** Birthplace */
+    get birthplace(): Field;
+    /** Card Access Number */
+    get cardAccessNumber(): Field;
+    /** Expiry date */
+    get expiryDate(): Field;
+    /** Gender */
+    get gender(): Field;
+    /** Given Names */
+    get givenNames(): Field;
+    /** Height */
+    get height(): Field;
+    /** Identity Document Number */
+    get id(): Field;
+    /** Date of Issue */
+    get issueDate(): Field;
+    /** Nationality */
+    get nationality(): Field;
+    /** Photo image */
+    get photo(): Field;
+    /** Municipality of Issue */
+    get placeOfIssue(): Field;
+    /** Signature image */
+    get signature(): Field;
+    /** Surname */
+    get surname(): Field;
+    /** The child document of type "Metadata". */
+    get metadata(): Metadata;
+}
+export declare namespace ItIdCardFront {
+}
+/** ItIdCardBack */
+export declare class ItIdCardBack {
+    private _document;
+    get document(): GenericDocument;
+    static readonly DOCUMENT_TYPE = "ItIdCardBack";
+    static readonly ADDRESS_FIELD_NAME = "Address";
+    static readonly ADDRESS_FIELD_NAME_NORMALIZED = "ItIdCardBack.Address";
+    static readonly BARCODE_FIELD_NAME = "Barcode";
+    static readonly BARCODE_FIELD_NAME_NORMALIZED = "ItIdCardBack.Barcode";
+    static readonly FISCAL_CODE_FIELD_NAME = "FiscalCode";
+    static readonly FISCAL_CODE_FIELD_NAME_NORMALIZED = "ItIdCardBack.FiscalCode";
+    static readonly ISSUING_AUTHORITY_FIELD_NAME = "IssuingAuthority";
+    static readonly ISSUING_AUTHORITY_FIELD_NAME_NORMALIZED = "ItIdCardBack.IssuingAuthority";
+    static readonly PARENTS_FIELD_NAME = "Parents";
+    static readonly PARENTS_FIELD_NAME_NORMALIZED = "ItIdCardBack.Parents";
+    static readonly RAW_MRZ_FIELD_NAME = "RawMRZ";
+    static readonly RAW_MRZ_FIELD_NAME_NORMALIZED = "ItIdCardBack.RawMRZ";
+    static readonly REMARKS_FIELD_NAME = "Remarks";
+    static readonly REMARKS_FIELD_NAME_NORMALIZED = "ItIdCardBack.Remarks";
+    static readonly VALIDATION_PHOTO_FIELD_NAME = "ValidationPhoto";
+    static readonly VALIDATION_PHOTO_FIELD_NAME_NORMALIZED = "ItIdCardBack.ValidationPhoto";
+    constructor(document: GenericDocument);
+    requiredDocumentType(): string;
+    /** Address */
+    get address(): Field;
+    /** Barcode data */
+    get barcode(): Field;
+    /** Fiscal Code */
+    get fiscalCode(): Field;
+    /** Issuing authority */
+    get issuingAuthority(): Field | undefined;
+    /** Parents information */
+    get parents(): Field;
+    /** Raw MRZ text value */
+    get rawMRZ(): Field;
+    /** Remarks */
+    get remarks(): Field;
+    /** Validation Photo */
+    get validationPhoto(): Field;
+    /** The child document of type "MRZ". */
+    get mrz(): MRZ;
+    /** The child document of type "Metadata". */
+    get metadata(): Metadata;
+}
+export declare namespace ItIdCardBack {
+}
+/** PoIdCardFront */
+export declare class PoIdCardFront {
+    private _document;
+    get document(): GenericDocument;
+    static readonly DOCUMENT_TYPE = "PoIdCardFront";
+    static readonly BIRTH_DATE_FIELD_NAME = "BirthDate";
+    static readonly BIRTH_DATE_FIELD_NAME_NORMALIZED = "PoIdCardFront.BirthDate";
+    static readonly CARD_ACCESS_NUMBER_FIELD_NAME = "CardAccessNumber";
+    static readonly CARD_ACCESS_NUMBER_FIELD_NAME_NORMALIZED = "PoIdCardFront.CardAccessNumber";
+    static readonly EXPIRY_DATE_FIELD_NAME = "ExpiryDate";
+    static readonly EXPIRY_DATE_FIELD_NAME_NORMALIZED = "PoIdCardFront.ExpiryDate";
+    static readonly GENDER_FIELD_NAME = "Gender";
+    static readonly GENDER_FIELD_NAME_NORMALIZED = "PoIdCardFront.Gender";
+    static readonly GIVEN_NAMES_FIELD_NAME = "GivenNames";
+    static readonly GIVEN_NAMES_FIELD_NAME_NORMALIZED = "PoIdCardFront.GivenNames";
+    static readonly ID_FIELD_NAME = "ID";
+    static readonly ID_FIELD_NAME_NORMALIZED = "PoIdCardFront.ID";
+    static readonly NATIONALITY_FIELD_NAME = "Nationality";
+    static readonly NATIONALITY_FIELD_NAME_NORMALIZED = "PoIdCardFront.Nationality";
+    static readonly PHOTO_FIELD_NAME = "Photo";
+    static readonly PHOTO_FIELD_NAME_NORMALIZED = "PoIdCardFront.Photo";
+    static readonly SIGNATURE_FIELD_NAME = "Signature";
+    static readonly SIGNATURE_FIELD_NAME_NORMALIZED = "PoIdCardFront.Signature";
+    static readonly SURNAME_FIELD_NAME = "Surname";
+    static readonly SURNAME_FIELD_NAME_NORMALIZED = "PoIdCardFront.Surname";
+    constructor(document: GenericDocument);
+    requiredDocumentType(): string;
+    /** Date of Birth */
+    get birthDate(): Field;
+    /** Card Access Number */
+    get cardAccessNumber(): Field | undefined;
+    /** Expiry date */
+    get expiryDate(): Field;
+    /** Gender */
+    get gender(): Field;
+    /** Given Names */
+    get givenNames(): Field;
+    /** Identity Document Number */
+    get id(): Field;
+    /** Nationality */
+    get nationality(): Field;
+    /** Photo image */
+    get photo(): Field;
+    /** Signature image */
+    get signature(): Field | undefined;
+    /** Surname */
+    get surname(): Field;
+    /** The child document of type "Metadata". */
+    get metadata(): Metadata;
+}
+export declare namespace PoIdCardFront {
+}
+/** RoIdCardBack */
+export declare class RoIdCardBack {
+    private _document;
+    get document(): GenericDocument;
+    static readonly DOCUMENT_TYPE = "RoIdCardBack";
+    static readonly ISSUE_DATE_FIELD_NAME = "IssueDate";
+    static readonly ISSUE_DATE_FIELD_NAME_NORMALIZED = "RoIdCardBack.IssueDate";
+    static readonly ISSUING_AUTHORITY_FIELD_NAME = "IssuingAuthority";
+    static readonly ISSUING_AUTHORITY_FIELD_NAME_NORMALIZED = "RoIdCardBack.IssuingAuthority";
+    static readonly RAW_MRZ_FIELD_NAME = "RawMRZ";
+    static readonly RAW_MRZ_FIELD_NAME_NORMALIZED = "RoIdCardBack.RawMRZ";
+    constructor(document: GenericDocument);
+    requiredDocumentType(): string;
+    /** Date of Issue */
+    get issueDate(): Field;
+    /** Issuing authority */
+    get issuingAuthority(): Field;
+    /** Raw MRZ text value */
+    get rawMRZ(): Field;
+    /** The child document of type "MRZ". */
+    get mrz(): MRZ;
+    /** The child document of type "Metadata". */
+    get metadata(): Metadata;
+}
+export declare namespace RoIdCardBack {
+}
+/** RoIdCardFront */
+export declare class RoIdCardFront {
+    private _document;
+    get document(): GenericDocument;
+    static readonly DOCUMENT_TYPE = "RoIdCardFront";
+    static readonly BIRTH_DATE_FIELD_NAME = "BirthDate";
+    static readonly BIRTH_DATE_FIELD_NAME_NORMALIZED = "RoIdCardFront.BirthDate";
+    static readonly CARD_ACCESS_NUMBER_FIELD_NAME = "CardAccessNumber";
+    static readonly CARD_ACCESS_NUMBER_FIELD_NAME_NORMALIZED = "RoIdCardFront.CardAccessNumber";
+    static readonly EXPIRY_DATE_FIELD_NAME = "ExpiryDate";
+    static readonly EXPIRY_DATE_FIELD_NAME_NORMALIZED = "RoIdCardFront.ExpiryDate";
+    static readonly GENDER_FIELD_NAME = "Gender";
+    static readonly GENDER_FIELD_NAME_NORMALIZED = "RoIdCardFront.Gender";
+    static readonly GIVEN_NAMES_FIELD_NAME = "GivenNames";
+    static readonly GIVEN_NAMES_FIELD_NAME_NORMALIZED = "RoIdCardFront.GivenNames";
+    static readonly ID_FIELD_NAME = "ID";
+    static readonly ID_FIELD_NAME_NORMALIZED = "RoIdCardFront.ID";
+    static readonly NATIONALITY_FIELD_NAME = "Nationality";
+    static readonly NATIONALITY_FIELD_NAME_NORMALIZED = "RoIdCardFront.Nationality";
+    static readonly PERSONAL_NUMBER_FIELD_NAME = "PersonalNumber";
+    static readonly PERSONAL_NUMBER_FIELD_NAME_NORMALIZED = "RoIdCardFront.PersonalNumber";
+    static readonly SIGNATURE_FIELD_NAME = "Signature";
+    static readonly SIGNATURE_FIELD_NAME_NORMALIZED = "RoIdCardFront.Signature";
+    static readonly SURNAME_FIELD_NAME = "Surname";
+    static readonly SURNAME_FIELD_NAME_NORMALIZED = "RoIdCardFront.Surname";
+    constructor(document: GenericDocument);
+    requiredDocumentType(): string;
+    /** Date of Birth */
+    get birthDate(): Field;
+    /** Card Access Number */
+    get cardAccessNumber(): Field;
+    /** Expiry date */
+    get expiryDate(): Field;
+    /** Gender */
+    get gender(): Field;
+    /** Given Names */
+    get givenNames(): Field;
+    /** Identity Document Number */
+    get id(): Field;
+    /** Nationality */
+    get nationality(): Field;
+    /** Personal Number (CNP) */
+    get personalNumber(): Field;
+    /** Signature image */
+    get signature(): Field;
+    /** Surname */
+    get surname(): Field;
+    /** The child document of type "Metadata". */
+    get metadata(): Metadata;
+}
+export declare namespace RoIdCardFront {
+}
+/** PoIdCardBack */
+export declare class PoIdCardBack {
+    private _document;
+    get document(): GenericDocument;
+    static readonly DOCUMENT_TYPE = "PoIdCardBack";
+    static readonly BARCODE_FIELD_NAME = "Barcode";
+    static readonly BARCODE_FIELD_NAME_NORMALIZED = "PoIdCardBack.Barcode";
+    static readonly BIRTHPLACE_FIELD_NAME = "Birthplace";
+    static readonly BIRTHPLACE_FIELD_NAME_NORMALIZED = "PoIdCardBack.Birthplace";
+    static readonly ID_FIELD_NAME = "ID";
+    static readonly ID_FIELD_NAME_NORMALIZED = "PoIdCardBack.ID";
+    static readonly ISSUE_DATE_FIELD_NAME = "IssueDate";
+    static readonly ISSUE_DATE_FIELD_NAME_NORMALIZED = "PoIdCardBack.IssueDate";
+    static readonly ISSUING_AUTHORITY_FIELD_NAME = "IssuingAuthority";
+    static readonly ISSUING_AUTHORITY_FIELD_NAME_NORMALIZED = "PoIdCardBack.IssuingAuthority";
+    static readonly PARENTS_GIVEN_NAMES_FIELD_NAME = "ParentsGivenNames";
+    static readonly PARENTS_GIVEN_NAMES_FIELD_NAME_NORMALIZED = "PoIdCardBack.ParentsGivenNames";
+    static readonly PERSONAL_NUMBER_FIELD_NAME = "PersonalNumber";
+    static readonly PERSONAL_NUMBER_FIELD_NAME_NORMALIZED = "PoIdCardBack.PersonalNumber";
+    static readonly RAW_MRZ_FIELD_NAME = "RawMRZ";
+    static readonly RAW_MRZ_FIELD_NAME_NORMALIZED = "PoIdCardBack.RawMRZ";
+    static readonly SURNAME_FIELD_NAME = "Surname";
+    static readonly SURNAME_FIELD_NAME_NORMALIZED = "PoIdCardBack.Surname";
+    constructor(document: GenericDocument);
+    requiredDocumentType(): string;
+    /** Barcode data */
+    get barcode(): Field;
+    /** Birthplace */
+    get birthplace(): Field;
+    /** Identity Document Number */
+    get id(): Field;
+    /** Date of Issue */
+    get issueDate(): Field;
+    /** Issuing authority */
+    get issuingAuthority(): Field;
+    /** Parents Given Names */
+    get parentsGivenNames(): Field;
+    /** Personal Number */
+    get personalNumber(): Field;
+    /** Raw MRZ text value */
+    get rawMRZ(): Field;
+    /** Surname */
+    get surname(): Field;
+    /** The child document of type "MRZ". */
+    get mrz(): MRZ;
+    /** The child document of type "Metadata". */
+    get metadata(): Metadata;
+}
+export declare namespace PoIdCardBack {
+}
+/** TrIdCardBack */
+export declare class TrIdCardBack {
+    private _document;
+    get document(): GenericDocument;
+    static readonly DOCUMENT_TYPE = "TrIdCardBack";
+    static readonly BARCODE_FIELD_NAME = "Barcode";
+    static readonly BARCODE_FIELD_NAME_NORMALIZED = "TrIdCardBack.Barcode";
+    static readonly FATHERS_NAME_FIELD_NAME = "FathersName";
+    static readonly FATHERS_NAME_FIELD_NAME_NORMALIZED = "TrIdCardBack.FathersName";
+    static readonly ISSUING_AUTHORITY_FIELD_NAME = "IssuingAuthority";
+    static readonly ISSUING_AUTHORITY_FIELD_NAME_NORMALIZED = "TrIdCardBack.IssuingAuthority";
+    static readonly MOTHERS_NAME_FIELD_NAME = "MothersName";
+    static readonly MOTHERS_NAME_FIELD_NAME_NORMALIZED = "TrIdCardBack.MothersName";
+    static readonly RAW_MRZ_FIELD_NAME = "RawMRZ";
+    static readonly RAW_MRZ_FIELD_NAME_NORMALIZED = "TrIdCardBack.RawMRZ";
+    constructor(document: GenericDocument);
+    requiredDocumentType(): string;
+    /** Barcode data */
+    get barcode(): Field;
+    /** Father's Name */
+    get fathersName(): Field;
+    /** Issuing authority */
+    get issuingAuthority(): Field;
+    /** Mother's Name */
+    get mothersName(): Field;
+    /** Raw MRZ text value */
+    get rawMRZ(): Field;
+    /** The child document of type "MRZ". */
+    get mrz(): MRZ;
+    /** The child document of type "Metadata". */
+    get metadata(): Metadata;
+}
+export declare namespace TrIdCardBack {
+}
+/** TrIdCardFront */
+export declare class TrIdCardFront {
+    private _document;
+    get document(): GenericDocument;
+    static readonly DOCUMENT_TYPE = "TrIdCardFront";
+    static readonly BIRTH_DATE_FIELD_NAME = "BirthDate";
+    static readonly BIRTH_DATE_FIELD_NAME_NORMALIZED = "TrIdCardFront.BirthDate";
+    static readonly EXPIRY_DATE_FIELD_NAME = "ExpiryDate";
+    static readonly EXPIRY_DATE_FIELD_NAME_NORMALIZED = "TrIdCardFront.ExpiryDate";
+    static readonly GENDER_FIELD_NAME = "Gender";
+    static readonly GENDER_FIELD_NAME_NORMALIZED = "TrIdCardFront.Gender";
+    static readonly GIVEN_NAMES_FIELD_NAME = "GivenNames";
+    static readonly GIVEN_NAMES_FIELD_NAME_NORMALIZED = "TrIdCardFront.GivenNames";
+    static readonly ID_FIELD_NAME = "ID";
+    static readonly ID_FIELD_NAME_NORMALIZED = "TrIdCardFront.ID";
+    static readonly NATIONALITY_FIELD_NAME = "Nationality";
+    static readonly NATIONALITY_FIELD_NAME_NORMALIZED = "TrIdCardFront.Nationality";
+    static readonly PERSONAL_NUMBER_FIELD_NAME = "PersonalNumber";
+    static readonly PERSONAL_NUMBER_FIELD_NAME_NORMALIZED = "TrIdCardFront.PersonalNumber";
+    static readonly SIGNATURE_FIELD_NAME = "Signature";
+    static readonly SIGNATURE_FIELD_NAME_NORMALIZED = "TrIdCardFront.Signature";
+    static readonly SURNAME_FIELD_NAME = "Surname";
+    static readonly SURNAME_FIELD_NAME_NORMALIZED = "TrIdCardFront.Surname";
+    constructor(document: GenericDocument);
+    requiredDocumentType(): string;
+    /** Date of Birth */
+    get birthDate(): Field;
+    /** Expiry date */
+    get expiryDate(): Field;
+    /** Gender */
+    get gender(): Field;
+    /** Given Names */
+    get givenNames(): Field;
+    /** Identity Document Number */
+    get id(): Field;
+    /** Nationality */
+    get nationality(): Field;
+    /** Personal Number */
+    get personalNumber(): Field;
+    /** Signature image */
+    get signature(): Field;
+    /** Surname */
+    get surname(): Field;
+    /** The child document of type "Metadata". */
+    get metadata(): Metadata;
+}
+export declare namespace TrIdCardFront {
+}
+export type DocumentsModelRootType = typeof Metadata.DOCUMENT_TYPE | typeof MRZ.DOCUMENT_TYPE | typeof ParsedDeAddress.DOCUMENT_TYPE | typeof DeIdCardFront.DOCUMENT_TYPE | typeof DeIdCardBack.DOCUMENT_TYPE | typeof DePassport.DOCUMENT_TYPE | typeof EuropeanDriverLicenseFront.DOCUMENT_TYPE | typeof EuropeanDriverLicenseBack.DOCUMENT_TYPE | typeof DeResidencePermitFront.DOCUMENT_TYPE | typeof DeResidencePermitBack.DOCUMENT_TYPE | typeof EuropeanHealthInsuranceCard.DOCUMENT_TYPE | typeof DeHealthInsuranceCardFront.DOCUMENT_TYPE | typeof BrIdCardFront.DOCUMENT_TYPE | typeof BrIdCardBack.DOCUMENT_TYPE | typeof BrIdCardFrontPhotoOnly.DOCUMENT_TYPE | typeof CnEntryAndExitPermitBack.DOCUMENT_TYPE | typeof CnEntryAndExitPermitFront.DOCUMENT_TYPE | typeof CnPermanentResidentCardFront.DOCUMENT_TYPE | typeof HkIdentityCardFront.DOCUMENT_TYPE | typeof TwEntryAndExitPermit.DOCUMENT_TYPE | typeof MoIdentityCardBack.DOCUMENT_TYPE | typeof MoIdentityCardFront.DOCUMENT_TYPE | typeof RoIdCardTD3.DOCUMENT_TYPE | typeof ItIdCardFront.DOCUMENT_TYPE | typeof ItIdCardBack.DOCUMENT_TYPE | typeof PoIdCardFront.DOCUMENT_TYPE | typeof RoIdCardBack.DOCUMENT_TYPE | typeof RoIdCardFront.DOCUMENT_TYPE | typeof PoIdCardBack.DOCUMENT_TYPE | typeof TrIdCardBack.DOCUMENT_TYPE | typeof TrIdCardFront.DOCUMENT_TYPE;

package/@types/core/compiled/MrzTypes.d.ts

@@ -1,6 +1,7 @@
 import type { DeepPartial } from "./utils";
 import { AccumulatedResultsVerifierConfiguration } from "./FrameAccumulationTypes";
 import { GenericDocument } from "./GenericDocument";
+import { ProcessingMode } from "./CommonTypes";
 /**
 Type of document containing the MRZ.
 
@@ -107,6 +108,14 @@ export declare class MrzScannerConfiguration {
     @defaultValue false;
     */
     returnCrops: boolean;
+    /**
+    Scanners typically can produce better results from a single image if they are allowed to spend a longer time analyzing it.
+    
+    On the other hand, scanners can produce even better results if they can analyze multiple images of the same subject and cross-check and combine the results.
+    The processing mode tells the scanner whether to optimize for single or multiple images of a subject.
+    @defaultValue "AUTO";
+    */
+    processingMode: ProcessingMode;
     /** @param source {@displayType `DeepPartial<MrzScannerConfiguration>`} */
     constructor(source?: DeepPartial<MrzScannerConfiguration>);
 }