Referência da API REST

URL base e autorização

Use o endereço HTTPS da sua própria instalação. Todas as rotas de aplicação abaixo usam Authorization: Bearer <application-key>.

Em produção, proteja a chave em arquivo privado ou gerenciador de segredos e limite os escopos à finalidade autorizada.

Prova de vida independente

Não exige subjectId e não cria uma identidade cadastrada.

{}

O backend consulta o resultado depois da captura pelo SDK Web. Não confunda aprovação de prova de vida com confirmação de identidade.

Cadastro de referência facial

Cria uma solicitação de cadastro vinculada a um identificador permitido pela aplicação.

{"subjectId":"person_123"}

Antes do cadastro, obtenha autorização adequada do titular e aplique políticas de retenção, revisão e exclusão de dados.

Verificação facial 1:1

Compara uma captura com a referência facial autorizada de subjectId. Não realiza busca em toda uma base (1:N).

{"subjectId":"person_123"}

O score de similaridade é uma medida de comparação técnica, não uma porcentagem de probabilidade de identidade. A política por aplicação é configurada no Console por administrador com MFA, e não pela chave comum de integração.

Criação e consulta de resultados

A solicitação retorna HTTP 201 quando a emissão da operação foi aceita. O resultado de criação inclui um id e uma verificationUrl temporária HTTPS que aponta para /verify.html, com token no fragmento.

{
  "id": "chk_example_identifier",
  "verificationUrl": "https://face.example.com/verify.html#identity=TEMPORARY_TOKEN"
}

Após a captura, utilize o endpoint GET correspondente para obter o status e a decisão oficial do Server. Os valores exatos de estado podem variar por operação e versão; processe respostas de modo conservador e não presuma sucesso apenas porque a emissão retornou 201.

Erros e diagnóstico

A disponibilidade desses status depende da rota e da versão do Server. Em caso de indisponibilidade, registre apenas metadados não sensíveis e faça uma nova consulta autorizada.