Captured ID
Defined under the namespace Scandit.Datacapture.Id
- CapturedId
class CapturedIdAdded in version 6.13.0
A class that represents a result of a document scan. This class contains the captured information that is commonly present in all the documents, like the name or the date of birth of the holder.
The class can be cast to a concrete implementation using capturedResultTypes.
- firstName
get firstName(): string | null
Added in version 6.16.0
The first name of the document holder. Separated by spaces if more than one name is present. Characters can be all uppercase for document types which don’t capitalize names (for example names encoded in ICAO Machine Readable Zones).
- lastName
get lastName(): string | null
Added in version 6.16.0
The last name of the document holder. Separated by spaces if more than one name is present. Characters can be all uppercase for document types which don’t capitalize names (for example names encoded in ICAO Machine Readable Zones).
- secondaryLastName
get secondaryLastName(): string | null
Added in version 6.24.0
Optional secondary last name for document holders of French passports. This field holds the common name, known as “nom d’usage” when it is specified on the passport.
- fullName
get fullName(): string
Added in version 6.16.0
The full name of the document holder. Characters can be all uppercase for document types which don’t capitalize names (for example names encoded in ICAO Machine Readable Zones).
- dateOfBirth
get dateOfBirth(): DateResult | null
Added in version 6.16.0
The date of birth of the document holder. If the document doesn’t provide two first digits of the year then the date of birth is always set to be earlier than or equal to the scan date. For example if the year of scanning is 2021 and the document returns that the year of birth is 14 then the returned year is set to 2014. However if the document returns that the year of birth is 24 then the returned year is set to 1924.
- age
get age(): number | null
Added in version 6.16.0
The age of the document holder. Calculated as the difference in full years between the birth date and the current local date. If null is returned it means that the full birth date is not available. The returned value depends on the device date. The same document may result in different values for devices with different dates (e.g. in different time zones, or with a date set manually by the user).
- nationality
get nationality(): string | null
Added in version 6.16.0
The nationality of the document holder represented by a three-letter code (Alpha-3 codes specified in ISO 3166-1).
- capturedResultTypes
get capturedResultTypes(): CapturedResultType[]
Added in version 6.13.0
The captured result types. Guaranteed to contain at least one element. Consult the documentation for more information about it.
- document
get document(): IdCaptureDocument | null
Added in version 7.0.0
The document type.
- issuingCountryIso
get issuingCountryIso(): string | null
Added in version 6.16.0
The ISO (Alpha-3 code) abbreviation of the issuing country of the document.
- issuingCountry
get issuingCountry(): Region
Added in version 7.0.0
Issuing country of the document.
- documentNumber
get documentNumber(): string | null
Added in version 6.16.0
The document number.
If IdCaptureSettings.anonymizationMode is enabled for the field results, the returned value might be null for certain documents.
- documentAdditionalNumber
get documentAdditionalNumber(): string | null
Added in version 6.19.0
If IdCaptureSettings.anonymizationMode is enabled for the field results, the returned value might be null for certain documents.
If IdCaptureSettings.anonymizationMode is enabled for the field results, the returned value might be null for certain documents.
- dateOfExpiry
get dateOfExpiry(): DateResult | null
Added in version 6.16.0
The date of expiry of the document.
- isExpired
get isExpired(): boolean | null
Added in version 6.16.0
Whether this document is expired. Calculated by comparing the document’s expiration date with the current local date. true if the document is expired and false if it’s not expired, or if it never expires. null is returned if the value of this property could not be determined - for example if the date of expiry is not present, or if the date of expiry couldn’t be captured. Please note that the system time is used for computation of this field so users of the device are capable of changing the result of the field by changing the system time.
- dateOfIssue
get dateOfIssue(): DateResult | null
Added in version 6.16.0
The date of issue of the document. Please note that some documents may specify the exact date of issue, while other the month and the year only.
- barcode
get barcode(): BarcodeResult | null
Added in version 7.0.0
The additional information extracted from a barcode on a document.
- mrzResult
get mrzResult(): MRZResult | null
Added in version 6.13.0
The additional information extracted from the Machine Readable Zone (MRZ) of a Machine Readable Travel Document (MRTD). This property is guaranteed to be non-null when capturedResultTypes has CapturedResultType.MRZResult, and is null otherwise.
- vizResult
get vizResult(): VIZResult | null
Added in version 6.13.0
The additional information extracted from a documents or its part intended to be read by humans (for example Visual Inspection Zone (VIZ) of a Machine-Readable Travel Document (MRTD)). This property is guaranteed to be non-null when capturedResultTypes has CapturedResultType.VIZResult, and is null otherwise.
- isIdCard()
isIdCard(): boolean
Added in version 7.0.0
Indicates whether the document is of type IdCard.
- isDriverLicense()
isDriverLicense(): boolean
Added in version 7.0.0
Indicates whether the document is of type DriverLicense.
- isPassport()
isPassport(): boolean
Added in version 7.0.0
Indicates whether the document is of type Passport.
- isVisaIcao()
isVisaIcao(): boolean
Added in version 7.0.0
Indicates whether the document is of type VisaIcao.
- isResidencePermit()
isResidencePermit(): boolean
Added in version 7.0.0
Indicates whether the document is of type ResidencePermit.
- isHealthInsuranceCard()
isHealthInsuranceCard(): boolean
Added in version 7.0.0
Indicates whether the document is of type HealthInsuranceCard.
- isRegionSpecific(subtype)
isRegionSpecific(subtype: RegionSpecificSubtype): boolean
Added in version 7.0.0
Indicates whether the document is of type RegionSpecificSubtype.