ID Capture Settings
Defined in namespace Scandit.DataCapture.ID.Capture
- IdCaptureSettings
class IdCaptureSettings
Added in version 6.10.0
Settings to configure an IdCapture instance.
- IdCaptureSettings()
IdCaptureSettings()
Added in version 6.10.0
Creates a new default settings. By default the ScannerType is an instance of SingleSideScanner that does not scan anything, and AcceptedDocuments is empty.
- GetShouldPassImageTypeToResult()
bool
GetShouldPassImageTypeToResult(IdImageType type)Added in version 6.10.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()
void
SetShouldPassImageTypeToResult(IdImageType type,bool
shouldPass)Added in version 6.10.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()
void
SetProperty(string
name,object
value)Added in version 6.10.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()
object
GetProperty(string
name)Added in version 6.10.0
Retrieves the value of a previously set property. In case the property does not exist, null is returned. Use this method to get properties that are not yet part of a stable API. These properties may change in a future release.
- GetProperty()
T
GetProperty<T
>(string
name)Added in version 6.10.0
Retrieves the value of a previously set property. In case the property does not exist, an ArgumentException is thrown.
- TryGetProperty()
bool
TryGetProperty<T
>(string
name, outT
result)Added in version 6.10.0
The non-throwing version of the method GetProperty(). It retrieves the value of a previously set property as the second passed argument and returns true. In case the property does not exist, false will be returned.
- AnonymizationMode
IdAnonymizationMode AnonymizationMode { get;set; }
Added in version 6.20.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
IIdCaptureScanner ScannerType { get;set; }
Added in version 7.0.0
Defines which zones and sides of an identity document are scanned.
- AcceptedDocuments
IList<IIdCaptureDocument> AcceptedDocuments { get;set; }
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
IList<IIdCaptureDocument> RejectedDocuments { get;set; }
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 { get;set; }Added in version 7.0.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 { get;set; }Added in version 7.0.0
This setting enables the extraction of vehicle categories from the back of European driver’s licenses.