Autenticação Facial

Informações gerais

• Endereço: api.mobile.combateafraude.com/faces/authenticate
• Suporta assinatura de respostas: Sim

Método POST

Descrição

Verifica se o rosto em uma imagem bate com o registrado para um CPF.

ATENÇÃO: Se você não está usando o processo de onboarding oferecido pela combateafraude, você deve chamar a rota de registro facial antes de usar essa rota.

Requisição

Cabeçalhos

Identificador	Valor	Descrição
Authorization	[token de acesso]	Token do acesso do cliente mais informações
Content-type	application/json	Especifica que o MIME type é JSON

Strings de consulta

Identificador	Obrigatório	Valor	Descrição
shouldSignResponse	Não	true ou false	Especifica se a request deve ser assinada. O default é false.

Corpo

Campo	Obrigatório	Tipo	Descrição
peopleId	Sim	String	CPF do usuário que deseja autenticar
imageUrl	Não*	String	URL da imagem a ser validada
imageBase64	Não*	String	Base64 da imagem a ser validada
device	Não	Objeto	Informações básicas do dispositivo sendo usado para autenticar (ver abaixo)

*Você deve enviar um dos dois campos.

Informações do dispositivo:

Campo	Descrição
fingerprint	Identificador único do dispositivo
operatingSystem	Sistema operacional do dispositivo
manufacturer	Fabricante do dispositivo
model	Modelo do dispositivo

Resposta

Códigos de status

Código	Gera cobrança	Descrição
200	Sim	A execução foi concluída com sucesso
400	Não	O token de acesso não foi informado
401	Não	O token usado não é válido para este produto
404	Não	Nenhum rosto cadastrado para o CPF informado
405	Não	Método HTTP não permitido
500	Não	Erro interno do servidor

Corpo da resposta quando bem-sucedida

Campo	Valores válidos	Descrição
requestId	String	Identificador dessa requisição em nosso servidores
isMatch	Boolean	Indica se a autenticação facial foi aprovada.

Exemplos

Exemplo de requisição:

curl --location \
    --request POST 'api.mobile.combateafraude.com/faces/authenticate' \
    --header 'Authorization: {token}' \
    --header 'Content-Type: application/json' \
    --data-raw '{
        "peopleId": "{cpf}",
        "device": {
            "operatingSystem": "iOS",
            "fingerprint": "53fb86d3861f976886exe2e5b9291ea4",
            "manufacturer": "iPhone",
            "model": "iPhone 8 Plus"
        },
        "imageUrl": "https://images.generated.photos/DQ4EKrAPT-e5slG3cXmSw20uJ2AwwhOzJeVnpI9tlMA/rs:fit:512:512/Z3M6Ly9nZW5lcmF0/ZWQtcGhvdG9zLzA5/OTk4MDcuanBn.jpg"
    }'

Exemplo de resposta:

{
    "requestId": "dec967ad-e0e5-4a00-8c33-c82a84971ddf",
    "isMatch": true
}