Captured Id#

Defined under the namespace Scandit.Datacapture.Id

CapturedId#
class CapturedId

Added 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).

sex#
get sex(): string | null

Added in version 6.6.0

The sex of the document holder.

dateOfBirth#
get dateOfBirth(): DateResult | null

Added in version 6.6.0

The date of birth of the document holder.

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).

address#
get address(): string | null

Added in version 6.6.0

The address of the document holder.

capturedResultType#
get capturedResultType(): CapturedResultType

Added in version 6.6.0

The captured result type. 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.

documentNumber#
get documentNumber(): string | null

Added in version 6.6.0

The document number.

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.

mrzResult#
get mrzResult(): MRZResult | null

Added in version 6.6.0

The additional information extracted from a 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.