String mobileToken
Usage token associated with your CAF account
| Yes | |.setDocumentDetectorFlow(flow :\[DocumentDetectorStep])
Sets the document capture flow, as explained here
| Yes | |.setPeopleId(peopleId: String?)
Identifier of the user for the purpose of identifying a fraudulent profile
| No, only used for [analytics](https://github.com/combateafraude/public-docs/blob/docs-sdks/analytics.md) | |.setAnalyticsSettings(useAnalytics: Bool)
Enables/disables data collection for analytics
| No, the default is **`true`** | |.setPopupSettings(show: Bool)
Change the setting of the inflated popups before each document
| No, the default is **`true`** | |.setDetectionSettings(detectionThreshold : Float)
Changes the default document detection setting, the frame confidence threshold (from 0.0 to 1.0, where 1.0 indicates that the SDK will only accept the document with a perfect frame)
| No. The default is 0.91 | |.setQualitySettings(verifyQuality: Bool, qualityThreshold: Double?)
Changes the default setting for verifying the quality of the captures, indicating whether you want to perform this verification (takes about 2 seconds) and the quality threshold for these photos can be set (value from 1.0 to 5.0). In addition, the SDK will return the URL of the image in the variable DocumentDetectorResult.Capture.ImageUrl. Be careful, if you decide to check the quality in this parameter and there is a connection failure while sending the images, the SDK will terminate with an internet error.
.setLayout(layout: DocumentDetectorLayout)
Changes the document masks from success, failure, and normal.
It also allows you to change the sound and cancel buttons at the top of the screen. See the example.
| No | |.setColorTheme(color: UIColor)
Change the color of the sound and cancel buttons that are at the top of the screen. Also change the color of the popup buttons, inflated before each document.
| No | |.enableSound(enableSound: Bool)
Enables/disables sounds and the sound icon in the SDK
| No, the default is **`true`** | |.showStepLabel(show: Bool)
Show/hide the lower middle label (which contains the document name)
| No, the default is **`true`** | |.showStatusLabel(show: Bool)
Show/hide the central label (which contains the status)
| No, the default is **`true`** | |.setNetworkSettings(requestTimeout:TimeInterval)
Change the default network settings
| No. The default is 60 (seconds) | |.setLuminositySensorSettings(luminosityThreshold :Float?)
Defines threshold between acceptable/unacceptable ambient brightness. The threshold of this sensor is a number ranging from negative to positive.
| No. The default setting is -3. | |.setOrientationSensorSettings(orientationThreshold: Double?)
Defines threshold between correct/incorrect device orientation. Higher the value more flexible it will be. The threshold of this sensor is the acceleration of the device
| No. The default setting is 0.3. | |.setStabilitySensorSettings(stabilityThreshold: Double?)
Changes the default settings of the stability sensor. The threshold of this sensor is in the range of the last two accelerations collected from the device.
| No. The default setting is 0.3. | |.setProxySettings(proxySettings: ProxySettings?)
Sets the proxy settings, as explained here
| No. The default is **`null`** | |.showPreview(\_ show: Bool, title: String?, subtitle: String?, confirmLabel: String?, retryLabel: String?)
Enables/disables the capture preview. If show has true, after each capture, the SDK provides a screen for the user to approve or make the capture again. For the remaining parameters, enter nil to use the default value or a String for a custom text.
.setMessageSettings(waitMessage: String?, fitTheDocumentMessage: String?, verifyingQualityMessage: String?, lowQualityDocumentMessage: String?, uploadingImageMessage: String?, popupDocumentSubtitleMessage: String?, unsupportedDocumentMessage: String?, wrongDocumentMessage\_RG\_FRONT: String?, wrongDocumentMessage\_RG\_BACK: String?, wrongDocumentMessage\_RG\_FULL: String?, wrongDocumentMessage\_CNH\_FRONT: String?, wrongDocumentMessage\_CNH\_BACK: String?, wrongDocumentMessage\_CNH\_FULL: String?, wrongDocumentMessage\_CRLV: String?, wrongDocumentMessage\_RNE\_FRONT: String?, wrongDocumentMessage\_RNE\_BACK: String?, sensorLuminosityMessage: String?, sensorOrientationMessage: String?, sensorStabilityMessage: String?)
Allows customizing messages displayed in the "status" balloon during the capture and analysis process. example
| No. | |.setCompressSettings(compressionQuality: CGFloat)
Allows you to set the quality in the compression process. By default, all captures are compressed. The method expects values between 0 and 1.0 as parameters, 1.0 being the best quality compression (recommended).
| No. The default is 1.0 | |.setManualCaptureSettings(enable: Bool, time: TimeInterval)
Enables/disables manual capture. The time parameter sets the time for the capture mode to be enabled.
.enableMultiLanguage(\_ enable: Bool)
Enables/disables multi-language support.
| No. The default is enabled | |.setGetImageUrlExpireTime(expireTime: String)
Sets how long the image URL will last on the server until it is expired. Expect to receive a time interval between "30m" to "30d".
Examples:
setGetImageUrlExpireTime("30m"): To set minutes only
setGetImageUrlExpireTime("24h"): To set only hour(s)
setGetImageUrlExpireTime("1h 10m"): To set hour(s) and minute(s)
setGetImageUrlExpireTime("10d"): To set day(s)
.setMask(type: MaskType)
Sets the type of mask used in the captures. There are three types:
.standard, with the dotted pattern in the document format;
.empty, which removes the mask entirely.
.setCurrentStepDoneDelay(currentStepDoneDelay: TimeInterval)
Delay the activity after the completion of each step. This method can be used to display a success message on the screen itself after the capture, for example.
| No. The default is **`false`** | |.setUploadSettings(UploadSettings uploadSettings)
Sets the settings for uploading documents. By enabling this option, the SDK flow will prompt the user to upload the document files instead of capturing them with the device's camera. This option also includes document quality checks. example of implementation.
| No. By default this option is disabled. | |.setResolutionSettings(resolution: Resolution)
Allows you to set the capture resolution. The method takes a parameter a Resolution, which has the following options:
low Specifies appropriate capture settings for output video and audio bit rates suitable for 3G sharingmedium Specifies the appropriate capture settings for the output video and audio bitrates suitable for sharing over WiFihigh Specifies appropriate capture settings for high-quality video and audio outputphoto Specifies appropriate capture settings for high-resolution photo quality outputinputPriority Specifies appropriate capture settings for high-resolution photo quality outputhd1280x720 Specifies the appropriate capture settings for video output at 720p quality (1280 x 720 pixels)hd1920x1080 Capture settings suitable for 1080p (1920 x 1080 pixels) quality video outputhd4K3840x2160 Capture settings suitable for 2160p (3840 x 2160 pixels) quality video output.setAllowedPassportCountriesList(passportList: \[CountryCodes])
Enables the option to allow passports from only a certain issuing country, or, a list of countries. See the complete list at: ISO 3166-1 alpha-3
Example:
.setAllowedPassportList(passportList: \[CountryCodes.BRA])document: Document
Identifies which document you want to capture in the respective step
| Yes | |stepLabel: String?
Text to be displayed at the bottom of the layout
| No. There is a pattern per **`Document`** Type | |illustration: UIImage?
Illustration to be shown in the popup before the capture
| No. There is a pattern per **`Document`** Type | |audio: URL?
Audio to be played at the beginning of the step. Example.
| No. There is a pattern per **`Document`** Type | ### **MessageSettings** | **Attribute** | **Default Value** | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | |waitMessage: String
Message displayed when SDK is in the process of opening.
| "Please Wait…" | |fitTheDocumentMessage: String
Message advising to fit the document to the mask.
| "Fit the document on the markup" | |verifyingQualityMessage: String
Message displayed when the SDK makes a request to the backend, verifying quality.
| "Checking Quality…" | |lowQualityDocumentMessage: String
Message displayed when the quality of the capture fails.
| "Ops, could not read the information. Please try again" | |uploadingImageMessage: String
Message displayed when there is no quality check and the capture is being saved on the servers.
| "Sending Image…" | |popupDocumentSubtitleMessage: String
Text displayed in the step initialization popup.
| "Dispose the document in a desk, centralize it on the markup and hold the automatic capture." | |unsupportedDocumentMessage: String
Message displayed when a unexpected type of document is displayed for capture.
| "Ops, it seems that this document is not supported. Contact us!" | |wrongDocumentMessage\_RG\_FRONT: String
Message displayed when the front of the RG(Brazilian ID card) is displayed in a different flow than expected.
| "Ops, this is the RG's Front" | |wrongDocumentMessage\_RG\_BACK: String
Message displayed when the RG(Brazilian ID card) version is displayed in a different flow than expected.
| "Ops, this is the RG's Back" | |wrongDocumentMessage\_RG\_FULL: String
Message displayed when the open RG(Brazilian ID card) is displayed in a different stream than expected.
| "Ops, this is the RG Opened" | |wrongDocumentMessage\_CNH\_FRONT: String
Message displayed when the front of the CNH(Brazilian driver's license) is displayed in a different stream than expected.
| "Ops, this is the CNH's Front" | |wrongDocumentMessage\_CNH\_BACK: String
Message displayed when the version of the CNH(Brazilian driver's license) is displayed in a different stream than expected.
| "Ops, this is the CNH's Back" | |wrongDocumentMessage\_CNH\_FULL: String
Message displayed when the open CNH(Brazilian driver's license) is displayed in a different stream than expected.
| "Ops, this is the CNH Opened" | |wrongDocumentMessage\_CRLV: String
Message displayed when the CRLV(Brazilian Vehicle Registration and Licensing Certificate) is displayed in a different stream than expected.
| "Ops, this is the CRLV" | |wrongDocumentMessage\_RNE\_FRONT: String
Message displayed when the front of the RNE(National Registry of Foreigners) is displayed in a different stream than expected.
| "Ops, this is the RNE's Front" | |wrongDocumentMessage\_RNE\_BACK: String
Message displayed when the back of the RNE(National Registry of Foreigners) is displayed in a different stream than expected.
| "Ops, this is the RNE's Back" | |sensorLuminosityMessage: String
Message displayed when the brightness threshold is lower than expected.
| "Area near you is too dark" | |sensorOrientationMessage: String
Message displayed when the orientation threshold is lower than expected.
| "The device is not on the horizontal" | |sensorStabilityMessage: String
Message displayed when the orientation threshold is lower than expected.
| "Keep the device still" | ### **UploadSettings** To activate the document upload functionality it is necessary to instantiate an object of type **`UploadSettings`()** and set its parameters: | **Parameter** | **Required?** | | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | |enable
Enables/disables this feature.
| No. The default is **`true`** | |compress
Enables/disables file compression before uploading.
| No. The default is **`true`** | |fileFormats
Defines the file format(s) that will be accepted for upload.
| No. By default .PDF , .JPEG and .PNG are accepted | |maximumFileSize
Sets the maximum KB limit of the file to upload.
| No. The default limit is 10000 KB (10MB). | Currently, the supported file formats are: ```swift public enum FileFormat: String { case png case jpeg case pdf } ``` ## **Getting the result** To get the result, you must implement the **`DocumentDetectorControllerDelegate`** delegate in your controller: ```swift class YouController: UIViewController, DocumentDetectorControllerDelegate{ // MARK: - Document Detection Delegates func documentDetectionController(_ scanner: DocumentDetectorController, didFinishWithResults results: DocumentDetectorResult) { //Called when the process was successfully executed //The result variable contains the data obtained } func documentDetectionControllerDidCancel(_ scanner: DocumentDetectorController) { // Called when the user cancel } func documentDetectionController(_ scanner: DocumentDetectorController, didFailWithError error: DocumentDetectorFailure) { //Called when the process terminate with an error //The error variable contains info about error } } ``` After creating the **`DocumentDetector`** object, start the **`DocumentDetectorController`** by passing this object as a parameter in the constructor: ```swift let scannerVC = DocumentDetectorController(documentDetector: documentDetector) scannerVC.documentDetectorDelegate = self present(scannerVC, animated: true, completion: nil) ``` ### **DocumentDetectorResult** | **Parameter** | **Can it be null?** | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | |captures:\[Capture]
The array with the respective captures of the parameterized documents
| Yes, in case of error | |type: String
The class of the read document stream. This parameter is useful in an integration with our OCR route. The existing types are: \["blank", "cnh", "cnh\_new", "generic", "rg", "rg\_new", "rne", "rnm", "ctps", "passport, crlv, crlv\_new"]
trackingId: String?
Identifier of this run on our servers. If possible, save this field and send it along to our API. This way we will have more data about how the user behaved during the execution
| Yes, if the user sets **`useAnalytics = false`** or the analytics calls do not work | ### **Capture** | **Parameter** | **Can it be null?** | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | |image: UIImage
Document image
| No | |imageUrl :String
URL of the document on CAF's server. If you want this URL, keep enabled the parameter that checks the image quality
| Yes, if you choose not to check the image quality | |scannedLabel :String
Label of the respective document within the following possibilities: \["blank", "cnh\_back", "cnh\_front", "cnh\_full", "new\_cnh\_back", "new\_cnh\_front", "new\_cnh\_full", "crlv", "crlv\_new", "generic", "rg\_back", "rg\_front", "rg\_full", "rg\_new\_back", "rg\_new\_front", "rg\_new\_full", "rne\_back", "rne\_front", "rnm\_back", "rnm\_front", "ctps\_back", "ctps\_front", "passport"]
quality :Double
Quality inferred by the document quality algorithm, when enabled. Varies between 1.0 and 5.0
| May be 0, if the SDK does not check for quality | |lensFacing: Int
Defines the face of the camera that was used. Use DocumentDetectorResult.LENS\_FACING\_FRONT or DocumentDetectorResult.LENS\_FACING\_FRONT to validate.