Saltar para o conteúdo principal
POST
cURL

Autorizações

x-api-key
string
header
obrigatório

A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está incorreta, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. Consulte https://docs.didit.me/console/api-keys.

Corpo

multipart/form-data
user_image
file
obrigatório

Foto de rosto a analisar (por exemplo, uma selfie). Envie uma única foto virada para a frente com o rosto do titular claramente visível e bem iluminado. Extensões permitidas: tiff, jpg, jpeg, png, webp (sem PDF). Tamanho máximo de carregamento: 5 MB (ficheiros maiores são rejeitados com 400). As imagens são automaticamente comprimidas para ~0.3 MB antes do processamento, pelo que resoluções muito altas não melhoram a precisão.

face_liveness_score_decline_threshold
number<float>
padrão:30

Limiar de prova de vida (0–100). Um score de prova de vida igual ou inferior a este valor adiciona um aviso LOW_LIVENESS_SCORE e recusa. Aumente-o para um antispoofing mais rigoroso; valores fora de 0–100 devolvem 400.

Intervalo necessário: 0 <= x <= 100
Exemplo:

30

age_estimation_decline_threshold
integer
padrão:18

Idade estimada mínima aceitável em anos. Uma idade estimada inferior a este valor adiciona um aviso AGE_BELOW_MINIMUM e recusa. Defina 0 para desativar a verificação de idade (a chamada executará apenas a prova de vida + estimativa de idade sem uma decisão baseada na idade).

Intervalo necessário: 0 <= x <= 100
Exemplo:

18

rotate_image
boolean
padrão:false

Quando true, o serviço testa a imagem de entrada em incrementos de 90 graus (0, 90, 180, 270) e utiliza a orientação que produzir a melhor deteção facial — útil para capturas móveis sem orientação EXIF. Adiciona latência, pelo que só deve ativá-lo se não puder garantir imagens na orientação correta.

Exemplo:

false

save_api_request
boolean
padrão:true

Quando for true (predefinição), persiste a chamada como uma sessão do tipo API — visível na Business Console, recuperável através de GET /v3/session/{sessionId}/decision/ utilizando o request_id devolvido, anunciada através de um webhook status.updated e com o rosto detetado adicionado ao índice facial da sua aplicação. Quando for false, nada é armazenado e request_id é um UUID transitório apenas para correlação de respostas.

Exemplo:

true

vendor_data
string

String opaca opcional (o seu ID de utilizador interno, e-mail, UUID...) guardada na sessão persistida e devolvida na resposta. Utilize-a para correlacionar chamadas de API com os seus próprios registos e para filtrar sessões mais tarde.

Exemplo:

"user-123"

metadata
object

Objeto JSON opcional armazenado com a sessão (quando save_api_request=true) e devolvido na resposta. Em pedidos multipart, envie-o como um campo de texto codificado em JSON (por exemplo, metadata={"flow":"age-gate"}) — é convertido num objeto.

Exemplo:

Resposta

Estimativa de idade e prova de vida passiva concluídas. age_estimation.age_estimation é a idade prevista pelo modelo em anos para o maior rosto detetado (null se não houver nenhum); age_estimation.score é a pontuação de prova de vida passiva (0–100); status é Approved apenas quando warnings está vazio. Uma captura de um menor ou com spoofing continua a devolver 200 com status: "Declined" — inspecione o corpo, não apenas o código HTTP. Quando save_api_request=true, request_id é o id da sessão persistida.

request_id
string<uuid>

ID da sessão persistida quando save_api_request=true (utilizável com GET /v3/session/{sessionId}/decision/); caso contrário, um UUID de correlação transitório.

age_estimation
object
vendor_data
string | null

Eco do vendor_data que enviou, ou null.

metadata
object | null

Eco do objeto metadata que enviou, ou null.

created_at
string<date-time>

Carimbo de data/hora ISO 8601 (UTC) de quando a resposta foi gerada.

Última modificação em 7 de novembro de 2026