Captured ID
Defined in library scandit_datacapture_id
- CapturedId
class CapturedIdAdded in version 6.11.0
This class represents the result of a document scan. It provides commonly present information, such as the holder’s name and date of birth, directly accessible at the top level. Additional document-specific details can be accessed through properties representing different zones of the document, such as the barcode, machine-readable zone (MRZ), and visual inspection zone (VIZ).
Note that not all properties are relevant to every document type. If a property is not applicable or the corresponding data could not be read, it will be set to null.
- 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).
- 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 as raw OCR text from the document. The format and language vary by jurisdiction (e.g., “DEUTSCH”, “AMERICAN”, “POLSKA”, “DEU”).
For a standardized ISO 3166-1 alpha-3 country code representation, use nationalityISO.
- nationalityISO
String? get nationalityISO
Added in version 8.1.0
The holder’s nationality as an ISO 3166-1 alpha-3 country code (e.g., “DEU”, “USA”, “POL”).
Returns null if the nationality cannot be determined or is ambiguous.
- usRealIdStatus
UsRealIdStatus get usRealIdStatus
Added in version 8.0.0
Indicates whether the document is REAL ID compliant.
- document
IdCaptureDocument? get document
Added in version 7.0.0
The document type.
- issuingCountryIso
String? get issuingCountryIso
Added in version 6.11.0
The ISO (Alpha-3 code) abbreviation of the issuing country of the document.
- issuingCountry
IdCaptureRegion get issuingCountry
Added in version 7.0.0
Issuing country of 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.
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. Returning null with isExpired = false indicates that the document never expires.
- 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 when either not expired, or 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.
- barcode
BarcodeResult? get barcode
Added in version 7.0.0
The additional information extracted from a barcode on a document.
- mobileDocument
MobileDocumentResult? get mobileDocument
Added in version 8.0.0
The additional information extracted from a mobile identity document.
- mobileDocumentOcr
MobileDocumentOcrResult? get mobileDocumentOcr
Added in version 8.0.0
The additional information extracted from a mobile document using optical character recognition (OCR). This property is populated when scanning mobile driver licenses with OCR-based capture enabled (for example, Australian mobile driver licenses when the mobile scanner is enabled).
- 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).
- 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)).
- isDriverLicense()
bool isDriverLicense()
Added in version 7.0.0
Indicates whether the document is of type DriverLicense.
- isPassport()
bool isPassport()
Added in version 7.0.0
Indicates whether the document is of type Passport.
- isCitizenPassport
bool get isCitizenPassport
Added in version 8.0.0
Indicates whether the passport was issued to a citizen of the issuing country. Returns false for travel documents such as refugee, stateless, or alien passports, and for any passports issued by organizations rather than states.
- isVisaIcao()
bool isVisaIcao()
Added in version 7.0.0
Indicates whether the document is of type VisaIcao.
- isResidencePermit()
bool isResidencePermit()
Added in version 7.0.0
Indicates whether the document is of type ResidencePermit.
- isHealthInsuranceCard()
bool isHealthInsuranceCard()
Added in version 7.0.0
Indicates whether the document is of type HealthInsuranceCard.
- isRegionSpecific(subtype)
bool isRegionSpecific(RegionSpecificSubtype subtype)
Added in version 7.0.0
Indicates whether the document is of type RegionSpecificSubtype.
- verificationResult
VerificationResult get verificationResult
Added in version 8.0.0
Results of verifications automatically performed when IdCaptureSettings.rejectInconsistentData or IdCaptureSettings.rejectForgedAamvaBarcodes are enabled.
- isAnonymized(field)
bool isAnonymized(IdFieldType field)
Added in version 8.0.0
Checks whether the specified field has been anonymized.
Returns true if the field was present in the captured document and was anonymized according to the IdCaptureSettings.anonymizationMode setting, false otherwise.
A field that is not present in the document always returns false, even if anonymization is enabled for that field type.
This method is useful for determining which fields have been redacted, particularly when using IdCaptureSettings.anonymizationMode set to IdAnonymizationMode.fieldsOnly or IdAnonymizationMode.fieldsAndImages.
- Param IdFieldType field
The field type to check for anonymization.
- anonymizedFields
List<IdFieldType> get anonymizedFields
Added in version 8.0.0
Returns all fields that have been anonymized in this captured document.
Only fields that were actually present in the captured document and were subsequently anonymized are included.