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

Autenticação facial

Serviço que realiza a validação facial entre dois rostos, incluindo tanto imagens abertas quanto templates biométricos.

Este serviço pode ser usado para realizar as seguintes validações:

  1. Autenticação facial entre duas imagens abertas, geradas ou não por Widgets da FacePhi.

  2. Autenticação facial entre dois templates biométricos, requer integração do Widget Selphi Mobile ou Web da FacePhi.

  3. Autenticação facial entre uma imagem aberta e um template biométrico, requer integração do Widget Selphi Mobile ou Web da FacePhi.

  4. Autenticação facial entre o rosto presente na foto do Documento de identidade (TokenFaceImage) e uma imagem aberta, requer integração do Widget SelphID Mobile da FacePhi.

  5. Autenticação facial entre o rosto presente na foto do Documento de identidade (TokenFaceImage) e um template biométrico, requer integração dos Widgets Selphi Mobile e SelphID Mobile da FacePhi.

Integração

  • Para as validações do tipo 4 e 5, é necessário implementar o Widget SelphID Mobile para gerar a propriedade TokenFaceImage.

  • Para as validações do tipo 2, 3 e 5, é necessário implementar o Widget Selphi Mobile ou Web para gerar a propriedade do template biométrico (TemplateRaw).

Endpoint

POST /services/authenticateFacial

Cabeçalhos

Nome
Tipo
Obrigatório
Descrição

x-api-key

string

Sim

API Key para autorização de acesso.

family

string

Não

Valor: OnBoarding. Obrigatório com o serviço de tracking.

Todas as chamadas aos endpoints de tracking com Identity Platform devem conter o cabeçalho family.

Corpo da solicitação

Content-Type: application/json

Parâmetros

Parâmetro
Tipo
Obrigatório
Descrição

token1

string

Sim

Imagem usada como referência para a comparação facial. Dependendo do método invocado, pode ser o token gerado pelos Widgets SelphID (token da foto do documento), uma imagem aberta ou um template biométrico tokenizado.

token2

string

Sim

Imagem usada para a comparação. Pode ser uma imagem aberta ou um template biométrico tokenizado.

method

integer

Sim

Indica o método de comparação invocado. Consulte Especificação do método.

tracking

object

Não

Objeto que representa as informações de acompanhamento necessárias.

tracking.extraData

string

Não

Token gerado pelo SDK Mobile/Web. Contém informações de Tracking tokenizadas com a Plataforma.

tracking.operationId

string

Não

Identificador da operação gerado pelo SDK Mobile/Web.

Especificação do método

Método
Descrição
Entrada

1

Autenticação facial por meio de imagens abertas

token1: Base64, token2: Base64

2

Autenticação facial por meio de Templates Biométricos

token1: templateRaw, token2: templateRaw

3

Autenticação facial por meio de uma imagem aberta e um Template Biométrico

token1: Base64, token2: templateRaw

4

Autenticação facial por meio do token gerado pelo recorte da foto do documento e uma imagem aberta

token1: tokenFaceImage, token2: Base64

5

Autenticação facial por meio do token gerado pelo recorte da foto do documento e um Template Biométrico

token1: tokenFaceImage, token2: templateRaw

Exemplo de solicitação

Respostas

200 Sucesso

Parâmetros da resposta

Parâmetro
Tipo
Descrição

serviceResultCode

integer

Código que indica o resultado geral da execução do serviço. Consulte Service Result Code

serviceResultLog

string

Campo descritivo do resultado da execução do serviço. Inclui detalhes quando há um erro ou uma exceção no módulo.

serviceTime

string

Tempo total de processamento (milissegundos).

serviceTransactionId

string

Identificador da transação associada à solicitação processada pela API.

serviceFacialAuthenticationHash

string

Hash de integridade do Template Biométrico usado em uma autenticação facial positiva ou incerta. Aplicável apenas aos métodos 2, 3 e 5.

serviceFacialAuthenticationResult

integer

Código que indica o resultado da correspondência facial. Consulte Service Facial Authentication Result

serviceFacialSimilarityResult

number

Valor que indica a similaridade facial entre o rosto na foto do Documento de identidade e a selfie tirada pelo usuário. 1.0 = 100%

Código do resultado do serviço

O serviceResultCode indica o resultado geral da execução do serviço:

serviceResultCode
Descrição
Código HTTP

0

A execução do serviço foi bem-sucedida; o módulo processou a solicitação corretamente.

200

Resultado da autenticação facial do serviço

O serviceFacialAuthenticationResult indica o resultado das operações de correspondência facial:

Código
Resultado
Descrição

0

NONE

Não foi possível realizar a verificação facial.

1

NEGATIVE

O processo foi executado com sucesso. A comparação do padrão facial dos rostos não corresponde.

3

POSITIVE

O processo foi executado com sucesso. A comparação do padrão facial dos rostos é positiva. O valor de serviceFacialSimilarityResult indica a porcentagem de similaridade entre as imagens comparadas.

4

NONE BECAUSE POSE EXCEED

Não foi possível realizar a verificação facial devido à posição do rosto.

5

NONE BECAUSE INVALID EXTRACTIONS

Não foi possível realizar a verificação facial devido a problemas na extração do padrão facial.

Exemplo de resposta: Positive

Exemplo de resposta: Negative

400 Solicitação inválida

401 Não autorizado

403 Proibido

502 Gateway inválido

504 Tempo limite do gateway

Atualizado