International ID API version 2.1 document data.

Hierarchy

  • InternationalIdV2Document

Implements

Constructors

Properties

address: StringField

The physical address of the document holder.

birthDate: DateField

The date of birth of the document holder.

birthPlace: StringField

The place of birth of the document holder.

countryOfIssue: StringField

The country where the document was issued.

documentNumber: StringField

The unique identifier assigned to the document.

The type of personal identification document.

expiryDate: DateField

The date when the document becomes invalid.

givenNames: StringField[] = []

The list of the document holder's given names.

issueDate: DateField

The date when the document was issued.

mrzLine1: StringField

The Machine Readable Zone, first line.

mrzLine2: StringField

The Machine Readable Zone, second line.

mrzLine3: StringField

The Machine Readable Zone, third line.

nationality: StringField

The country of citizenship of the document holder.

personalNumber: StringField

The unique identifier assigned to the document holder.

The biological sex of the document holder.

stateOfIssue: StringField

The state or territory where the document was issued.

surnames: StringField[] = []

The list of the document holder's family names.

Methods

Generated using TypeDoc