IdCardV2Page
extends IdCardV2Document
in package
Carte Nationale d'Identité API version 2.0 page data.
Table of Contents
Properties
- $alternateName : StringField
- $authority : StringField
- $birthDate : DateField
- $birthPlace : StringField
- $cardAccessNumber : StringField
- $documentNumber : StringField
- $documentSide : ClassificationField
- $documentType : ClassificationField
- $expiryDate : DateField
- $gender : StringField
- $givenNames : array<string|int, StringField>
- $issueDate : DateField
- $mrz1 : StringField
- $mrz2 : StringField
- $mrz3 : StringField
- $nationality : StringField
- $surname : StringField
Methods
- __construct() : mixed
- __toString() : string
Properties
$alternateName
public
StringField
$alternateName
The alternate name of the card holder.
$authority
public
StringField
$authority
The name of the issuing authority.
$birthDate
public
DateField
$birthDate
The date of birth of the card holder.
$birthPlace
public
StringField
$birthPlace
The place of birth of the card holder.
$cardAccessNumber
public
StringField
$cardAccessNumber
The card access number (CAN).
$documentNumber
public
StringField
$documentNumber
The document number.
$documentSide
public
ClassificationField
$documentSide
The sides of the document which are visible.
$documentType
public
ClassificationField
$documentType
The document type or format.
$expiryDate
public
DateField
$expiryDate
The expiry date of the identification card.
$gender
public
StringField
$gender
The gender of the card holder.
$givenNames
public
array<string|int, StringField>
$givenNames
The given name(s) of the card holder.
$issueDate
public
DateField
$issueDate
The date of issue of the identification card.
$mrz1
public
StringField
$mrz1
The Machine Readable Zone, first line.
$mrz2
public
StringField
$mrz2
The Machine Readable Zone, second line.
$mrz3
public
StringField
$mrz3
The Machine Readable Zone, third line.
$nationality
public
StringField
$nationality
The nationality of the card holder.
$surname
public
StringField
$surname
The surname of the card 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.
__toString()
public
__toString() : string
Return values
string —String representation.