Siga as instruções detalhadas e aproveite os recursos avançados oferecidos por esta ferramenta para melhorar a segurança e a precisão da autenticação biométrica e verificação de documentos.

⚠️

Appkey em fluxos com Liveness 2D/3D + Doc Core

Cada appkey está associada a uma transação específica ou tem um prazo de expiração definido. Em fluxos que tenham apenas Liveness, a appkey não deve ser reutilizada.

Exceção: para os fluxos de trabalho que incluem Liveness 2D ou 3D e têm a etapa de Doc Core como próxima etapa, a appkey será reutilizada para realizar a análise do documento.

💡

Ambiente

Todos os módulos do SDK possuem o parâmetro de environment que indica o ambiente de execução desejado, esse parâmetro recebe um objeto do tipo Environment que possui dois valores:

Valor	Descrição
HML	Aponta para o ambiente de homologação.
PRD	Aponta para o ambiente de produção.

Liveness 3D

Passo 1: Importação do módulo

Importe o OILiveness3D no arquivo onde será utilizada:

import OILiveness3D

Passo 2: Configuração do Liveness3DUser

Crie um objeto do tipo Liveness3DUser passando para esse objeto os seguintes parâmetros:

💡

Nota

1. O parâmetro ticket é opcional;
2. Os parâmetros defaultTheme, lowLightTheme e texts são opcionais e estão relacionados a customização.

let liveness3DUser = Liveness3DUser(
    appKey: "APP-KEY",
    ticket: "TICKET",
    environment: .HML
)

Passo 3: Configuração do Liveness3DViewController

Crie uma instância para a classe Liveness3DViewController passando os seguintes parâmetros:

let controller = Liveness3DViewController(
    liveness3DUser: liveness3DUser,
    delegate: self
)

💡

Notas

1. Os parâmetros customInstructionView e customPermissionView são opcionais e estão relacionados a customização;
2. O objeto liveness3DUser é o mesmo criado no passo 2.

Passo 4: Implementação do delegate

Implemente o protocolo Liveness3DDelegate que possui os seguintes métodos:

Passo 5: Apresentação da controller

Apresente a controller instanciada anteriormente como uma modal:

controller.modalPresentationStyle = .fullScreen 
present(liveness3DViewController, animated: true)

💡

Nota

O objeto controller é o mesmo criado no passo 3.

Exemplo do código completo:

import UIKit
import OILiveness3D

class ViewController: UIViewController {

    func openLivenes3DPressed() {
        let liveness3DUser = Liveness3DUser(
            appKey: "APP-KEY",
            ticket: "TICKET",
            environment: .HML
        )
        
        let controller = Liveness3DViewController(
            liveness3DUser: liveness3DUser,
            delegate: self
        )
        
        controller.modalPresentationStyle = .fullScreen
        present(controller, animated: true)
    }
}

extension ViewController: Liveness3DDelegate {
    func handleLiveness3DValidation(validateModel: Liveness3DSuccess) {
        // Seu código ...
    }
        
    func handleLiveness3DError(error: Liveness3DError) {
        // Seu código ...
    }
}

Liveness 2D

Passo 1: Importação do módulo

Importe o OILiveness2D no arquivo onde será utilizada:

import OILiveness2D

Passo 2: Configuração do FaceCaptchaViewController

Crie uma instância para a classe FaceCaptchaViewController passando os seguintes parâmetros:

💡

Nota

1. O parâmetro showFeedback é opcional e possui true como valor padrão;
2. Os parâmetros customInstructionsView, customLivenessView, customProcessResultView, customResultView e customCameraPermissionView são opcionais e estão relacionados a customização.

let controller = FaceCaptchaViewController(
    appKey: "APP-KEY",
    environment: .HML,
    delegate: self
)

Passo 3: Apresentação da controller

Apresente a controller instanciada anteriormente como uma modal:

controller.modalPresentationStyle = .fullScreen
present(controller, animated: true)

💡

Nota

O objeto controller é o mesmo criado no passo 2.

Passo 4: Implementação do delegate

Implemente o protocolo FaceCaptchaDelegate que possui os seguintes métodos:

Exemplo do código completo:

import UIKit
import OILiveness2D

class ViewController: UIViewController {
    
    func openFaceCaptchaPressed() {
        let controller = FaceCaptchaViewController(
            appKey: "APP-KEY",
            environment: .HML,
            delegate: self
        )

        controller.modalPresentationStyle = .fullScreen
        present(controller, animated: true)
    }
}

extension ViewController: FaceCaptchaDelegate {
    func handleSuccess(model: FaceCaptchaSuccessModel) {
        // Seu código ...
    }
        
    func handleError(error: FaceCaptchaError) {
        // Seu código ...
    }
  
    func handleCanceled() {
        // Seu código ...
    }
}

Doc Core

Passo 1: Importação do módulo

Importe o OILiveness2D no arquivo onde será utilizada:

import OILiveness2D

Passo 2: Configuração do DocumentscopyViewController

Crie uma instância para a classe DocumentscopyViewController passando os seguintes parâmetros:

💡

Nota

1. O parâmetro ticket é opcional;
2. O parâmetro showFeedback é opcional e possui true como valor padrão;

1. Os parâmetros customInstructionView, customView, customCameraPermissionView, customLoadingView e customResultView são opcionais e estão relacionados a customização.

let controller = DocumentscopyViewController(
    ticket: "TICKET",
    appKey: "APP-KEY", 
    environment: .HML,
    delegate: self
)

Passo 3: Apresentação da controller

Apresente a controller instanciada anteriormente como uma modal:

controller.modalPresentationStyle = .fullScreen
present(controller, animated: true)

💡

Nota

O objeto controller é o mesmo criado no passo 2.

Passo 4: Implementação do delegate

Implemente o protocolo DocumentscopyDelegate que possui os seguintes métodos:

Exemplo do código completo:

import UIKit
import OILiveness2D

class ViewController: UIViewController {
  
    func openDocumentscopyPressed() {
        let controller = DocumentscopyViewController(
            ticket: "TICKET",
            appKey: "APP-KEY", 
            environment: .HML,
            delegate: self
        )

        controller.modalPresentationStyle = .fullScreen
        present(controller, animated: true)
    }
}

extension ViewController: DocumentscopyDelegate {
    func handleDocumentscopyCompleted() {
        // Seu código ...
    }
        
    func handleDocumentscopyError(error: DocumentscopyError) {
        // Seu código ...
    }
  
    func handleDocumentscopyCanceled() {
        // Seu código ...
    }
}