Class DePassport

German travel passport (Reisepass)

Index

Constructors

Properties

Accessors

birthDate birthplace countryCode document expiryDate gender givenNames id issueDate issuingAuthority maidenName metadata mrz nationality passportType photo rawMRZ signature surname

Methods

requiredDocumentType

Constructors

constructor

new DePassport(document): DePassport
Parameters
- document: GenericDocument
Returns DePassport

Properties

`Static` `Readonly` BIRTHPLACE_FIELD_NAME

BIRTHPLACE_FIELD_NAME: "Birthplace" = "Birthplace"

`Static` `Readonly` BIRTHPLACE_FIELD_NAME_NORMALIZED

BIRTHPLACE_FIELD_NAME_NORMALIZED: "DePassport.Birthplace" = "DePassport.Birthplace"

`Static` `Readonly` BIRTH_DATE_FIELD_NAME

BIRTH_DATE_FIELD_NAME: "BirthDate" = "BirthDate"

`Static` `Readonly` BIRTH_DATE_FIELD_NAME_NORMALIZED

BIRTH_DATE_FIELD_NAME_NORMALIZED: "DePassport.BirthDate" = "DePassport.BirthDate"

`Static` `Readonly` COUNTRY_CODE_FIELD_NAME

COUNTRY_CODE_FIELD_NAME: "CountryCode" = "CountryCode"

`Static` `Readonly` COUNTRY_CODE_FIELD_NAME_NORMALIZED

COUNTRY_CODE_FIELD_NAME_NORMALIZED: "DePassport.CountryCode" = "DePassport.CountryCode"

`Static` `Readonly` DOCUMENT_TYPE

DOCUMENT_TYPE: "DePassport" = "DePassport"

`Static` `Readonly` EXPIRY_DATE_FIELD_NAME

EXPIRY_DATE_FIELD_NAME: "ExpiryDate" = "ExpiryDate"

`Static` `Readonly` EXPIRY_DATE_FIELD_NAME_NORMALIZED

EXPIRY_DATE_FIELD_NAME_NORMALIZED: "DePassport.ExpiryDate" = "DePassport.ExpiryDate"

`Static` `Readonly` GENDER_FIELD_NAME

GENDER_FIELD_NAME: "Gender" = "Gender"

`Static` `Readonly` GENDER_FIELD_NAME_NORMALIZED

GENDER_FIELD_NAME_NORMALIZED: "DePassport.Gender" = "DePassport.Gender"

`Static` `Readonly` GIVEN_NAMES_FIELD_NAME

GIVEN_NAMES_FIELD_NAME: "GivenNames" = "GivenNames"

`Static` `Readonly` GIVEN_NAMES_FIELD_NAME_NORMALIZED

GIVEN_NAMES_FIELD_NAME_NORMALIZED: "DePassport.GivenNames" = "DePassport.GivenNames"

`Static` `Readonly` ID_FIELD_NAME

ID_FIELD_NAME: "ID" = "ID"

`Static` `Readonly` ID_FIELD_NAME_NORMALIZED

ID_FIELD_NAME_NORMALIZED: "DePassport.ID" = "DePassport.ID"

`Static` `Readonly` ISSUE_DATE_FIELD_NAME

ISSUE_DATE_FIELD_NAME: "IssueDate" = "IssueDate"

`Static` `Readonly` ISSUE_DATE_FIELD_NAME_NORMALIZED

ISSUE_DATE_FIELD_NAME_NORMALIZED: "DePassport.IssueDate" = "DePassport.IssueDate"

`Static` `Readonly` ISSUING_AUTHORITY_FIELD_NAME

ISSUING_AUTHORITY_FIELD_NAME: "IssuingAuthority" = "IssuingAuthority"

`Static` `Readonly` ISSUING_AUTHORITY_FIELD_NAME_NORMALIZED

ISSUING_AUTHORITY_FIELD_NAME_NORMALIZED: "DePassport.IssuingAuthority" = "DePassport.IssuingAuthority"

`Static` `Readonly` MAIDEN_NAME_FIELD_NAME

MAIDEN_NAME_FIELD_NAME: "MaidenName" = "MaidenName"

`Static` `Readonly` MAIDEN_NAME_FIELD_NAME_NORMALIZED

MAIDEN_NAME_FIELD_NAME_NORMALIZED: "DePassport.MaidenName" = "DePassport.MaidenName"

`Static` `Readonly` NATIONALITY_FIELD_NAME

NATIONALITY_FIELD_NAME: "Nationality" = "Nationality"

`Static` `Readonly` NATIONALITY_FIELD_NAME_NORMALIZED

NATIONALITY_FIELD_NAME_NORMALIZED: "DePassport.Nationality" = "DePassport.Nationality"

`Static` `Readonly` PASSPORT_TYPE_FIELD_NAME

PASSPORT_TYPE_FIELD_NAME: "PassportType" = "PassportType"

`Static` `Readonly` PASSPORT_TYPE_FIELD_NAME_NORMALIZED

PASSPORT_TYPE_FIELD_NAME_NORMALIZED: "DePassport.PassportType" = "DePassport.PassportType"

`Static` `Readonly` PHOTO_FIELD_NAME

PHOTO_FIELD_NAME: "Photo" = "Photo"

`Static` `Readonly` PHOTO_FIELD_NAME_NORMALIZED

PHOTO_FIELD_NAME_NORMALIZED: "DePassport.Photo" = "DePassport.Photo"

`Static` `Readonly` RAW_MRZ_FIELD_NAME

RAW_MRZ_FIELD_NAME: "RawMRZ" = "RawMRZ"

`Static` `Readonly` RAW_MRZ_FIELD_NAME_NORMALIZED

RAW_MRZ_FIELD_NAME_NORMALIZED: "DePassport.RawMRZ" = "DePassport.RawMRZ"

`Static` `Readonly` SIGNATURE_FIELD_NAME

SIGNATURE_FIELD_NAME: "Signature" = "Signature"

`Static` `Readonly` SIGNATURE_FIELD_NAME_NORMALIZED

SIGNATURE_FIELD_NAME_NORMALIZED: "DePassport.Signature" = "DePassport.Signature"

`Static` `Readonly` SURNAME_FIELD_NAME

SURNAME_FIELD_NAME: "Surname" = "Surname"

`Static` `Readonly` SURNAME_FIELD_NAME_NORMALIZED

SURNAME_FIELD_NAME_NORMALIZED: "DePassport.Surname" = "DePassport.Surname"

Accessors

birthDate

get birthDate(): Field
Birth date

Returns Field

birthplace

get birthplace(): Field
Birthplace

Returns Field

countryCode

get countryCode(): Field
Country code

Returns Field

document

get document(): GenericDocument
Returns GenericDocument

expiryDate

get expiryDate(): Field
Expiry date

Returns Field

gender

get gender(): Field
Gender

Returns Field

givenNames

get givenNames(): Field
Given names

Returns Field

id

get id(): Field
Document ID number (in the top-right corner)

Returns Field

issueDate

get issueDate(): Field
Issue date

Returns Field

issuingAuthority

get issuingAuthority(): Field
Issuing authority

Returns Field

maidenName

get maidenName(): Field
Maiden name

Returns Field

metadata

get metadata(): Metadata
The child document of type "Metadata".

Returns Metadata

mrz

get mrz(): MRZ
The child document of type "MRZ".

Returns MRZ

nationality

get nationality(): Field
Nationality

Returns Field

passportType

get passportType(): Field
Passport type

Returns Field

photo

get photo(): Field
Photo image

Returns Field

rawMRZ

get rawMRZ(): Field
Raw MRZ text value

Returns Field

signature

get signature(): Field
Signature image

Returns Field

surname

get surname(): Field
Surname

Returns Field

Methods

requiredDocumentType

requiredDocumentType(): string
Returns string

Class DePassport

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

document: GenericDocument

Returns DePassport

Properties

Static Readonly BIRTHPLACE_FIELD_NAME

Static Readonly BIRTHPLACE_FIELD_NAME_NORMALIZED

Static Readonly BIRTH_DATE_FIELD_NAME

Static Readonly BIRTH_DATE_FIELD_NAME_NORMALIZED

Static Readonly COUNTRY_CODE_FIELD_NAME

Static Readonly COUNTRY_CODE_FIELD_NAME_NORMALIZED

Static Readonly DOCUMENT_TYPE

Static Readonly EXPIRY_DATE_FIELD_NAME

Static Readonly EXPIRY_DATE_FIELD_NAME_NORMALIZED

Static Readonly GENDER_FIELD_NAME

Static Readonly GENDER_FIELD_NAME_NORMALIZED

Static Readonly GIVEN_NAMES_FIELD_NAME

Static Readonly GIVEN_NAMES_FIELD_NAME_NORMALIZED

Static Readonly ID_FIELD_NAME

Static Readonly ID_FIELD_NAME_NORMALIZED

Static Readonly ISSUE_DATE_FIELD_NAME

Static Readonly ISSUE_DATE_FIELD_NAME_NORMALIZED

Static Readonly ISSUING_AUTHORITY_FIELD_NAME

Static Readonly ISSUING_AUTHORITY_FIELD_NAME_NORMALIZED

Static Readonly MAIDEN_NAME_FIELD_NAME

Static Readonly MAIDEN_NAME_FIELD_NAME_NORMALIZED

Static Readonly NATIONALITY_FIELD_NAME

Static Readonly NATIONALITY_FIELD_NAME_NORMALIZED

Static Readonly PASSPORT_TYPE_FIELD_NAME

Static Readonly PASSPORT_TYPE_FIELD_NAME_NORMALIZED

Static Readonly PHOTO_FIELD_NAME

Static Readonly PHOTO_FIELD_NAME_NORMALIZED

Static Readonly RAW_MRZ_FIELD_NAME

Static Readonly RAW_MRZ_FIELD_NAME_NORMALIZED

Static Readonly SIGNATURE_FIELD_NAME

Static Readonly SIGNATURE_FIELD_NAME_NORMALIZED

Static Readonly SURNAME_FIELD_NAME

Static Readonly SURNAME_FIELD_NAME_NORMALIZED

Accessors

birthDate

Returns Field

birthplace

Returns Field

countryCode

Returns Field

document

Returns GenericDocument

expiryDate

Returns Field

gender

Returns Field

givenNames

Returns Field

id

Returns Field

issueDate

Returns Field

issuingAuthority

Returns Field

maidenName

Returns Field

metadata

Returns Metadata

mrz

Returns MRZ

nationality

Returns Field

passportType

Returns Field

photo

Returns Field

rawMRZ

Returns Field

`Static` `Readonly` BIRTHPLACE_FIELD_NAME

`Static` `Readonly` BIRTHPLACE_FIELD_NAME_NORMALIZED

`Static` `Readonly` BIRTH_DATE_FIELD_NAME

`Static` `Readonly` BIRTH_DATE_FIELD_NAME_NORMALIZED

`Static` `Readonly` COUNTRY_CODE_FIELD_NAME

`Static` `Readonly` COUNTRY_CODE_FIELD_NAME_NORMALIZED

`Static` `Readonly` DOCUMENT_TYPE

`Static` `Readonly` EXPIRY_DATE_FIELD_NAME

`Static` `Readonly` EXPIRY_DATE_FIELD_NAME_NORMALIZED

`Static` `Readonly` GENDER_FIELD_NAME

`Static` `Readonly` GENDER_FIELD_NAME_NORMALIZED

`Static` `Readonly` GIVEN_NAMES_FIELD_NAME

`Static` `Readonly` GIVEN_NAMES_FIELD_NAME_NORMALIZED

`Static` `Readonly` ID_FIELD_NAME

`Static` `Readonly` ID_FIELD_NAME_NORMALIZED

`Static` `Readonly` ISSUE_DATE_FIELD_NAME

`Static` `Readonly` ISSUE_DATE_FIELD_NAME_NORMALIZED

`Static` `Readonly` ISSUING_AUTHORITY_FIELD_NAME

`Static` `Readonly` ISSUING_AUTHORITY_FIELD_NAME_NORMALIZED

`Static` `Readonly` MAIDEN_NAME_FIELD_NAME

`Static` `Readonly` MAIDEN_NAME_FIELD_NAME_NORMALIZED

`Static` `Readonly` NATIONALITY_FIELD_NAME

`Static` `Readonly` NATIONALITY_FIELD_NAME_NORMALIZED

`Static` `Readonly` PASSPORT_TYPE_FIELD_NAME

`Static` `Readonly` PASSPORT_TYPE_FIELD_NAME_NORMALIZED

`Static` `Readonly` PHOTO_FIELD_NAME

`Static` `Readonly` PHOTO_FIELD_NAME_NORMALIZED

`Static` `Readonly` RAW_MRZ_FIELD_NAME

`Static` `Readonly` RAW_MRZ_FIELD_NAME_NORMALIZED

`Static` `Readonly` SIGNATURE_FIELD_NAME

`Static` `Readonly` SIGNATURE_FIELD_NAME_NORMALIZED

`Static` `Readonly` SURNAME_FIELD_NAME

`Static` `Readonly` SURNAME_FIELD_NAME_NORMALIZED