Captured ID
Defined under the namespace Scandit.Datacapture.Id
- CapturedId
class CapturedIdAdded in version 6.6.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 capturedResultType.
- firstName
get firstName(): string | null
Added in version 6.6.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.6.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).
- fullName
get fullName(): string
Added in version 6.6.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.6.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.
- nationality
get nationality(): string | null
Added in version 6.6.0
The nationality of the document holder represented by a three-letter code (Alpha-3 codes specified in ISO 3166-1).
- capturedResultType
get capturedResultType(): CapturedResultType
Added in version 6.6.0
The captured result type. Consult the documentation for more information about it.
- capturedResultTypes
get capturedResultTypes(): CapturedResultType[]
Added in version 6.12.0
The captured result types. Guaranteed to contain at least one element. Consult the documentation for more information about it.
- documentType
get documentType(): DocumentType
Added in version 6.6.0
The document type. Consult the documentation for more information about it.
- issuingCountryIso
get issuingCountryIso(): string | null
Added in version 6.6.0
The ISO (Alpha-3 code) abbreviation of the issuing country of the document.
- issuingCountry
get issuingCountry(): string | null
Added in version 6.6.0
A human readable text identifying the country that issues the document.
- dateOfExpiry
get dateOfExpiry(): DateResult | null
Added in version 6.6.0
The date of expiry of the document.
- dateOfIssue
get dateOfIssue(): DateResult | null
Added in version 6.6.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.
- aamvaBarcodeResult
get aamvaBarcodeResult(): AAMVABarcodeResult | null
Added in version 6.6.0
The additional information extracted from a barcode on a document that follows the American Association of Motor Vehicle Administrators (AAMVA) specification. This property is guaranteed to be non-null when capturedResultType is CapturedResultType.AAMVABarcodeResult, and is null otherwise.
- colombiaIdBarcodeResult
get colombiaIdBarcodeResult(): ColombiaIdBarcodeResult | null
Added in version 6.6.0
The additional information extracted from a barcode on a Colombia ID (Cédula de Ciudadanía). This property is guaranteed to be non-null when capturedResultType is CapturedResultType.ColombiaIdBarcodeResult, and is null otherwise.
- argentinaIdBarcodeResult
get argentinaIdBarcodeResult(): ArgentinaIdBarcodeResult | null
Added in version 6.6.0
The additional information extracted from a barcode on a Argentina ID (Documento Nacional de Identidad). This property is guaranteed to be non-null when capturedResultType is CapturedResultType.ArgentinaIdBarcodeResult, and is null otherwise.
- southAfricaDlBarcodeResult
get southAfricaDlBarcodeResult(): SouthAfricaDlBarcodeResult | null
Added in version 6.6.0
The additional information extracted from a barcode on a South Africa Driver’s License. This property is guaranteed to be non-null when capturedResultType is CapturedResultType.SouthAfricaDlBarcodeResult, and is null otherwise.
- southAfricaIdBarcodeResult
get southAfricaIdBarcodeResult(): SouthAfricaIdBarcodeResult | null
Added in version 6.6.0
The additional information extracted from a barcode on a South Africa identity card (Smart ID Card). This property is guaranteed to be non-null when capturedResultType is CapturedResultType.SouthAfricaIdBarcodeResult, and is null otherwise.
- mrzResult
get mrzResult(): MRZResult | null
Added in version 6.6.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 capturedResultType is CapturedResultType.MRZResult, and is null otherwise.
- usUniformedServicesBarcodeResult
get usUniformedServicesBarcodeResult(): USUniformedServicesBarcodeResult | null
Added in version 6.6.0
The additional information extracted from a barcode on a United States Uniformed Services Identification card. This property is guaranteed to be non-null when capturedResultType is CapturedResultType.USUniformedServicesBarcodeResult, and is null otherwise.
- vizResult
get vizResult(): VIZResult | null
Added in version 6.6.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 capturedResultType is CapturedResultType.VIZResult, and is null otherwise.
- idImageOfType(type)
idImageOfType(type: IdImageType): string | null
Added in version 6.6.0
Gets a bitmap for an image type.