> For the complete documentation index, see [llms.txt](https://docs.caf.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.caf.io/caf-sdk/ios/standalone-modules/deprecated-sdks/release-notes-deprecated.md). # Old Release Notes ### Old release notes ### September 5th, 2024 #### `FaceAuth 6.0.0` **Breaking Changes** * Updated public models to unify Caf Products **Updates** * iOS minimum deployment target changed from `12.0` to `13.0` * **FingerPrint** SDK updated from `2.2.0` to `2.6.0` * **Iproov** SDK updated from `11.0.3` to `12.0.0` * Improved Analytics * New **CafSolutions** module dependency * * Distributing on [SPM](https://github.com/combateafraude/FaceLiveness) `Swift Package Manager` ### April 26th, 2024 #### `FaceLiveness 5.0.0` **Breaking changes** * Updated `public enum ErrorType: String` with new [errorTypes](https://github.com/combateafraude/public-docs/blob/docs-sdks/ios/deprecated-sdks/getting-started/faceliveness.md#error-cases). * Updated `SDKFailure` now only returns `errorType: ErrorType?` and `description: String?`, `code: Int?` was removed. Removed deprecated delegates: * Removed `didFinishLiveness(with faceLivenessResult: FaceLivenessResult)` from `FaceLivenessDelegate` , use `didFinishLiveness(with livenessResult: LivenessResult)`. * Removed `didFinishWithCancelled(with faceLivenessResult: FaceLivenessResult)` from `FaceLivenessDelegate` , use `didFinishWithCancelled()`. * Removed `didFinishWithError(with faceLivenessErrorResult: FaceLivenessErrorResult)` from `FaceLivenessDelegate` , use `didFinishWithError(with sdkFailure: SDKFailure)`. #### `FaceAuth 5.0.0` **Breaking changes** * Updated `public enum ErrorType: String` with new [errorTypes](https://github.com/combateafraude/public-docs/blob/docs-sdks/ios/deprecated-sdks/getting-started/caffaceauth.md#error-cases). * Removed `code: Int?` from `FaceAuthenticatorErrorResult`. ### April 19th, 2024 #### `DocumentDetector 9.0.1` **Fixes** * Token validation at SDK\`s start * Fixes `.setGetImageUrlExpireTime` method expiration * Fixes `.enableMultiLanguage()` method #### `DocumentDetector 8.1.6` **Fixes** * Token validation at SDK\`s start * Fixes `.setGetImageUrlExpireTime` method expiration ### April 5th, 2024 #### `DocumentDetector 9.0.0` **Highlights** * New AI for smart capture, based on analyzing the framing of documents. * Similarity between what is being shown on the screen camera and the captured/analyzed photo. * New design and capture experience. **News** * Added *TensorFlowLite* library dependency. * Added method *showStepLabel* to `DocumentDetectorstep`. * Added parameters *predictorScanDocumentMessage*, *predictorGetCloserMessage*, *predictorCentralizeMessage*, *predictorMoveAwayMessage*, *predictorAlignDocumentMessage*, *predictorTurnDocumentMessage*, *predictorCapturedMessage*,*wrongDocumentMessage* in the `setMessageSettings`. * Changed default resolution to **FULL\_HD**. * Changed default values used to compress pictures. * Removed audio playback at the beginning of the capture. * New UI/UX. **Breaking changes** * Renamed *setDocumentStep* to *setDocumentCaptureFlow*. * Removed methods *setMask* from `DocumentDetectorStep` and `DocumentDetectorSdk.Builder`. * Removed method *enableSound* from `DocumentDetectorSdkSdk.Builder`. * Removed methos *wrongDocumentMessage\_RG\_FRONT*, *wrongDocumentMessage\_RG\_BACK*, *wrongDocumentMessage\_RG\_FULL*, *wrongDocumentMessage\_CNH\_FRONT*, *wrongDocumentMessage\_CNH\_BACK*, *wrongDocumentMessage\_CNH\_FULL*, *wrongDocumentMessage\_CRLV*, *wrongDocumentMessage\_RNE\_FRONT*, *wrongDocumentMessage\_RNE\_BACK* from `setMessageSettings`. * Changed to *FULL\_HD* and *ULTRA\_HD* options in the `Resolution`. * Removed *setDetectionSettings* from `DocumentDetectorSdk.Builder`. * Removed *setQualitySettings* from `DocumentDetectorSdk.Builder`. * Removed *OTHERS* from `Document`. Use *ANY* to capture any type of document. * Changes in the `DocumentDetectorLayout` used in *setLayout* method: * Renamed parameter *closeImage* to *closeButtonImage* * Renamed parameter *buttonSize* to *closeButtonSize* * Renamed parameter *buttonContentMode* to *closeButtonContentMode* * Added parameter *closeButtonColor* * Added parameter *primaryColor* * Added parameter *feedbackColors* * Removed method *changeMaskImages* * Removed method *changeSoundImages* * Removed *setColorTheme* from `DocumentDetectorSdk.Builder`. The main color can now be set with the *primaryColor* parameter in `setLayout` method. * Renamed *scannedLabel* to *label* in `DocumentDetectorResult -> captures -> Capture`. * Changed minimum deployment target from *11.0* to *12.0*. ### March 27th, 2024 #### `FaceLiveness 4.0.0` **New Features** *FingerprintJS SDK*: We have integrated [FingerprintPro v2.2.0](https://github.com/fingerprintjs/fingerprintjs-pro-ios/releases/tag/2.2.0) into our platform, enhancing security and user identification capabilities. **Enhancements** *IProov Update*: We have updated IProov from v11.0.2 to [v11.0.3](https://github.com/iProov/ios/releases/tag/11.0.3), improving the performance and reliability of our facial authentication features. *Genuine Presence Assurance (GPA) Option*: We have implemented GPA option within our SDK workflow. It introduces a refreshed user interface and focuses on fraud prevention, significantly reducing the occurrence of counterfeiting. This functionality aims to enhance security without compromising usability, providing a powerful tool to validate the genuine presence of the user. #### `FaceAuth 4.0.1` **Enhancements** *FaceLiveness update*: We have updated FaceLiveness from v3.1.9 to [v4.0.0](#faceliveness-400), improving security, user identification, performance and realiability of our facial authentication features. #### Breaking changes ⚠️ **FaceLiveness SDK** We have made several changes to the FaceLiveness SDK to improve its efficiency and user experience. Please note the following modifications: * **Removed Methods**: * `.setCredentials(mobileToken: String, personId: String)` * **New Method**: * `startSDK(mobileToken: String, personId: String)` has been updated to include new fields. * **FaceLivenessDelegate Changes**: * Removed: * `didFinishWithFail(with faceLivenessFailResult: FaceLivenessFailResult)` * Deprecated: * `didFinishLiveness(with faceLivenessResult: FaceLivenessResult)` * `didFinishWithCancelled(with faceLivenessResult: FaceLivenessResult)` * `didFinishWithError(with faceLivenessErrorResult: FaceLivenessErrorResult)` * New Functions: * `didFinishLiveness(with livenessResult: LivenessResult)` * `didFinishWithCancelled()` * `didFinishWithError(with sdkFailure: SDKFailure)` * `onConnectionChanged(_ state: LivenessState)` **FaceAuth SDK** We have updated the FaceAuth SDK to streamline authentication processes and delegate methods. * **Removed Methods**: * `.setCredentials(mobileToken: String, personId: String)` * **New Method**: * `startFaceAuthSDK(mobileToken: String, personId: String)` has been updated to include new fields. * **FaceAuthSDKDelegate Changes**: * Removed: * `didFinishWithCancell(with faceAuthenticatorResult: FaceAuthenticator.FaceAuthenticatorResult)` * New Function: * `didFinishFaceAuthWithCancelled()` #### Upgrade Guidance Developers integrating our SDKs should review these changes carefully and update their applications to comply with the new interfaces and methods. We recommend testing your application thoroughly to ensure compatibility. For detailed information on migrating to the new SDK versions, please refer to the SDKs documentation [FaceLiveness](https://github.com/combateafraude/public-docs/blob/docs-sdks/ios/ios/getting-started/newliveness.md) & [FaceAuth](https://github.com/combateafraude/public-docs/blob/docs-sdks/ios/ios/getting-started/newfaceauthenticator.md). ### February 15th, 2024 * `DocumentDetector` 8.1.4 * **Improvements**: * Improves document compression quality uploads * **Fixes**: * Fixes low quality images upload flow ### February 10th, 2024 * `DocumentDetector` 8.1.3 * **Improvements**: * Improves document identification on the upload flow * Adjusting the handling of metadata in pdf files * Adjustments to consumption record tracking * **Fixes**: * Fixes api timeout issue on upload * Fixes pdf upload conversion * Fixes maximum file size message and validation on upload flow * Fixes back button function from upload flow ### January 26th, 2024 * `DocumentDetector` 8.1.2 * **Fixes**: * Pdf file upload quality (the resolution of the upload needed to be fixed, we improve the quality for this latest release) ### January 9th, 2024 * `DocumentDetector` 8.1.1 * **Feature**: * Sets the default resolution to .hd1920x1080 * **Fixes**: * Fixes image url output (the url of the successful output document was wrong, it didn’t work, we updated for the correct one) ### December 18th, 2023 * `DocumentDetector` 8.1.0 * **Feature**: * Remove Sentry dependency * **Fixes**: * Fixes timeout issue (timeout could lead to app freeze in some specific cases) * Fixes recapture issue (after recapturing the document for a few times, the camera validation would freeze) * Fixes preview screen dismiss (the preview page was bein presented as `UIModalPresentationPageSheet` and dismissing it lead to camera freeze) {% hint style="info" %} `DocumentDetector` will no longer support `Sentry`, `DocumentDetectorNoSentry` won’t have new releases {% endhint %} ### December 11th, 2023 * `FaceLiveness` 3.1.9 * Update iProov version 11.0.2 * `FaceAuth` 3.1.11 * Update iProov version 11.0.2 ### December 8th, 2023 * `FaceLiveness` 3.1.8 * Fixing the default value of the expiration time function * `FaceAuth` 3.1.9 * Fixing the default value of the expiration time function ### November 28th, 2023 * `DocumentDetector` 8.0.6 * `DocumentDetectorNoSentry` 8.0.6 * **Fixes**: * Add Swift 5.8.1 compatibility (xcode 14.3.1) ### Novenber 27th * `FaceLiveness` 3.1.6 * New .setImageUrlExpirationTime(Time time) Used to customize the image url expiration time. * `FaceAuth` 3.1.8 * New .setImageUrlExpirationTime(Time time) Used to customize the image url expiration time. ### November 24th, 2023 * `DocumentDetector` 8.0.5 * `DocumentDetectorNoSentry` 8.0.5 * **Fixes**: * Fixes to document upload flow * Infinite loading icon during capture * Focus issue on recent devices (camera management) ### October 11st, 2023 * `FaceAuth` 3.1.7 * Iproov update version and starscream removed * `FaceLiveness` 3.1.5 * Iproov update version and starscream removed ### October 11st, 2023 * `FaceAuth` 3.1.5 * Apple updates improvements * `FaceLiveness` 3.1.4 * Apple updates improvements ### October 3rd, 2023 * `DocumentDetector` 8.0.4 * `DocumentDetectorNoSentry` 8.0.4 * **Fixes**: * Camera start delay ### September 15st, 2023 * `FaceAuth` 3.1.2 * New return objects `FaceAuthenticatorFailResult`, `FaceAuthenticatorErrorResult` * Adding signedResponse in `FaceAuthenticatorFailResult` * Adding new builder function to set a loading screen * `FaceLiveness` 3.1.2 * New return objects `FaceLivenssFailResult` , `FaceLivenessErrorResult` * Adding signedResponse in `FaceLivenessFailResult` * Register fail attempts * Adding new builder function to set a loading screen ### September 6st, 2023 * `FaceAuth` 2.7.0 * Adding a new delegate function to capture the error type ### September 6st, 2023 * `FaceLiveness` 2.7.0 * Adding a new delegate function to capture load times to apply loading screan * `FaceAuth` 2.6.0 * Adding a new delegate function to capture load times to apply loading screan ### September 1st, 2023 * `FaceLiveness` 2.6.0 * Adding a new way to capture errors at the end of execution * General code improvements * `FaceAuth` 2.5.0 * Adding a new way to capture errors at the end of execution ### August 28nd, 2023 * `FaceLivenss` 2.5.0 * `FaceAuth` 2.4.0 * **Fixes**: * This release addresses an issue caused by an update in the external service, which has now been adjusted. ### August 18nd, 2023 * `DocumentDetector` 8.0.3 * Matching sdk's versions * `DocumentDetectorNoSentry` 8.0.3 * **Fixes**: * Cleaning up some Sentry related packages and dependencies that were still present on code and causing update conflicts ### August 14nd, 2023 * `DocumentDetector` 8.0.2 * Matching sdk's versions * `DocumentDetectorNoSentry` 8.0.2 * **Fixes**: * Cleaning up some Sentry related packages and dependencies that were still present on code and causing update conflicts ### August 11nd, 2023 * `DocumentDetector` 8.0.1 * **Fixes**: * Fixed ImageUrl output * Fixed Quality output #### August 11nd, 2023 * `FaceAuth` 2.1.0 * New FaceAuth result return `signedResponse`. Signed response from the CAF server confirming that the captured selfie has a real face. #### August 4nd, 2023 * `FaceAuth` 1.9.0 * New method `.setFilter(filter: Filter)`. Used to change the SDK filter. * `FaceLiveness` 1.4.0 * New method `.setFilter(filter: Filter)`. Used to change the SDK filter. ### August 2nd, 2023 * `DocumentDetector`**8.0.0** * **What's new**: * CIN/New RG support: This new model is treated as a type of RG on user selection. * New and improved back-end API: Many security features were implemented to improve and block image injection cases, better cryptography, and new ways to transfer data. * New developer method (.setStage(CafStage stage)): This method allows developers to change the environment/resources/account that the SDK points to without the need to have a separate one or to generate a new SDK version only for that. * **What we improved**: * Added security countermeasures and performance improvements. * Correction of some typos and misspellings. * **Important/Breaking changes**: 1. The "imageUrl" SDK param result has been changed to: "" ### 24 de abril de 2023 * `DocumentDetector`**7.12.2** * **Correção**: Lentidão ao iniciar o SDK. ### 06 de abril de 2023 * `DocumentDetector`**7.12.1** * **Correção**: Upload de documentos (cnh digital) * **Melhoria**: Ilustrações dos documentos RG e CNH abertos quando solicitados. ### 13 de março de 2023 * `DocumentDetector`**7.12.0** * **Correção**: Captura de Passaporte e nova CNH em iOS. * **Melhoria**: Mensagens exibidas no fluxo de upload de documentos, para melhor UX. ### 18 de janeiro de 2023 * `DocumentDetector`**7.12.0-rc02** * **Novo**: Suporte a arm64 nos simuladores. * **Mudança**: O TensorFlow foi removido. Agora, é o utilizado a CoreML para execução do modelo de análise e detecção automática de documentos. ### 20 de dezembro de 2022 * `DocumentDetector`**7.10.0** * **Novo**: Método permite habilitar a opção de permitir passaportes de somente um determinado país emissor, ou, uma lista de países. Use `.setAllowedPassportCountriesList([CountryCodes])` para habilitar. ### 19 de dezembro de 2022 * `PassiveFaceLiveness` **6.0.0-rc02** * **Correção**: Retorno dos campos `imageUrl` e `signedResponse` da classe `PassiveFaceLivenessResult`. ### 16 de dezembro de 2022 * `PassiveFaceLiveness` **6.0.0-rc01** * **Melhoria**: Correções de vulnerabilidades e diversas melhorias importantes de segurança; * **Melhoria**: Performance e diminuição de latência em requisições; * **Mudança**: `CAFStage.OTHER` foi removido. Utilize a configuração padrão; * **Correção**: Validação de olhos fechados não era aplicada em alguns cenários. * **Novo**: Suporte a arquitetura `arm64` para simuladores. ### 07 de novembro de 2022 * `DocumentDetector` **7.9.0** * **Novo**: Suporte ao idioma espanhol (es-MX). * **Mudança**: Downgrade da versão do TensorFlowLiteSwift para 2.4.0 por problemas de integração em alguns projetos. * **Correção**: Exception "should be called from background thread". * `PassiveFaceLiveness` **5.25.0** e `FaceAuthenticator` **5.11.0** * **Novo**: Suporte ao idioma espanhol (es-MX). * **Correção**: Exception "should be called from background thread". > Para habilitar texto e voz em Espanhol, adicione em **Project > Info > Localizations** o idioma `Spanish`. ### 24 de outubro de 2022 * `DocumentDetector` **7.8.0** * **Melhoria**: A versão do TensorFlowLiteSwift foi atualizada para 2.10.0. * **Melhoria**: Agora os parâmetros `stepLabel`, `illustration` e `audio` da classe `DocumentDetectorStep` são opcionais. * **Novo**: Suporte a arquitetura `arm64` para simuladores. * `PassiveFaceLiveness` **5.24.0** * **Novo**: Recurso de bloqueio por tentativas. Agora, cada usuário só poderá realizar no máximo cinco tentativas nas últimas 24 horas. O limite é fixo, baseado no padrão de quantidade de tentativas entre fraudadores. Em caso de excesso tentativas, o SDK retornará um `SDKFailure` com instância de `SecurityReason`, com valores `message` = "Não foi possível realizar essa ação. Entre em contato com o suporte" e `code` = 700. > IMPORTANTE: Recomendamos fortemente, para o melhor funcionamento, que seja enviado o CPF do usuário no método `.setPersonId` * **Correção**: Configuração do tempo de expiração de `imageUrl`. * **Novo**: Suporte a arquitetura `arm64` para simuladores. * `FaceAuthenticator` **5.10.0** * **Novo**: Recurso de bloqueio por tentativas. Agora, cada usuário só poderá realizar no máximo cinco tentativas nas últimas 24 horas. O limite é fixo, baseado no padrão de quantidade de tentativas entre fraudadores. Em caso de excesso tentativas, o SDK retornará um `SDKFailure` com instância de `SecurityReason`, com valores `message` = "Não foi possível realizar essa ação. Entre em contato com o suporte" e `code` = 700. > IMPORTANTE: Recomendamos fortemente, para o melhor funcionamento, que seja enviado o CPF do usuário no método `.setPeopleId` * **Novo**: Suporte a arquitetura `arm64` para simuladores. ### 14 de outubro de 2022 * `DocumentDetector` **7.6.0** * **Novo**: Suporte à captura de novos modelos de CRLV. ### 26 de agosto de 2022 * `DocumentDetector` **7.5.0-rc01** * **Novo**: Recurso de estágios de captura! Agora, o mesmo recurso de CaptureStages presente em DocumentDetector Android está disponível para iOS. Para mais detalhes, acesse a documentação [aqui](https://docs.combateafraude.com/docs/mobile/ios/capture-stages). Utilize o método `.setCaptureStages(captureStages: [CaptureStage])` para personalizar. Exemplo: ```swift .setCaptureStages([ .init( durationMillis: 20000, wantSensorCheck: true, qualitySettings: .init(threshold: 1.8), detectionSettings: .init(threshold: 0.91), captureMode: .AUTOMATIC ), .init( durationMillis: 15000, wantSensorCheck: false, qualitySettings: .init(threshold: 1.8), detectionSettings: .init(threshold: 0.91), captureMode: .AUTOMATIC ), .init( durationMillis: 10000, wantSensorCheck: false, qualitySettings: .init(threshold: 1.8), detectionSettings: .init(threshold: 0.91), captureMode: .MANUAL ), .init( durationMillis: nil, wantSensorCheck: false, qualitySettings: .init(threshold: 1.8), detectionSettings: nil, captureMode: .MANUAL ), ]) ``` ### 19 de agosto de 2022 * `PassiveFaceLiveness` **5.22.0** * **Novo**: Método que permite customizar a validação de olhos abertos no SDK, utilize o método `.setEyesClosedSettings(threshold: Double, isEnable: Bool)` no Builder. * **Novo**: Método para personalização de mensagem exibida quando ocorre um problema no processamento ou erro na response da API. Utilize `captureProcessingErrorMessage` no método `setMessageSettings`. * **Melhoria**: Alteração da mensagem padrão exibida quando a verificação de prova de vida recusa a selfie. Utilize `.invalidFaceMessage` no método `setMessageSettings`. * **Novo**: Método para personalização de mensagem exibida quando são detectados dois olhos fechados. Utilize `eyesClosedMessage` no método `setMessageSettings`. * **Novo**: Retorno de face da câmera utilizada para captura através do parâmetro `lensFacing`. Exemplo: ```swift if(result.lensFacing == PassiveFaceLivenessResult.LENS_FACING_FRONT){ //Câmera frontal } ``` * `FaceAuthenticator` **5.4.0** * **Novo**: Método que permite customizar a validação de olhos abertos no SDK, utilize o método `.setEyesClosedSettings(threshold: Double, isEnable: Bool, errorMessage: String)` no Builder. * **Novo**: Método para personalização de mensagem exibida quando ocorre um problema no processamento ou erro na response da API. Utilize `captureProcessingErrorMessage` no método `setMessageSettings`. * **Melhoria**: Alteração da mensagem padrão exibida quando a verificação de prova de vida recusa a selfie. * **Novo**: Retorno de face da câmera utilizada para captura através do parâmetro `lensFacing`. Exemplo: ```swift if(result.lensFacing == FaceAuthenticatorResult.LENS_FACING_FRONT){ //Câmera frontal } ``` ### 12 de agosto de 2022 * `DocumentDetector` **7.3.0** * **Melhoria**: Suporte à captura de novos modelos de CNH. ### 05 de agosto de 2022 * `DocumentDetector` **7.2.0** * **Melhoria**: Novo modelo de Inteligência Artificial para detecção de documentos com melhorias de acurácia. * **Correção**: Retorno de `imageUrl` em caso da verificação de qualidade estiver desabilitada com o método `.setQualitySettings` ### 08 de julho de 2022 * `PassiveFaceLiveness` **5.20.0** * **Novo**: Retorno de `imagePath` contendo a selfie em .jpeg para o formato de captura por vídeo. Agora, os retornos são: * `image: UIImage?`: UIImage do melhor frame do vídeo; * `capturePath: String?`: Caminho do vídeo no dispositivo; * `imageUrl: String`: Url contendo a selfie em jpeg em nosso servidor temporário. * **Novo**: Agora o Preview pode ser habilitado também para o formato de captura por vídeo. Utilize o método `.showPreview`. * **Mudança**: Agora o fluxo de Preview de captura é exibido depois da validação de prova de vida. ### 27 de maio de 2022 * `DocumentDetector` **7.0.0** * **Novo**: Agora permitimos o envio de fotos/arquivos por meio de upload de documentos! Utilize o método `.setUploadSettings()` para habilitar. * **Novo**: Suporte a captura do tipo `ANY`. Utilize `Document.ANY` no `DocumentDetectorStep` para permitir a captura de qualquer imagem. Esse fluxo não requisita um documento na máscara e não realiza tipificação. O modo de captura será sempre MANUAL, com verificação de qualidade. Não esqueça de adicionar a permissão `NSPhotoLibraryUsageDescription` para acesso a galeria. * **Novo**: Suporte a integrações em Objective-C. * `PassiveFaceLiveness` **5.17.0** * **Novo**: Suporte a integrações em Objective-C. ### 20 de maio de 2022 * `DocumentDetector` **6.13.0**, `PassiveFaceLiveness` **5.16.0** * **Novo**: Tipificação de documento e verificação de qualidade em captura manual! * **Correção**: Resolução de bug de audio multi-idioma. * **Novo**: Variáveis de interceptação de estado e visibilidade. Confira as atualizações na seção [customização](https://docs.combateafraude.com/docs/mobile/ios/customization) ### 06 de maio de 2022 * `DocumentDetector` **6.12.0** * **Novo**: Suporte a captura de Passaporte e CTPS. Utilize o `Document.PASSPORT`, `Document.CTPS_FRONT` e `Document.CTPS_BACK`. * **Novo**: Novo recurso de aplicação de delay ao finalizar um step. Utilize `.setCurrentStepDoneDelay(currentStepDoneDelay: TimeInterval)`. * **Novo**: Mensagem de verificação de selfie. Utilize `.setMessageSettings(popupDocumentSubtitleMessage: String?)`. * **Melhoria**: Melhorias em desempenho e memory leaks. * **Novo**: Novo recurso de customização de máscara: agora permitimos remover uma máscara por completo. Utilize `.setMask(maskType: .empty)` * `PassiveFaceLiveness` **5.15.0** * **Novo**: Novo recurso de aplicação de delay ao finalizar um step. Utilize `.setCurrentStepDoneDelay(currentStepDoneDelay: TimeInterval)`. * **Novo**: Customização de subtítulo de popup. Utilize `.setMessageSettings(verifyingLivenessMessage: String?)`. * **Melhoria**: Melhorias em desempenho e memory leaks. * **Novo**: Novo recurso de customização de máscara: agora permitimos remover uma máscara por completo. Utilize `.setMask(maskType: .empty)` ### 25 de março de 2022 * `DocumentDetector` **6.4.0**, `PassiveFaceLiveness` **5.9.0** e `FaceAuthenticator` **5.2.0** * **Melhoria**: Retrocompatibilidade com versões acima do Xcode 12.0 e Swift 5.3. * **Mudança**: Agora a visibilidade dos métodos da classe `Builder` torna-se `open`. * **Correção**: Melhoria em recursos de multi-idioma. * **Mudança**: O método `.enableMultiLanguage` passa a receber o parâmetro `enable` de forma anônima. ### 04 de março de 2022 * `DocumentDetector` **6.2.0** * **Novo**: Método para personalização de resolução de captura de imagem `.setResolutionSettings(resolution: Resolution)`. Para mais informações, consulte a [documentação oficial da Apple](https://developer.apple.com/documentation/avfoundation/avcapturesession/preset). Você pode utilizar as resoluções: * `LOW` * `MEDIUM` * `HIGH` * `PHOTO` * `INPUT_PRIORITY` * `HD1280x720` * `HD1920x1080` * `hd4K3840x2160` * `iFrame960x540` * `iFrame1280x720` * `VGA640x480` * **Novo**: Método para personalização de compressão de imagem `.setCompressSettings(compressionQuality: CGFloat)`. Utilize valores entre 0.0 (pior) à 1.0 (melhor). * **Melhoria**: Otimização no processo de captura. * `PassiveFaceLiveness` **5.7.0** * **Novo**: Captura de selfie por vídeo! Ao habilitar essa configuração, utilizamos mais frames para validar a autenticidade da selfie. Utilize o método `.setVideoCaptureSettings(time: TimeInterval)`. O SDK retorna como resultado o melhor frame do vídeo e você pode obter a url temporária através do atributo `imageUrl` na classe `PassiveFaceLivenessResult`. O padrão de resolução para captura de vídeo é `qHD` (540x960px). * **Limitações**: * O modo de captura será MANUAL. O modo de reconhecimento facial e captura automáticos não estão disponíveis atualmente. * Sensores são desativados nesse modo, como em qualquer captura MANUAL. * O uso do preview é desabilitado. * Validações de enquadramento e angulação de face não são realizadas nessa versão. * **Novo**: Atributo `capturePath` na classe `PassiveFaceLivenessResult`, para obter o caminho do vídeo salvo temporariamente no dispositivo. Esse atributo retornará `nil` em capturas por Imagem. * **Novo**: Método `.setImageCaptureSettings(beforePictureInterval: TimeInterval!, enableManualCapture: Bool, timeManualCapture: TimeInterval)` para configuração de captura por imagem. * **Novo**: Método para personalização de resolução de captura de imagem. `.setResolutionSettings(resolution: Resolution)` * **Novo**: Método para personalização de compressão de imagem `.setCompressSettings(compressionQuality: CGFloat)` * **Novo**: Suporte à API Beta. Utilize o método `.setStage(stage: CAFStage)` para realizar autenticações faciais em ambiente beta. * **Melhoria**: Otimização no processo de captura. * **Correção**: Remoção da solicitação de permissão de acesso a galeria em captura por vídeo. * `FaceAuthenticator` **5.1.0** * **Melhoria**: Otimização no processo de captura. * **Correção**: Remoção da solicitação de permissão de acesso a galeria em captura por vídeo. * **Novo**: Novo formato! Agora, os SDK's são distribuídos no formato .XCFramework, garantindo mais flexibilidade na integração em diferentes contextos de ambiente de desenvolvimento. * **Mudança**: A classe `FaceAuthenticator.swift` foi refatorada para `FaceAuthenticatorSdk.swift`. * **Novo**: Suporte à API Beta. Utilize o método `.setStage(stage: CAFStage)` para realizar autenticações faciais em ambiente beta. * **Novo**: Método para personalização de resolução de captura de imagem `.setResolutionSettings`. * **Novo**: Método para configuração da compressão de imagem `.setCompressSettings(compressionQuality: CGFloat)`. * **Novo**: Método para definir a modo de captura `.setVideoCaptureSettings(time: TimeInterval)` e `.setImageCaptureSettings(beforePictureInterval: TimeInterval!, enableManualCapture: Bool, timeManualCapture: TimeInterval)`. * **Correção**: Remoção da solicitação de permissão de acesso a galeria em captura por vídeo. ### 11 de fevereiro de 2022 * `DocumentDetector` **6.0.0**, `PassiveFaceLiveness` **5.0.0** * **Novo**: Novo formato! Agora, os SDK's são distribuídos no formato .XCFramework, garantindo mais flexibilidade na integração em diferentes contextos de ambiente de desenvolvimento. * **Mudança**: As classes `DocumentDetector.swift` e `PassiveFaceLiveness.swift` foram refatoradas para `DocumentDetectorSdk.swift` e `PassiveFaceLivenessSdk.swift`, respectivamente. ### 10 de janeiro de 2022 * `DocumentDetector` **5.1.0**, `PassiveFaceLiveness` **4.1.0** * **Mudança**: O parâmetro `message` dos métodos `setLuminositySensorSettings`, `setOrientationSensorSettings` e `setStabilitySensorSettings` foi removido. Agora, utilize `sensorLuminosityMessage`, `sensorOrientationMessage` e `sensorStabilityMessage` no método `setMessageSettings`. * **Correção**: Bug visual na tela de Preview em dark mode. ### 27 de dezembro de 2021 (atualizações de segurança) * `DocumentDetector` **5.0.0**, `PassiveFaceLiveness` **4.0.0** e `FaceAuthenticator` **4.0.0** * **Novo**: Utilização de SSL Pinning em todas requisições realizadas aos servidores da CAF. Esse recurso fornece mais segurança, evitando interceptações ou ataques Man In The Middle. Agora, os SDK's confiam apenas em um conjunto de certificados, além das verificações fundamentais durante o handshake SSL (validade do certificado, integridade do certificado, etc.) ### 23 de dezembro de 2021 * `DocumentDetector` **4.10.0**, `PassiveFaceLiveness` **3.9.0** e `FaceAuthenticator` **3.1.0** * **Novo**: Suporte Xcode 13.2 e Swift 5.5.2. * `FaceAuthenticator` **3.0.0** * **Novo**: Capture de face por vídeo! Ao habilitar essa configuração, utilizamos mais frames para validar a autenticidade da selfie utilizada para o facematch. Utilize o método `.setVideoCaptureSettings(time: TimeInterval)`. Caso esse recurso seja habilitado, a captura será sempre MANUAL. * **Novo**: Método `.setImageCaptureSettings(beforePictureInterval: TimeInterval!, enableManualCapture: Bool, timeManualCapture: TimeInterval)` para configuração de captura por imagem. * **Mudança**: O método `.setCaptureSettings` foi removido. * **Mudança**: O método `.setManualCaptureSettings` foi removido. ### 12 de novembro de 2021 * `DocumentDetector` **4.9.0**, `PassiveFaceLiveness` **3.8.0** e `FaceAuthenticator` **2.6.0** * **Novo**: Suporte Xcode 13.1 e Swift 5.5.1. ### 18 de outubro de 2021 * `DocumentDetector` **4.7.8** * **Mudança**: O método `.setMessageSettings(messageSettings: MessageSettings)` foi modificado para `.setMessageSettings(waitMessage: String?, fitTheDocumentMessage: String?, verifyingQualityMessage: String?, lowQualityDocumentMessage: String?, uploadingImageMessage: String?)`. Todos parâmetros são opcionais. * **Novo**: Atributo `waitMessage` no método `.setMessageSettings` para configuração da mensagem no status de "aguarde". * **Melhoria**: O parâmetros de personalização de String do método `.showPreview(_ show: Bool, title: String?, subtitle: String?, confirmLabel: String?, retryLabel: String?)` passam a ser opcionais. * `PassiveFaceLiveness` **3.6.8** * **Mudança**: O método `.setMessageSettings(messageSettings: MessageSettings)` foi modificado para `.setMessageSettings(waitMessage: String?, stepName: String?, faceNotFoundMessage: String?, faceTooFarMessage: String?, faceNotFittedMessage: String?, holdItMessage: String?, invalidFaceMessage: String?, multipleFaceDetectedMessage: String?)`. Todos parâmetros são opcionais. * **Novo**: Atributo `waitMessage` no método `.setMessageSettings` para configuração da mensagem no status de "aguarde". * **Melhoria**: O parâmetros de personalização de String do método `.showPreview(_ show: Bool, title: String?, subtitle: String?, confirmLabel: String?, retryLabel: String?)` passam a ser opcionais. * `FaceAuthenticator` **2.5.0** * **Novo**: Captura manual! Por padrão, a captura manual é habilitada em 10 segundos por meio de um botão. Para configurar o tempo ou desativar o método de captura, utilize `.setManualCaptureSettings(enable: Bool, time: TimeInterval)`. * **Mudança**: Agora ao informar um `peopleId` que não possui um registro facial o SDK finalizará com um `SDKFailure` com instancia de `InvalidFaceReason`. ### 21 de setembro de 2021 * `DocumentDetector` **4.7.6**, `PassiveFaceLiveness` **3.6.7** e `FaceAuthenticator` **2.4.1** * **Novo**: Suporte Xcode 13 e Swift 5.5. ### 09 de setembro de 2021 * `DocumentDetector` **4.7.5** * **Correção**: Disponibilização do botão de captura após reinicialização de captura manual. * **Melhoria**: Melhorias de desempenho. * `PassiveFaceLiveness` **3.6.6** * **Correção**: Crash em caso de detecção de spoof na validação de prova de vida. * **Correção**: Disponibilização do botão de captura após reinicialização de captura manual. * **Melhoria**: Melhorias de desempenho. * **Melhoria**: Em caso de detecção de alto consumo de memória, é habilitada a captura manual para evitar erros de OutOfMemory. ### 27 de agosto de 2021 * `DocumentDetector` **4.7.3**, `PassiveFaceLiveness` **3.6.4** * **Novo**: Método `.enableMultiLanguage(enable: Bool)` para habilitar/desabilitar suporte à multi-idioma. * **Correção**: Desabilita fechamento por swipe down na tela de Preview. ### 10 de agosto de 2021 * `DocumentDetector` **4.7.0**, `PassiveFaceLiveness` **3.6.0** * **Novo**: Suporte à multi-idioma, com detecção automatica (Inglês e Português) do idioma do dispositivo. Você deve adicionar o idioma `Portuguese (Brazil)` em **Project > Info > Localizations**. * **Novo**: Captura manual disponível! Para habilitar, utilize o método `.setManualCaptureSettings`. * **Melhoria**: Responsividade na tela de Preview. ### 12 de julho de 2021 * `DocumentDetector` **4.5.0**, `PassiveFaceLiveness` **3.4.0** e `FaceAuthenticator` **2.4.0** * **Novo**: Customização de view disponível! Para mais informações, confira [aqui](https://docs.combateafraude.com/docs/mobile/ios/customization). ### 07 de julho de 2021 * `DocumentDetector` **4.4.7** e `PassiveFaceLiveness` **3.3.10** * **Correção**: Tratamento em caso de servidor indisponível. * **Melhoria**: Atualização da biblioteca Sentry para versão 7.1.3. ### 23 de junho de 2021 * `DocumentDetector` **4.4.6** e `PassiveFaceLiveness` **3.3.9** * **Melhoria**: Compatibilidade entre diferentes versões do Swift. ### 14 de junho de 2021 * `DocumentDetector` **4.4.5** e `PassiveFaceLiveness` **3.3.8** * **Novo**: Personalização do tempo de expiração de `imageUrl`. Utilize o método `.setGetImageUrlExpireTime` informando um `Time`. * **Novo**: Agora é possível personalizar a fonte dos textos exibidos nos SDK's. Utilize o método `.setFont` em `{SDKName}Layout`. ### 21 de maio de 2021 * `PassiveFaceLiveness` **3.3.5** * **Novo**: Método `.setPersonCPF` para vincular um CPF a uma tentativa de prova de vida. * **Novo**: Método `.setPersonName` para vincular um nome a uma tentativa de prova de vida. ### 29 de abril de 2021 * `DocumentDetector` **4.4.2**, `PassiveFaceLiveness` **3.3.2** e `FaceAuthenticator` **2.3.2** * **Melhoria**: Suporte à versão 14.5 do iOS, 5.4 do Swift e 12.5 do Xcode. ### 12 de abril de 2021 * `FaceAuthenticator` **2.3.0** * **Melhoria**: Remoção da dependência Alamofire. Agora, todas as requisições são realizadas nativamente. * **Correção**: Correções de bugs na inicialização em integrações Flutter. ### 30 de março de 2021 * `PassiveFaceLiveness` **3.3.0** * **Novo**: Agora é possível personalizar as mensagens exibidas no balão de status. Instancie um objeto `MessageSettings` e utilize os métodos conforme necessidade de personalização. Para mais detalhes, confira [aqui](https://docs.combateafraude.com/docs/mobile/ios/passive-face-liveness#messagesettings). ### 25 de março de 2021 * `DocumentDetector` **4.4.0** * **Novo**: Suporte à captura de Registro Nacional Migratório (RNM). Para habilitar, basta definir um `DocumentDetectorStep` com `Document.RNE` (captura RNE e RNM). * **Melhoria**: Tratamento de exceção caso o dispositivo apresente uma câmera indisponível. Nesses casos, retorna-se didFailWithError com instância de LibraryReason e uma mensagem indicando o erro. * **Melhoria**: Atualização da biblioteca TensorFlowLite. * `PassiveFaceLiveness` **3.2.1** * **Melhoria**: Tratamento de exceção caso o dispositivo esteja com uma câmera indisponível. Nesses casos, retorna-se didFailWithError com instância de LibraryReason e uma mensagem indicando o erro. ### 15 de março de 2021 * `AddressCheck` **4.0.1** * **Novo**: Lançamento do SDK AddressCheck para consulta de endereços. ### 05 de março de 2021 * `DocumentDetector` **4.3.2** * **Correção**: Ajustes na detecção automática do verso de documentos em alguns dispositivos ### 04 de março de 2021 * `DocumentDetector` **4.3.0** e `PassiveFaceLiveness` **3.2.0** * **Novo**: Apresenta nova funcionalidade de pré-visualização de captura. Para habilitar, basta utilizar o método `.showPreview`. * **Correção**: Correção no retorno de erro em caso de token inválido * **Correção**: Correção de bug na detecção de documento ### 21 de janeiro de 2021 * `FaceAuthenticator` **2.2.1**, `DocumentDetector` **4.2.2** e `PassiveFaceLiveness` **3.1.2** * **Melhoria**: Compatibilidade com as versões 12.+ do Xcode e 5.+ do Swift ### 14 de janeiro de 2021 * `DocumentDetector` **4.2.0** * **Novo**: Suporte à roteamento de requisições com proxy. Para mais detalhes, veja [aqui](https://docs.combateafraude.com/docs/mobile/ios/proxy#proxySettings) * `PassiveFaceLiveness` **3.1.0** * **Novo**: Suporte à roteamento de requisições com proxy. Para mais detalhes, veja [aqui](https://docs.combateafraude.com/docs/mobile/ios/proxy#proxySettings) ### 2 de dezembro de 2020 * `DocumentDetector` **4.1.3** * **Correção**: melhorias * `PassiveFaceLiveness` **3.0.2** * **Correção**: correção de erro após captura em alguns dispositivos ### 30 de novembro de 2020 * `DocumentDetector` **4.1.2** * **Melhoria**: Remoção da biblioteca `Alamofire` como dependência. * `PassiveFaceLiveness` **3.0.0** * **Melhoria**: Remoção da biblioteca `Alamofire` como dependência. ### 06 de outubro de 2020 * **Novo**: adicionado API de [analytics](https://docs.combateafraude.com/docs/mobile/ios/analytics) em todos SDKs. A atualização está de acordo com nossa [Política de privacidade](https://www.combateafraude.com/politicas/politicas-de-privacidade) e [Termos e condições de uso](https://www.combateafraude.com/politicas/termos-e-condicoes-de-uso) ### 24 de setembro de 2020 * **Correção**: bug no decode de uma String base64 ### 22 de setembro de 2020 * **Atualização**: Adiciona o suporte ao XCode 12 e Swift 5.3 ### 16 de setembro de 2020 - MAJOR UPDATE * **Melhoria**: não é mais necessário configurar ENABLE\_BITCODE para No em seu projeto. * **Melhoria**: padronização de todos os parâmetros conforme os SDKs Android, além da adoção do `Builder pattern`. * **PS**: essa atualização mudou a estrutura interna dos SDKs. Se notar algum problema de integração, comunique-nos! Essa mudança não é visível para os usuários finais. ### 26 de agosto de 2020 * `DocumentDetector-2.3.0` * **Novo**: suporte para RNE * **Correção**: pequenos ajustes de parâmetros * `PassiveFaceLiveness-1.4.2` * **Correção**: pequenos ajustes de parâmetros ### 13 de agosto de 2020 * **ActiveFaceLiveness versão 1.4.0** * **Refatoração**: possibilidade de customizar todos os parâmetros e valores usados no SDK, como limiares dos sensores, tempos de estabilização, entre outros. ### 11 de agosto de 2020 * **FaceAuthenticator versão 1.3.0** * **Refatoração**: possibilidade de customizar todos os parâmetros e valores usados no SDK, como limiares dos sensores, tempos de estabilização, entre outros. ### 06 de agosto de 2020 * **DocumentDetector versão 2.2.1** * **Refatoração**: Ajuste na resposta do servidor * **PassiveFaceLiveness versão 1.4.0** * **Refatoração**: possibilidade de customizar todos os parâmetros e valores usados no SDK, como limiares dos sensores, tempos de estabilização, entre outros. ### 04 de agosto de 2020 * **DocumentDetector versão 2.2.0** * **Novo**: CRLV no DocumentDetector. * **Refatoração**: possibilidade de customizar todos os parâmetros e valores usados no SDK, como limiares dos sensores, tempos de estabilização, entre outros. ### 31 de julho de 2020 * **DocumentDetector versão 2.1.0** * **Refatoração**: troca de `Document.GENERIC` para `Document.OTHERS` * **Mudança**: não é mais possível configurar a mensagem de quando o documento não é encontrado ### Update - July 28, 2020 * **Release**: DocumentDetector **2.0.0** * **Novo**: verificação de qualidade das fotos do documento, minimizando as chances de fotos sem qualidades. * **Remoção**: parâmetro .uploadImages() do DocumentDetector. Se você quiser a URL da imagem, utilize o parâmetro .verifyQuality() * **Release**: PassiveFaceLiveness **1.3.1** * **Ajuste**: ajuste no audio do sdk * **Release**: ActiveFaceLiveness **1.3.0** * **Melhoria**: UX no ActiveFaceLiveness, mostrando ícones em cada movimento * **Ajuste**: ajuste no audio do sdk * **Release**: FaceAuthenticator **1.2.1** * **Ajuste**: ajuste no audio do sdk ### Update - July 14, 2020 * **Release**: DocumentDetector **1.3.0** * **Novo**: parâmetros para configurar as mensagens dos sensores * **Release**: PassiveFaceLiveness **1.3.0** * **Novo**: parâmetros para configurar as mensagens dos sensores * **Release**: ActiveFaceLiveness **1.2.0** * **Novo**: parâmetros para configurar as mensagens dos sensores ### Update - July 7, 2020 * **Release**: FaceAuthenticator **1.2.0** * **Added**: a String signedResponse in FaceAuthenticatorResult to know if the server request was modified by third * **Release**: DocumentDetector **1.2.0** * **Added** a DocumentDetectorBuilder parameter .uploadImages(upload :Bool, imageQuality :CGFloat), desired if you want to upload the images inside the SDK and return its URLs in DocumentDetectorResult ### Update - July 2, 2020 * **Release**: PassiveFaceLiveness **1.2.0** * **Added**: a String signedResponse in PassiveFaceLivenessResult to know if the server request was modified by third ### Update - June 30, 2020 * **Release**: ActiveFaceLiveness **1.1.0** * **Added**: parameter .setLayout() in ActiveFaceLivenessBuilder, you can now customize some layout options. * **Added**: parameter .showStatusLabel() in ActiveFaceLivenessBuilder * **Added**: parameter .showStepLabel() in ActiveFaceLivenessBuilder ### Update - June 25, 2020 * **Release**: FaceAuthenticator **1.1.0** * **Added**: parameter .setLayout() in FaceAuthenticatorBuilder, you can now customize some layout options. * **Added**: parameter .showStatusLabel() in FaceAuthenticatorBuilder * **Added**: parameter .showStepLabel() in FaceAuthenticatorBuilder * **Release**: PassiveFaceLiveness **1.1.0** * **Added**: parameter .setLayout() in PassiveFaceLivenessBuilder, you can now customize some layout options. * **Added**: parameter .showStatusLabel() in PassiveFaceLivenessBuilder * **Added**: parameter .showStepLabel() in PassiveFaceLivenessBuilder ### Update - June 23, 2020 * **Release**: DocumentDetector **1.1.0** * **Added** a type field in DocumentDetectorResult that says what type of document was scanned (rg, rg\_new or cnh) * **Added** a field in Capture that says what type of document was scanned (e.g. rg\_back, rg\_new\_back) * **Release**: release the DocumentDetector **1.0.3** version * Bug correction ### Update - June 18, 2020 * **Release**: DocumentDetector **1.0.2** * **Added**: parameter .setLayout() in DocumentDetectorBuilder, you can now customize some layout options of the document detection screen. * **Added**: parameter .showStatusLabel() in DocumentDetectorBuilder * **Added**: parameter .showStepLabel() in DocumentDetectorBuilder ### Update - June 16, 2020 * **Release**: DocumentDetector **1.0.1** * **Improved**: DocumentDetector recognition speed by 350% reduced size of sdk. * **Changed**: constructor of DocumentDetector. Now you can start it with your own flow! * **Removed**: the .setConfidence() parameter in DocumentDetectorBuilder. There is no reason to allow the user to edit it. * **Added**: support to other documents in DocumentDetector, like Registro Nacional de Estrangeiros (RNE), Carteira de Identidade de Advogado (OAB) and Identidade Militar. * **Added**: parameter .showPopup() in DocumentDetectorBuilder. ### Update - June 09, 2020 * **Changed**: the source of the podspecs from `source 'https://github.com/combateafraude/Mobile.git'` to `source 'https://github.com/combateafraude/iOS.git'` * **Fix**: Fixed bug that caused .ipa generation to fail in all versions 1.0.0 of the frameworks * **Release**: ActiveFaceLiveness version 1.0.1 released * Improvements in detecting face movements ### Update - May 25,2020 * **Release**: released the stable 1.0.0 versions of all frameworks --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.caf.io/caf-sdk/ios/standalone-modules/deprecated-sdks/release-notes-deprecated.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.