InternationalIdV2Document
extends Prediction
in package
International ID API version 2.1 document data.
Table of Contents
Properties
- $address : StringField
- $birthDate : DateField
- $birthPlace : StringField
- $countryOfIssue : StringField
- $documentNumber : StringField
- $documentType : ClassificationField
- $expiryDate : DateField
- $givenNames : array<string|int, StringField>
- $issueDate : DateField
- $mrzLine1 : StringField
- $mrzLine2 : StringField
- $mrzLine3 : StringField
- $nationality : StringField
- $personalNumber : StringField
- $sex : StringField
- $stateOfIssue : StringField
- $surnames : array<string|int, StringField>
Methods
- __construct() : mixed
- __toString() : string
Properties
$address
public
StringField
$address
The physical address of the document holder.
$birthDate
public
DateField
$birthDate
The date of birth of the document holder.
$birthPlace
public
StringField
$birthPlace
The place of birth of the document holder.
$countryOfIssue
public
StringField
$countryOfIssue
The country where the document was issued.
$documentNumber
public
StringField
$documentNumber
The unique identifier assigned to the document.
$documentType
public
ClassificationField
$documentType
The type of personal identification document.
$expiryDate
public
DateField
$expiryDate
The date when the document becomes invalid.
$givenNames
public
array<string|int, StringField>
$givenNames
The list of the document holder's given names.
$issueDate
public
DateField
$issueDate
The date when the document was issued.
$mrzLine1
public
StringField
$mrzLine1
The Machine Readable Zone, first line.
$mrzLine2
public
StringField
$mrzLine2
The Machine Readable Zone, second line.
$mrzLine3
public
StringField
$mrzLine3
The Machine Readable Zone, third line.
$nationality
public
StringField
$nationality
The country of citizenship of the document holder.
$personalNumber
public
StringField
$personalNumber
The unique identifier assigned to the document holder.
$sex
public
StringField
$sex
The biological sex of the document holder.
$stateOfIssue
public
StringField
$stateOfIssue
The state or territory where the document was issued.
$surnames
public
array<string|int, StringField>
$surnames
The list of the document holder's family names.
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.