mindee/src/product/internationalId/internationalIdV2Document.d.ts

Mindee Client Library for Node.js

import { Prediction, StringDict } from "../../parsing/common";
import { ClassificationField, DateField, StringField } from "../../parsing/standard";
/**
 * International ID API version 2.2 document data.
 */
export declare class InternationalIdV2Document implements Prediction {
    /** The physical address of the document holder. */
    address: StringField;
    /** The date of birth of the document holder. */
    birthDate: DateField;
    /** The place of birth of the document holder. */
    birthPlace: StringField;
    /** The country where the document was issued. */
    countryOfIssue: StringField;
    /** The unique identifier assigned to the document. */
    documentNumber: StringField;
    /** The type of personal identification document. */
    documentType: ClassificationField;
    /** The date when the document becomes invalid. */
    expiryDate: DateField;
    /** The list of the document holder's given names. */
    givenNames: StringField[];
    /** The date when the document was issued. */
    issueDate: DateField;
    /** The Machine Readable Zone, first line. */
    mrzLine1: StringField;
    /** The Machine Readable Zone, second line. */
    mrzLine2: StringField;
    /** The Machine Readable Zone, third line. */
    mrzLine3: StringField;
    /** The country of citizenship of the document holder. */
    nationality: StringField;
    /** The unique identifier assigned to the document holder. */
    personalNumber: StringField;
    /** The biological sex of the document holder. */
    sex: StringField;
    /** The state or territory where the document was issued. */
    stateOfIssue: StringField;
    /** The list of the document holder's family names. */
    surnames: StringField[];
    constructor(rawPrediction: StringDict, pageId?: number);
    /**
     * Default string representation.
     */
    toString(): string;
}