ID Capture Settings

Defined in framework ScanditIdCapture

SDCIdCaptureSettings
@interface SDCIdCaptureSettings : NSObject <NSCopying>

Added in version 6.2.0

Settings to configure an SDCIdCapture instance.

+ settings
+ (instancetype)settings

Added in version 6.2.0

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

- resultShouldContainImage:forImageType:
- (void)resultShouldContainImage:(BOOL)shouldContainImage
                    forImageType:(SDCIdImageType)imageType

Added in version 6.2.0

Gets whether an SDCIdCapture created with these settings should extract an image (specified by the given type) from recognized documents and return it as part of SDCCapturedId. 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 NO.

- resultShouldContainImageForImageType:
- (BOOL)resultShouldContainImageForImageType:(SDCIdImageType)imageType

Added in version 6.2.0

Sets whether an SDCIdCapture created with these settings should extract an image (specified by the given type) from recognized documents and return it as part of SDCCapturedId. 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 NO.

- setValue:forProperty:
- (void)setValue:(nullable id)value
     forProperty:(nonnull NSString *)property

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.

- valueForProperty:
- (nullable id)valueForProperty:(nonnull NSString *)property

Added in version 6.2.0

Retrieves the value of a previously set property. In case the property does not exist, nil 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
@property (nonatomic, assign) SDCIdAnonymizationMode anonymizationMode

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 SDCIdAnonymizationModeFieldsOnly.

scannerType
@property (nonatomic) SDCIdCaptureScanner *scannerType

Added in version 7.0.0

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

acceptedDocuments
@property (nonatomic) NSArray<SDCIdCaptureDocument *> *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
@property (nonatomic) NSArray<SDCIdCaptureDocument *> *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
@property (nonatomic, assign) BOOL rejectVoidedIds

Added in version 6.24.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
@property (nonatomic, assign) BOOL decodeBackOfEuropeanDrivingLicense

Added in version 6.25.0

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

rejectExpiredIds
@property (nonatomic, assign) BOOL rejectExpiredIds

Added in version 7.1.0

This setting allows to reject expired documents.

rejectIdsExpiringIn
@property (nonatomic, nullable) SDCDuration *rejectIdsExpiringIn

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
@property (nonatomic, assign) BOOL rejectNotRealIdCompliant

Added in version 7.1.0

This setting allows to reject not Real ID compliant documents.

rejectForgedAamvaBarcodes
@property (nonatomic, assign) BOOL rejectForgedAamvaBarcodes

Added in version 7.1.0

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

rejectInconsistentData
@property (nonatomic, assign) BOOL rejectInconsistentData

Added in version 7.1.0

This setting allows to reject documents with inconsistent data.

rejectHolderBelowAge
@property (nonatomic, nullable) NSNumber *rejectHolderBelowAge

Added in version 7.1.0

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

decodeMobileDriverLicenses
@property (nonatomic, assign) BOOL decodeMobileDriverLicenses

Added in version 7.2.0

This setting allows to decode mobile driver licenses. Note that this feature requires the ScanditLabelCaptureText library