startFaceAuthSDK(viewController: UIViewController, mobileToken: String, personId: String)
mobileToken: Token de uso associado à sua conta CAFpersonId: Identificador do usuário que realizará a verificação de liveness facial. Recomenda-se usar o documento de identificação do usuário neste campo, como o CPF, mas pode ser qualquer outro valor..setStage(stage: CAFStage)
Usado para redirecionar o SDK para o ambiente desejado na API da caf. Tem as seguintes opções: .beta ou .prod.
.setFilter(filter: Filter)
Define o filtro de câmera aplicado à pré-visualização da câmera. Tem as seguintes opções: .natural ou .lineDrawing
.setLoadingScreen(withLoading: Bool)
Esse parâmetro booleano determina se a tela de carregamento será implementada via um delegate ou se você usará a tela padrão. Se definido como 'true', a tela de carregamento será uma tela padrão do SDK. No caso de 'false', você deve usar a sessão 'LoadingScreen' e implementar os delegates.
| Não | **false** | |.setImageUrlExpirationTime(time: Time)
Use para alterar o tempo padrão de expiração da URL da imagem para recuperar a captura da verificação. Tem as seguintes opções: .threeHours, .thirtyDays ou .thirtyMin.
.setAuthBaseUrl(authBaseUrl: String)
Permite o uso de um proxy reverso para executar as autenticações do SDK. Define a URL base para autenticação; o protocolo deve ser HTTPS. Adiciona uma barra no final se estiver faltando.
| Não | **URL padrão da Caf** | |.setLivenessBaseUrl(livenessBaseUrl: String)
Permite o uso de um proxy reverso para executar verificações de liveness facial. Define a URL base; o protocolo deve ser WSS. Adiciona uma barra no final se estiver faltando. Requer certificados definidos por .setCertificates por segurança.
.setCertificates(certificates: \[String])
Define os hashes SHA-256 codificados em Base64 para comunicação segura em implementações de proxy reverso. Necessário ao usar URLs personalizadas para autenticação ou verificações de liveness facial.
| Não | **Lista vazia** | |.setCustomLocalization(named: String?)
Este método permite especificar um nome de recurso de localização personalizado para o módulo iProov. Quando um nome é fornecido, o SDK carregará o arquivo de localização correspondente em vez do pacote de recursos padrão. Para mais detalhes sobre o formato dos arquivos de localização e a integração, consulte a documentação de localização do iProov.
| Não | **nil** | ### Proxy reverso Para configurar as definições de proxy reverso, siga estas instruções: #### Proxy reverso do CafFaceAuth * Configure seu proxy para se comunicar com a URL que corresponde ao `CAFStage` que você está usando: * `CAFStage.PROD` -> `https://api.public.caf.io/v1/sdks/faces/` * `CAFStage.BETA` -> `https://api.public.beta.caf.io/v1/sdks/faces/` * `CAFStage.DEV` -> `https://api.public.dev.caf.io/v1/sdks/faces/` * Use o método `.setLivenessBaseUrl` para definir a URL na qual o FaceLiveness deve ser executado. * **O protocolo da URL deve ser WSS.** * Use o `.setCertificates` método para definir os certificados, que devem ser o hash SHA-256 codificado em base64 do Subject Public Key Info do certificado. * **Os certificados são necessários para que o proxy reverso do FaceLiveness funcione corretamente.** ```swift faceAuthenticator = FaceAuthSDK.Build() .setLivenessBaseUrl("wss://my.proxy.io/ws/") .setCertificates(certificates: [ "4d69f16113bed7d62ca56feb68d32a0fcb7293d3960=", "50f71c5dda30741ee4be1ac378e12539b0d1d511f99=", "9f85e26c1ae41f7ac97adc4099be7f2a40759510ab9=" ]) .build() ``` #### Proxy reverso de autenticação * Configure seu proxy para se comunicar com \`wss\://us.rp.secure.iproov.me/ws´. * Use o método `.setAuthBaseUrl` para definir a URL na qual as requisições de autorização devem ser executadas. * **O protocolo da URL deve ser HTTPS.** ```swift faceAuthenticator = FaceAuthSDK.Build() .setAuthBaseUrl("https://my.proxy.io/v1/faces/") .build(); ``` ### Retornos do SDK #### Casos de sucesso Ao final de uma execução bem-sucedida, você receberá um objeto do tipo `FaceAuthenticatorResult`. Este objeto contém uma `signedResponse` propriedade que contém um token JWT com o resultado da execução. Esse token deve ser descriptografado para obter os detalhes dos resultados da execução. ```swift faceAuthenticatorResult.signedResponse ``` Dentro do `signedResponse`, o parâmetro `isAlive` define a execução do liveness, em que `true` é aprovado e `false` é rejeitado ([Caso de erro](#error-cases) será retornado). **Parâmetros do SignedResponse** | Evento | Descrição | | ------------ | -------------------------------------------------------------------------------------- | | `requestId` | Identificador da requisição. | | `isAlive` | Validação de uma pessoa viva, identifica se o usuário foi aprovado com sucesso ou não. | | `isMatch` | Resultado da validação de correspondência facial. | | `token` | Token da requisição. | | `userId` | Identificador do usuário informado para a requisição. | | `imageUrl` | Link temporário para a imagem, gerado pela nossa API. | | `personId` | Identificador do usuário informado para o SDK. | | `sdkVersion` | Versão do SDK em uso. | | `iat` | Expiração do token. | | `mensagem` | Mensagem de retorno. | {% hint style="warning" %} O **isAlive** parâmetro é **MUITO IMPORTANTE**, pois determina se o processo de validação prossegue ou é interrompido. Quando `isAlive: true`, o usuário recebe permissão para continuar sua jornada; por outro lado, se `isAlive: false`, o usuário é considerado inválido e o acesso às próximas etapas da jornada deve ser negado. Além disso, o `isMatch` parâmetro indica o sucesso ou falha da correspondência facial, retornando `isMatch: true` para correspondências bem-sucedidas e `isMatch: false` caso contrário. Esse parâmetro desempenha um papel fundamental na orientação do fluxo das operações. {% endhint %} #### Casos de erro Em caso de erros de execução, você receberá um objeto do tipo `FaceAuthenticatorErrorResult`. Este objeto engloba um enum contendo o `errorType`, e uma `description`. | ErrorType | Descrição | | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `unsupportedDevice` | Esse erro pode ocorrer se o hardware ou software do dispositivo não atender aos requisitos mínimos para a funcionalidade de reconhecimento facial. | | `cameraPermission` | Esse erro geralmente ocorre quando o usuário nega acesso à câmera ou quando o app não tem as permissões necessárias. | | `networkException` | Esse erro pode ocorrer devido a vários problemas de rede, como falta de conexão com a internet, timeouts do servidor ou congestionamento da rede. | | `tokenException` | Esse erro pode ocorrer se o token de autenticação fornecido for inválido, estiver expirado ou não tiver as permissões necessárias para executar tarefas de reconhecimento facial. | | `serverException` | Esse erro geralmente é retornado quando há um problema com o servidor ao processar a solicitação de reconhecimento facial. Isso pode incluir erros do lado do servidor, configurações incorretas ou interrupções no serviço. | --- # 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/caf-sdk-pt-br/ios/standalone-modules/caffaceauth/references.md?ask=