ID Capture Settings

Defined in library scandit_datacapture_id

IdCaptureSettings
class IdCaptureSettings

Added in version 6.11.0

Settings to configure an IdCapture instance.

getShouldPassImageTypeToResult(type)
bool getShouldPassImageTypeToResult(IdImageType type)

Added in version 6.11.0

Gets whether an IdCapture created with these settings should extract an image (specified by the given type) from recognized documents and return it as part of CapturedId. Note that the image may still not be returned, for example, if it’s not present in a document or if it’s not recognized. Default is false.

setShouldPassImageTypeToResult(type, shouldPass)
void setShouldPassImageTypeToResult(IdImageType type,
        bool shouldPass)

Added in version 6.11.0

Sets whether an IdCapture created with these settings should extract an image (specified by the given type) from recognized documents and return it as part of CapturedId. Note that the image may still not be returned, for example, if it’s not present in a document or if it’s not recognized. Default is false.

setProperty(name, value)
void setProperty<T>(String name,
        T value)

Added in version 6.11.0

Sets a property to the provided value. Use this method to set properties that are not yet part of a stable API. Properties set through this method may change in a future release.

getProperty(name)
T getProperty<T>(String name)

Added in version 6.11.0

Retrieves the value of a previously set property. In case the property does not exist, an ArgumentException is thrown.

anonymizationMode
IdAnonymizationMode anonymizationMode

Added in version 6.19.0

This setting allows to remove protected data from images and result fields of certain document types. Enabling anonymization helps to remain compliant with local legal requirements which restrict the collection of some data. Examples of affected fields are the document number on German IDs or the personal ID number on Dutch driver’s licenses. By default set to IdAnonymizationMode.fieldsOnly.

scannerType
IdCaptureScanner scannerType

Added in version 7.0.0

Defines which zones and sides of an identity document are scanned.

acceptedDocuments
List<IdCaptureDocument> acceptedDocuments

Added in version 7.0.0

Documents that should be accepted by the ID Capture scanner. You may accept individual document categories (like ID cards or passports) globally or narrow the selection by region or country, offering granular control over the scanning configuration.

All documents not specified by this setting are rejected.

Refer to the Supported Documents section for the full list of document types and regions.

rejectedDocuments
List<IdCaptureDocument> rejectedDocuments

Added in version 7.0.0

Documents to reject during ID capture, even if they match types defined in “acceptedDocuments”. This property is useful for enforcing restrictions on documents from certain regions or countries.

Refer to the Supported Documents section for the full list of document types and regions.

rejectVoidedIds
bool rejectVoidedIds

Added in version 6.25.0

This setting allows to reject voided documents. This feature has been primarily developed for US Driver’s Licenses, the results might not be accurate when scanning other document types.

decodeBackOfEuropeanDrivingLicense
bool decodeBackOfEuropeanDrivingLicense

Added in version 7.0.0

This setting enables the extraction of vehicle categories from the back of European driver’s licenses.