Pular para o conteúdo principal

Coletando os Retornos do SDK

O método .initialize()

O método .initialize() é responsável pela inicialização do componente de reconhecimento facial e prova de vida. A partir de sua execução, o SDK carrega o modelo de detecção de face e valida as condições do dispositivo/navegador.

Promise resolution:

{
status: "SUCCESS",
data: null
}

Cenários de Rejection:

  • Unsupported Browser:
{
status: "FAILURE",
reason: "UNSUPPORTED_BROWSER",
description: "User browser is not supported."
}
  • Not Mobile Device:
{
status: "FAILURE",
reason: "NOT_MOBILE_DEVICE",
description: "User device is not mobile."
}
  • Initialization Error:
{
status: "FAILURE",
reason: "INITIALIZATION_ERROR",
description: "..."
}

O método .open()

Este método recebe o clientSessionKey (obtido via chamada server-to-server) e inicia a interação com o usuário para a coleta da prova de vida. Retorna uma Promise que é resolvida com a chave da imagem capturada assim que o fluxo é concluído.

Promise resolution:

{
status: "SUCCESS",
data: string // image_key que identifica a imagem no servidor
}

Exemplo:

{
status: "SUCCESS",
data: "d8a3b1c4-9e2f-47a5-8c3d-1b2e5..."
}

Promise rejection:

{
status: string;
reason: string;
description: string;
}

Cenários de Rejection:

  • User Canceled:
{
status: "FAILURE",
reason: "USER_CANCELED",
description: "User pressed the back button."
}
  • Invalid Token: (ocorre quando o clientSessionKey é inválido ou expirou)
{
status: "FAILURE",
reason: "INVALID_TOKEN",
description: "Authentication token expired or invalid"
}
  • Session Superseded: (ocorre quando .open() é chamado novamente em uma instância já aberta)
{
status: "FAILURE",
reason: "SESSION_SUPERSEDED",
description: "A new session has been started before the previous one was completed."
}