ID Capture Settings
Defined under the namespace Scandit.Datacapture.Id
- IdCaptureSettings
class IdCaptureSettingsAdded in version 6.14.0
Settings to configure an IdCapture instance.
- constructor()
constructor()Added in version 6.14.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(type)
getShouldPassImageTypeToResult(type: IdImageType): boolean
Added in version 6.14.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)
setShouldPassImageTypeToResult(type: IdImageType, shouldPass: boolean):
voidAdded in version 6.14.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)
setProperty(name: string, value:
any):voidAdded in version 6.14.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)
getProperty(name: string):
anyAdded in version 6.14.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.
- anonymizationMode
anonymizationMode: IdAnonymizationMode
Added in version 6.21.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
scannerType: IdCaptureScanner
Added in version 7.0.0
Defines which zones and sides of an identity document are scanned.
- acceptedDocuments
acceptedDocuments: IdCaptureDocument[]
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
rejectedDocuments: IdCaptureDocument[]
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.