Captured ID

Defined in library scandit_datacapture_id

CapturedId

class CapturedId

Added in version 6.11.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

String? get firstName

Added in version 6.11.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

String? get lastName

Added in version 6.11.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

String get fullName

Added in version 6.11.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

String? get sex

Added in version 6.11.0

The sex of the document holder.

dateOfBirth

DateResult? get dateOfBirth

Added in version 6.11.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

int? get age

Added in version 6.19.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

String? get nationality

Added in version 6.11.0

The nationality of the document holder represented by a three-letter code (Alpha-3 codes specified in ISO 3166-1).

address

String? get address

Added in version 6.11.0

The address of the document holder.

capturedResultType

CapturedResultType get capturedResultType

Added in version 6.11.0

The captured result type. Consult the documentation for more information about it.

capturedResultTypes

Set<CapturedResultType> get capturedResultTypes

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

DocumentType get documentType

Added in version 6.11.0

The document type. Consult the documentation for more information about it.

issuingCountryIso

String? get issuingCountryIso

Added in version 6.11.0

The ISO (Alpha-3 code) abbreviation of the issuing country of the document.

issuingCountry

String? get issuingCountry

Added in version 6.11.0

A human readable text identifying the country that issues the document.

documentNumber

String? get documentNumber

Added in version 6.11.0

The document number.

If IdCaptureSettings.anonymizationMode is enabled for the field results, the returned value might be null for certain documents.

documentAdditionalNumber

String? get documentAdditionalNumber

Added in version 6.19.0

If IdCaptureSettings.anonymizationMode is enabled for the field results, the returned value might be null for certain documents.

dateOfExpiry

DateResult? get dateOfExpiry

Added in version 6.11.0

The date of expiry of the document.

isExpired

bool? get isExpired

Added in version 6.19.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

DateResult? get dateOfIssue

Added in version 6.11.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.

aamvaBarcode

AamvaBarcodeResult? get aamvaBarcode

Added in version 6.11.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.

colombiaDlBarcode

ColombiaDlBarcodeResult? get colombiaDlBarcode

Added in version 6.15.0

The additional information extracted from a barcode on a Colombia Driver’s License (Licencia de Conducción). This property is guaranteed to be non-null when capturedResultTypes is CapturedResultType.colombiaDlBarcodeResult, and is null otherwise.

colombiaIdBarcode

ColombiaIdBarcodeResult? get colombiaIdBarcode

Added in version 6.11.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.

argentinaIdBarcode

ArgentinaIdBarcodeResult? get argentinaIdBarcode

Added in version 6.11.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.

southAfricaDlBarcode

SouthAfricaDlBarcodeResult? get southAfricaDlBarcode

Added in version 6.11.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.

southAfricaIdBarcode

SouthAfricaIdBarcodeResult? get southAfricaIdBarcode

Added in version 6.11.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.

commonAccessCardBarcode

CommonAccessCardBarcodeResult? get commonAccessCardBarcode

Added in version 6.19.0

mrz

MrzResult? get mrz

Added in version 6.11.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.

usUniformedServicesBarcode

UsUniformedServicesBarcodeResult? get usUniformedServicesBarcode

Added in version 6.11.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.

viz

VizResult? get viz

Added in version 6.11.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.

chinaMainlandTravelPermitMrz

ChinaMainlandTravelPermitMrzResult? get chinaMainlandTravelPermitMrz

Added in version 6.19.0

The additional information extracted from a barcode on a China Mainland Travel Permit. This property is guaranteed to be non-null when capturedResultTypes is CapturedResultType.chinaMainlandTravelPermitMrzResult, and is null otherwise.

chinaExitEntryPermitMrz

ChinaExitEntryPermitMrzResult? get chinaExitEntryPermitMrz

Added in version 6.19.0

The additional information extracted from the Machine Readable Zone (MRZ) present on an Exit-Entry Permit for Travelling to and from Hong Kong and Macau (往来港澳通行证) or an Exit-Entry Permit for Travelling to and from Taiwan (往来台灣通行证) issued by People’s Republic of China. This property is guaranteed to be non-null when capturedResultTypes is CapturedResultType.chinaMainlandTravelPermitMrzResult, and is null otherwise.

chinaOneWayPermitBackMrz

ChinaOneWayPermitBackMrzResult? get chinaOneWayPermitBackMrz

Added in version 6.19.0

The additional information extracted from the Machine Readable Zone (MRZ) present on the back of a One-Way Permit to Hong Kong/Macau issued by People’s Republic of China. This property is guaranteed to be non-null when capturedResultTypes is CapturedResultType.chinaOneWayPermitBackMrzResult, and is null otherwise.

chinaOneWayPermitFrontMrz

ChinaOneWayPermitFrontMrzResult? get chinaOneWayPermitFrontMrz

Added in version 6.19.0

The additional information extracted from the Machine Readable Zone (MRZ) present on the front of a One-Way Permit to Hong Kong/Macau issued by People’s Republic of China. This property is guaranteed to be non-null when capturedResultTypes is CapturedResultType.chinaOneWayPermitFrontMrzResult, and is null otherwise.

apecBusinessTravelCardMrz

ApecBusinessTravelCardMrzResult? get apecBusinessTravelCardMrz

Added in version 6.19.0

The additional information extracted from the Machine Readable Zone (MRZ) present on the back of an APEC (Asia-Pacific Economic Cooperation) Business Travel Card. This property is guaranteed to be non-null when capturedResultTypes is CapturedResultType.apecBusinessTravelCardMrzResult, and is null otherwise.

usVisaViz

UsVisaVizResult? get usVisaViz

Added in version 6.19.0

The additional information extracted from the US Visa. This property is guaranteed to be non-null when capturedResultTypes is CapturedResultType.usVisaVizResult, and is null otherwise.

getImageForType(imageType)

Image? getImageForType(IdImageType imageType)

Added in version 6.11.0

Gets a bitmap for an image type.