IndianPassportV1Document
extends Prediction
in package
Passport - India API version 1.0 document data.
Table of Contents
Properties
- $address1 : StringField
- $address2 : StringField
- $address3 : StringField
- $birthDate : DateField
- $birthPlace : StringField
- $country : StringField
- $expiryDate : DateField
- $fileNumber : StringField
- $gender : ClassificationField
- $givenNames : StringField
- $idNumber : StringField
- $issuanceDate : DateField
- $issuancePlace : StringField
- $legalGuardian : StringField
- $mrz1 : StringField
- $mrz2 : StringField
- $nameOfMother : StringField
- $nameOfSpouse : StringField
- $oldPassportDateOfIssue : DateField
- $oldPassportNumber : StringField
- $oldPassportPlaceOfIssue : StringField
- $pageNumber : ClassificationField
- $surname : StringField
Methods
- __construct() : mixed
- __toString() : string
Properties
$address1
public
StringField
$address1
The first line of the address of the passport holder.
$address2
public
StringField
$address2
The second line of the address of the passport holder.
$address3
public
StringField
$address3
The third line of the address of the passport holder.
$birthDate
public
DateField
$birthDate
The birth date of the passport holder, ISO format: YYYY-MM-DD.
$birthPlace
public
StringField
$birthPlace
The birth place of the passport holder.
$country
public
StringField
$country
ISO 3166-1 alpha-3 country code (3 letters format).
$expiryDate
public
DateField
$expiryDate
The date when the passport will expire, ISO format: YYYY-MM-DD.
$fileNumber
public
StringField
$fileNumber
The file number of the passport document.
$gender
public
ClassificationField
$gender
The gender of the passport holder.
$givenNames
public
StringField
$givenNames
The given names of the passport holder.
$idNumber
public
StringField
$idNumber
The identification number of the passport document.
$issuanceDate
public
DateField
$issuanceDate
The date when the passport was issued, ISO format: YYYY-MM-DD.
$issuancePlace
public
StringField
$issuancePlace
The place where the passport was issued.
$legalGuardian
public
StringField
$legalGuardian
The name of the legal guardian of the passport holder (if applicable).
$mrz1
public
StringField
$mrz1
The first line of the machine-readable zone (MRZ) of the passport document.
$mrz2
public
StringField
$mrz2
The second line of the machine-readable zone (MRZ) of the passport document.
$nameOfMother
public
StringField
$nameOfMother
The name of the mother of the passport holder.
$nameOfSpouse
public
StringField
$nameOfSpouse
The name of the spouse of the passport holder (if applicable).
$oldPassportDateOfIssue
public
DateField
$oldPassportDateOfIssue
The date of issue of the old passport (if applicable), ISO format: YYYY-MM-DD.
$oldPassportNumber
public
StringField
$oldPassportNumber
The number of the old passport (if applicable).
$oldPassportPlaceOfIssue
public
StringField
$oldPassportPlaceOfIssue
The place of issue of the old passport (if applicable).
$pageNumber
public
ClassificationField
$pageNumber
The page number of the passport document.
$surname
public
StringField
$surname
The surname of the passport holder.
Methods
__construct()
public
__construct(array<string|int, mixed> $rawPrediction[, int|null $pageId = null ]) : mixed
Parameters
- $rawPrediction : array<string|int, mixed>
-
Raw prediction from HTTP response.
- $pageId : int|null = null
-
Page number for multi pages document.
Tags
__toString()
public
__toString() : string
Return values
string —String representation.