Captured Id

Defined in namespace Scandit.Datacapture.Id

CapturedId

class CapturedId

Added in version 6.9.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 FirstName { get; }

Added in version 6.9.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 LastName { get; }

Added in version 6.9.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 FullName { get; }

Added in version 6.9.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 Sex { get; }

Added in version 6.9.0

The sex of the document holder.

DateOfBirth

DateResult DateOfBirth { get; }

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

string Nationality { get; }

Added in version 6.9.0

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

Address

string Address { get; }

Added in version 6.9.0

The address of the document holder.

CapturedResultType

CapturedResultType CapturedResultType { get; }

Added in version 6.9.0

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

DocumentType

DocumentType DocumentType { get; }

Added in version 6.9.0

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

IssuingCountryIso

string IssuingCountryIso { get; }

Added in version 6.9.0

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

IssuingCountry

string IssuingCountry { get; }

Added in version 6.9.0

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

DocumentNumber

string DocumentNumber { get; }

Added in version 6.9.0

The document number.

DateOfExpiry

DateResult DateOfExpiry { get; }

Added in version 6.9.0

The date of expiry of the document.

DateOfIssue

DateResult DateOfIssue { get; }

Added in version 6.9.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 AamvaBarcode { get; }

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

ColombiaIdBarcode

ColombiaIdBarcodeResult ColombiaIdBarcode { get; }

Added in version 6.9.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 ArgentinaIdBarcode { get; }

Added in version 6.9.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 SouthAfricaDlBarcode { get; }

Added in version 6.9.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 SouthAfricaIdBarcode { get; }

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

Mrz

MrzResult Mrz { get; }

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

UsUniformedServicesBarcode

UsUniformedServicesBarcodeResult UsUniformedServicesBarcode { get; }

Added in version 6.9.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 Viz { get; }

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

GetImageBitmapForType()

Bitmap GetImageBitmapForType(IdImageType type)

Added in version 6.9.0

Gets a bitmap for an image type.

ToJson()

string ToJson()

Added in version 6.9.0

Returns the JSON representation of the captured id.