mindee/src/product/ind/indianPassport/indianPassportV1Document.d.ts

Mindee Client Library for Node.js

import { Prediction, StringDict } from "../../../parsing/common";
import { ClassificationField, DateField, StringField } from "../../../parsing/standard";
/**
 * Passport - India API version 1.2 document data.
 */
export declare class IndianPassportV1Document implements Prediction {
    /** The first line of the address of the passport holder. */
    address1: StringField;
    /** The second line of the address of the passport holder. */
    address2: StringField;
    /** The third line of the address of the passport holder. */
    address3: StringField;
    /** The birth date of the passport holder, ISO format: YYYY-MM-DD. */
    birthDate: DateField;
    /** The birth place of the passport holder. */
    birthPlace: StringField;
    /** ISO 3166-1 alpha-3 country code (3 letters format). */
    country: StringField;
    /** The date when the passport will expire, ISO format: YYYY-MM-DD. */
    expiryDate: DateField;
    /** The file number of the passport document. */
    fileNumber: StringField;
    /** The gender of the passport holder. */
    gender: ClassificationField;
    /** The given names of the passport holder. */
    givenNames: StringField;
    /** The identification number of the passport document. */
    idNumber: StringField;
    /** The date when the passport was issued, ISO format: YYYY-MM-DD. */
    issuanceDate: DateField;
    /** The place where the passport was issued. */
    issuancePlace: StringField;
    /** The name of the legal guardian of the passport holder (if applicable). */
    legalGuardian: StringField;
    /** The first line of the machine-readable zone (MRZ) of the passport document. */
    mrz1: StringField;
    /** The second line of the machine-readable zone (MRZ) of the passport document. */
    mrz2: StringField;
    /** The name of the mother of the passport holder. */
    nameOfMother: StringField;
    /** The name of the spouse of the passport holder (if applicable). */
    nameOfSpouse: StringField;
    /** The date of issue of the old passport (if applicable), ISO format: YYYY-MM-DD. */
    oldPassportDateOfIssue: DateField;
    /** The number of the old passport (if applicable). */
    oldPassportNumber: StringField;
    /** The place of issue of the old passport (if applicable). */
    oldPassportPlaceOfIssue: StringField;
    /** The page number of the passport document. */
    pageNumber: ClassificationField;
    /** The surname of the passport holder. */
    surname: StringField;
    constructor(rawPrediction: StringDict, pageId?: number);
    /**
     * Default string representation.
     */
    toString(): string;
}