Referência da API de identidade

Este documento inclui a especificação dos serviços expostos em modo SaaS por meio das APIs REST da Facephi para os produtos Onboarding e Authentication.

Acesso à API

Parâmetro	Valor
Host	https://api.identity-platform.io

Autorizações

Todas as chamadas aos Endpoints devem incluir as seguintes chaves no cabeçalho da solicitação:

Chave	Valor	Obrigatório
x-api-key	API Key de autorização de acesso	Sim

Se as chaves obrigatórias mencionadas acima não forem incluídas ou não forem válidas, a solicitação é rejeitada pelo gateway antes de chegar ao serviço. Essas respostas são as respostas padrão do AWS API Gateway e não usam o envelope serviceResultCode:

Código HTTP	Corpo da resposta	Caso
401	{"message": "Unauthorized"}	API Key ausente ou inválida.
403	{"Message": "User is not authorized to access this resource with an explicit deny"}	API Key válida, mas sem acesso ao recurso.

A capitalização do campo difere entre ambas as respostas (message no 401, Message no 403): são os corpos padrão do AWS API Gateway.

Integração com Identity Platform

Todas as chamadas aos Endpoints para Tracking com Identity Platform devem conter o seguinte cabeçalho:

Chave	Valor
family	Onboarding — Para todas as chamadas relacionadas a processos de Onboarding Digital. Authentication — Para todas as chamadas relacionadas a processos de Autenticação.

Tempo de resposta dos serviços

Processo	Tempo estimado / médio	Notas
teste de vida	Processamento < 1 segundo + Latência de rede entre 2 e 4 segundos	O tempo total percebido depende do salto de rede.
Correspondência facial	Processamento < 1 segundo + Latência de rede entre 2 e 4 segundos	Assim como o teste de vida, depende da conectividade.
Registro civil	Tipicamente < 10 segundos	O registro não se compromete com um SLA formal de tempo de resposta.
Morfologia	Média: 60 segundos. Máximo: 270 segundos	Processo semiautomatizado; varia conforme a carga e as condições de processamento.