Identificar um rosto

Use esse endpoint para identificar um rosto.

curl --location --request POST 'https://horizon-api-sb.app.rpe.tech/api/v1/biometria/sdk/identify' \ --header 'fortfaceAuthorizationToken;' \ --header 'Content-Type: application/json' \ --data-raw '{ "externalUserId": "12345678901", "key": "1413423523", "data": "asdfaf", "imgData": "urlfotoexample.com", "returnPhoto": true }'

{ "matchLevel": { "value": 15 }, "photo": { "liveness": { "value": true, "confidence": 15 }, "eyesOpen": { "left": { "value": true, "confidence": 92.01886382025779 }, "right": { "value": true, "confidence": 89.40499666600019 } } }, "api": { "env": "sandbox", "timestamp": 1742219293613, "version": "v1 - 2.7.0" }, "sdk": { "platform": "web", "appId": "localhost:3000", "sdkVersion": "1.1.1", "soVersion": "unknown", "so": "Linux", "browser": "not identified", "browserVersion": "not identified" }, "hash": "80UbU+2LJRLDpm7w8YILSvcvBBtU+GF4Q1T/LsUXyM6A/ww4jxKpUsxqjtvU5b6Q2PqgKQs123rhTDlYhZT8vg==" }

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

fortfaceAuthorizationToken

string

requerido

Hash de autorização da Fortface.

Padrão:

Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJnYWxsZXJ5SWQiOiI3NDkxOWMzNy1kMzExLTRlMDktYjkxMi1mNTczNDRhZTA2NzMiLCJhY2NvdW50TmFtZSI6InJwZV9ob3Jpem9uIiwic2Vzc2lvbklkIjoiODViMjE2NTAtYzMxYi00MjU0LTllZjMtYzkxMWI2ZWU5NjlhIiwiYWN0aW9uIjoiaWRlbnRpZnkiLCJpYXQiOjE3NDI0MjQwNjgsImV4cCI6MTc0MjQyNzY2OH0.p0BpKWOODskxkTjG5ZCOq_4b2Ec3zzmT55_SyHTYKlc

Exemplo:

Parâmetros Bodyapplication/json

externalUserId

string

opcional

Identificador do usuário.

Exemplo:

12345678901

key

string

opcional

Chave de criptografia AES (Advanced Encryption Standard).

Exemplo:

1413423523

data

string

opcional

Dados criptografados do usuário.

Exemplo:

asdfaf

imgData

string

opcional

Imagem criptografada.

Exemplo:

urlfotoexample.com

returnPhoto

boolean

opcional

Indica o retorno da foto no response.

Exemplo:

true

Examples

Respostas

🟢200OK

application/json

Body

matchLevel

object

opcional

Representa o nível de correspondência da biometria analisada.

value

integer

opcional

Valor numérico que indica o grau de similaridade entre a biometria capturada e a referência armazenada.

Exemplo:

photo

object

opcional

Contém os dados da imagem analisada, incluindo verificações biométricas.

liveness

object

opcional

Resultado da verificação de prova de vida.

eyesOpen

object

opcional

Avaliação da abertura dos olhos na imagem capturada.

api

object

opcional

Informações sobre a API utilizada no processo.

env

string

opcional

Ambiente da API.

Exemplo:

sandbox

timestamp

integer

opcional

Marca temporal do momento em que a resposta foi gerada, representada no formato Unix Timestamp em milissegundos.

Exemplo:

1742219293613

version

string

opcional

Versão da API.

Exemplo:

v1 - 2.7.0

sdk

object

opcional

platform

string

opcional

Plataforma que foi utilizado o sitema de captura.

Exemplo:

web

appId

string

opcional

Identificador do aplicativo que utilizou o SDK.

Exemplo:

localhost:3000

sdkVersion

string

opcional

Versão do SDK.

Exemplo:

1.1.1

soVersion

string

opcional

Versão do sistema operacional.

Exemplo:

unknown

string

opcional

Sistema operacional.

Exemplo:

Linux

browser

string

opcional

Nome do navegador utilizado no processo de captura.

Exemplo:

not identified

browserVersion

string

opcional

Versão do navegador utilizado.

Exemplo:

not identified

hash

string

opcional

Hash gerado a partir da captura biométrica para garantir integridade e unicidade dos dados.

Exemplo:

80UbU+2LJRLDpm7w8YILSvcvBBtU+GF4Q1T/LsUXyM6A/ww4jxKpUsxqjtvU5b6Q2PqgKQs123rhTDlYhZT8vg==

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor