ID Capture Settings

Defined in framework ScanditIdCapture

IdCaptureSettings

open class IdCaptureSettings : NSObject, NSCopying

Added in version 6.2.0

Settings to configure an IdCapture instance.

init

init()

Added in version 6.2.0

Creates a new default settings. By default the scanner is an instance of SingleSideScanner that does not scan anything, and acceptedDocuments is empty.

includeImage

open func includeImage(for imageType: IdImageType) -> Bool

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

setIncludeImage

open func setIncludeImage(_ include: Bool, for imageType: IdImageType) -> Void

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

set

open func set(value: Any?, forProperty property: String) -> Void

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

value

open func value(forProperty property: String) -> Any?

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

open var anonymizationMode: IdAnonymizationMode { get, set }

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

addAnonymizedField

open func addAnonymizedField(_ document: IdCaptureDocument, fieldType: IdFieldType) -> Void

Added in version 8.0.0

Adds a specific field to be anonymized for the specified document type and region. This method allows fine-grained control over which fields are anonymized, complementing the global anonymizationMode setting. Fields added through this method will be anonymized in addition to any default anonymization rules for the document type.

removeAnonymizedField

open func removeAnonymizedField(_ document: IdCaptureDocument, fieldType: IdFieldType) -> Void

Added in version 8.0.0

Removes a previously added anonymized field for the specified document type and region. This method provides fine-grained control over anonymization settings, allowing dynamic adjustment of which fields should be anonymized. If the field was not previously added, this operation has no effect.

clearAnonymizedFields

open func clearAnonymizedFields() -> Void

Added in version 8.0.0

Removes all previously added anonymized fields from the settings.

scanner

open var scanner: IdCaptureScanner { get, set }

Added in version 7.0.0

Defines the scanner configuration for capturing identity documents, including physical documents and mobile documents.

acceptedDocuments

open var acceptedDocuments: Array<IdCaptureDocument> { 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

open var rejectedDocuments: Array<IdCaptureDocument> { 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

open var rejectVoidedIds: Bool { get, set }

Added in version 6.24.0

This setting enables rejection of 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

open var decodeBackOfEuropeanDrivingLicense: Bool { get, set }

Added in version 6.25.0

This setting enables the extraction of additional data about vehicle categories from the back of European driver’s licenses, like issue and expiry dates.

rejectExpiredIds

open var rejectExpiredIds: Bool { get, set }

Added in version 7.1.0

This setting allows to reject expired documents.

rejectIdsExpiringIn

open var rejectIdsExpiringIn: Duration? { get, set }

Added in version 7.1.0

This setting allows to reject documents that will expire within the specified duration. The duration components are applied on the date of expiry in the following order: years, months and days. Enabling this setting automatically enables the rejection of expired IDs.

rejectNotRealIdCompliant

open var rejectNotRealIdCompliant: Bool { get, set }

Added in version 7.1.0

This setting allows to reject not Real ID compliant documents.

rejectForgedAamvaBarcodes

open var rejectForgedAamvaBarcodes: Bool { get, set }

Added in version 7.1.0

This setting allows to reject documents with a forged AAMVA barcode.

rejectInconsistentData

open var rejectInconsistentData: Bool { get, set }

Added in version 7.1.0

This setting allows to reject documents with inconsistent data.

rejectHolderBelowAge

open var rejectHolderBelowAge: NSNumber? { get, set }

Added in version 7.1.0

This setting allows to reject documents whose holder is below the specified age.

rejectionTimeoutSeconds

open var rejectionTimeoutSeconds: Int { get, set }

Added in version 8.1.0

The timeout in seconds for document localization without successful capture. When a document is localized but not captured within this duration, the IdCaptureListener.idCapture() callback is triggered with RejectionReason.timeout. Default is 6 seconds. Values less than or equal to 0 reset to the default value.