For the complete documentation index, see llms.txt. This page is also available as Markdown.

Inicialização

O que é IDV Mobile

IDV (Verificação de Identidade) é o fluxo que permite verificar e autenticar a identidade de uma pessoa por meio da captura e validação de traços biométricos.

O fluxo é configurado previamente na plataforma da Facephi e é executado na aplicação por meio de seu identificador (flowId).

Dependências necessárias

Para executar fluxos de IDV no Android, você deve adicionar, além do SDK base, os componentes específicos que participam do processo.

implementation("com.facephi.androidsdk:sdk:$version") 
implementation("com.facephi.androidsdk:tracking_component:$version") 
implementation("com.facephi.androidsdk:selphi_component:$version") 
implementation("com.facephi.androidsdk:selphid_component:$version")
implementation("com.facephi.androidsdk:video_recording_component:$version")
implementation("com.facephi.androidsdk:nfc_component:$version")

Adicione apenas os componentes necessários de acordo com o fluxo configurado na plataforma. Os componentes de SDK e rastreamento devem ser integrados obrigatoriamente independentemente do fluxo exigido.

Para facilitar o processo de integração, é apresentada uma tabela que faz referência à dependência de cada componente:

Componente
Dependência
Controlador

Selfie

com.facephi.androidsdk:selphi_component

FSelphiController

Selfie (com funcionalidade IAD)

com.facephi.androidsdk:selphi_iad_component

FSelphiController

Documento

"com.facephi.androidsdk:selphid_component

FSelphIDController

Videogravação

com.facephi.androidsdk:video_recording_component

FStartVideoRecordingController / FStopVideoRecordingController

NFC

com.facephi.androidsdk:nfc_component

FNFCController

Inicialização do SDK

O SDK é gerenciado por meio de um controlador principal (SDKController) que deve ser inicializado antes de lançar qualquer fluxo.

O apiKey da licença é fornecida pela equipe da Facephi assim que a integração for publicada.

Após uma inicialização correta, o SDK fica preparado para executar os fluxos configurados.

Lançar um fluxo de IDV

O fluxo de IDV é lançado por meio de um FlowController, indicando:

  • O ID do fluxo configurado na plataforma (flowId).

  • O ID do cliente (customerId).

  • A lista de controladores que participam do processo.

  • Opcionalmente, o ID de autenticação (authenticationId) para associar o fluxo a uma autenticação específica.

  • Opcionalmente, os identificadores resumeOperationId e resumeSessionId para continuar uma operação ou sessão já existente.

Exemplos de controladores comuns:

  • FSelphiController → Captura Facial.

  • FSelphIDController → Captura de documentos.

  • FStartVideoRecordingController / FStopVideoRecordingController → Gravação do processo.

Se você não precisar retomar uma operação, pode omitir authenticationId, resumeOperationId e resumeSessionId. O SDK criará os identificadores internos durante a inicialização do fluxo.

Para receber a saída do fluxo, observe stateFlow antes ou durante o lançamento:

Cada emissão retorna um SdkFlowResult com a etapa (step), o resultado da etapa ou operação (result) e o indicador flowFinish, que informa se o fluxo foi concluído.

Consultar fluxos disponíveis

Se você precisar obter os fluxos disponíveis antes de lançar um deles, use:

A função retorna uma lista com os ID de fluxo e sua tipo de operação.

Atualizado