String mobileToken
Usage token associated with your CAF account
| 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`** | |.setStabilitySensorSettings(message: String?, 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 is "Keep the phone still" and 1.5, respectively | |.setCaptureSettings( beforePictureInterval: TimeInterval?)
Changes the settings used for capturing the selfie. The parameter indicates the time in milliseconds between the correct face fitting and the actual capture of the picture.
| No. The standard is 2.0 | |setLayout(layout: PassiveFaceLivenessLayout)
Changes the document masks for success, failure and normal.
Also allows you to change the sound and cancel buttons at the top of the screen
| 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) | |.setProxySettings(proxySettings: ProxySettings?)
Sets the proxy settings, as explained here
| No. The default is **`nil`** | |.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.
.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 | |.setMessageSettings(waitMessage: String?, stepName: String?, faceNotFoundMessage: String?, faceTooFarMessage: String?, faceNotFittedMessage: String?, holdItMessage: String?, invalidFaceMessage: String?, multipleFaceDetectedMessage: String?, sensorStabilityMessage: String?, verifyingLivenessMessage: String?, eyesClosedMessage: String?)
Allows to customize messages displayed in the "status" balloon during the capture and analysis process.
| No. The pattern is [this](#messagesettings) | |.setPersonCPF(personCPF: String)
Binds a proof-of-life attempt to a cpf
| No. The default is **`nil`** | |.setPersonName(personName: String)
Binds a proof-of-life attempt to a name
| No. The default is **`nil`** | |.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)
Enable/disable multi-language support
| No. The default is enable | |.setVideoCaptureSettings(time: TimeInterval)
Allows you to enable and configure video capture.
| No. The default is disabled | |.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 onlysetGetImageUrlExpireTime("24h"): To set only hour(s)setGetImageUrlExpireTime("1h 10m"): To set hour(s) and minute(s)setGetImageUrlExpireTime("10d"): To set day(s).setImageCaptureSettings(beforePictureInterval: TimeInterval!, enableManualCapture: Bool, timeManualCapture: TimeInterval)
Allows you to set the capture per image. The beforePictureInterval attribute sets the time the user should stay with the face docked in the mask. The enableManualCapture attribute enables or disables manual capture. And timeManualCapture defines the time at which manual capture will be enabled.
.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`** | |.setEyesClosedSettings(threshold: Double, isEnable: Bool)
Allows you to customize the SDK's open-eye validation settings. The method takes as parameter isEnable to enable or disable the validation, and threshold, value between 0.0 and 1.0
.setResolutionSettings(resolution: Resolution)
Allows you to set the capture resolution. The method takes as parameter a Resolution, which has the following options:
.setStage(stage: CAFStage)
Allows you to choose the environment in wich the SDK will run (production, beta). The method takes as parameter an enum CAFStage to select the environment:
waitMessage: String
Message displayed when SDK is in the process of opening
| "Aguarde..." | |stepName: String
Static label present at the bottom of the activity
| "Registro facial" | |faceNotFoundMessage: String
Message displayed when the algorithm does not recognize a face
| "Não encontramos nenhum rosto" | |faceNotFittedMessage: String
Message displayed when the face is not fitted correctly to the mask
| "Encaixe seu rosto" | |faceTooFarMessage: String
Message displayed when there is a very small face
| "Aproxime o rosto" | |multipleFaceDetectedMessage: String
Message displayed when more than one face is detected
| "Mais de um rosto detectado" | |holdItMessage: String
Message displayed when the user is in the correct position for capture
| "Segure assim" | |invalidFaceMessage: String
Message displayed when proof-of-life verification rejects the selfie
| "Não conseguimos capturar seu rosto. Tente novamente." | |verifyingLivenessMessage: String
Message displayed during proof-of-life verification.
| "Verificando selfie…" | |captureProcessingErrorMessage: String
Message displayed when a processing problem or error occurs in the API response.
| "Ops, tivemos um problema ao processar sua imagem. Tente novamente." | |eyesClosedMessage: String
Message displayed when both eyes are closed.
| "Não use óculos escuros e mantenha os olhos abertos." | After creating an object of type **`PassiveFaceLiveness`**, start the **`PassiveFaceLivenessController`** by passing this object as a parameter in the constructor: ```swift let passiveVC = PassiveFaceLivenessController(passiveFaceLiveness: passiveFaceLiveness) passiveVC.passiveFaceLivenessDelegate = self present(passiveVC, animated: true, completion: nil) ``` ## **Getting the result** To get the result, you must implement the **`PassiveFaceLivenessControllerDelegate`** delegate in your controller: ```swift class YouController: UIViewController, PassiveFaceLivenessControllerDelegate{ // MARK: - Passive Faceliveness Delegates func passiveFaceLivenessController(_ passiveFacelivenessController: PassiveFaceLivenessController, didFinishWithResults results: PassiveFaceLivenessResult) { //Called when the process was successfully executed //The result variable contains the data obtained } func passiveFaceLivenessControllerDidCancel(_ passiveFacelivenessController: PassiveFaceLivenessController) { //Called when the process was canceled by the user } func passiveFaceLivenessController(_ passiveFacelivenessController: PassiveFaceLivenessController, didFailWithError error: PassiveFaceLivenessFailure) { //Called when the process terminate with an error //The error variable contains info about error } } ``` ### **PassiveFaceLivenessResult** | **Parameter** | **Can it be null?** | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | |image: UIImage?
Selfie picture taken or image of the best frame taken from the video - if VideoCapture format enabled.
| Yes, in case of error | |capturePath: String?
Path of the video on the device
| Yes, in case of error | |imageUrl: String
Url containing the jpeg selfie on our temporary server
| Yes, in case of error | |signedResponse: String
Signed response from the CAF server that confirmed that the captured selfie has a real face (it is not a snapshot or video). Use this parameter if you want an extra layer of security by checking that the signature of the response is not broken, caused by an interception of the request. If it is broken, there is a strong indication of request interception
| Yes, in case of error or server unavailability | |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 | |lensFacing: Int
Defines the face of the camera that was used. Use PassiveFaceLivenessResult.LENS\_FACING\_FRONT or PassiveFaceLivenessResult.LENS\_FACING\_FRONT to validate.