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.

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

supportedDocuments

@property (nonatomic, assign) SDCIdDocumentType supportedDocuments

Added in version 6.5.0

The types of personal identification documents that SDCIdCapture configured with these settings is able to scan.

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

supportedSides

@property (nonatomic, assign) SDCSupportedSides supportedSides

Added in version 6.6.0

The sides of personal identification documents that SDCIdCapture configured with these settings is able to scan. This setting is relevant only for supportedDocuments of type SDCIdDocumentTypeDLVIZ and SDCIdDocumentTypeIdCardVIZ, otherwise it is ignored. The default is SDCSupportedSidesFrontOnly.

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.

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: