Pular para o conteúdo principal
POST
cURL

Autorizações

x-api-key
string
header
obrigatório

Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, 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á errada, 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 a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys.

Corpo

multipart/form-data
user_image
file
obrigatório

Imagem frontal do rosto (por exemplo, uma selfie). Extensões permitidas: tiff, jpg, jpeg, png, webp. Tamanho máximo de upload: 5 MB (arquivos maiores são rejeitados com 400). As imagens são comprimidas automaticamente para ~0,5 MB antes do processamento, portanto resoluções muito altas não melhoram a precisão. A imagem deve conter uma única pessoa: quando há vários rostos, o maior é avaliado e um aviso MULTIPLE_FACES_DETECTED é adicionado.

face_liveness_score_decline_threshold
number<float>
padrão:30

Limiar da pontuação de prova de vida (0–100). Uma pontuação calculada igual ou inferior a este valor emite um aviso LOW_LIVENESS_SCORE e define status como Declined. O padrão é 30. Aumente esse valor para uma proteção antispoofing mais rigorosa. Valores fora do intervalo 0–100 retornam 400.

Intervalo obrigatório: 0 <= x <= 100
Exemplo:

30

rotate_image
boolean
padrão:false

Quando true, o serviço testa rotações de 90 graus da entrada e usa a orientação que produz a melhor detecção de rosto. Útil quando a orientação EXIF está ausente. Aumenta a latência.

Exemplo:

false

save_api_request
boolean
padrão:true

Quando true (padrão), persiste a chamada como uma sessão do tipo API, armazena as imagens do rosto, emite um webhook status.updated e cadastra o rosto detectado no seu índice de busca facial. Quando false, a chamada é avulsa: nada é armazenado e o rosto não é cadastrado. A triagem de lista de bloqueio e de duplicados é executada em ambos os casos.

Exemplo:

true

vendor_data
string

Identificador opaco opcional (seu ID de usuário, e-mail, UUID…) armazenado na sessão persistida e devolvido. Também é usado para excluir sessões anteriores com o mesmo vendor_data da verificação de rosto duplicado, de modo que reverificar o mesmo usuário não gere DUPLICATED_FACE.

Exemplo:

"user-123"

metadata
object

Objeto JSON opcional armazenado com a sessão (quando save_api_request=true) e devolvido. Em requisições multipart, envie-o como um campo de string codificada em JSON, que é convertido em um objeto.

Exemplo:

Resposta

Prova de vida passiva concluída. liveness.score é a confiança do modelo, de 0 a 100, de que a imagem mostra uma pessoa real; status é Approved, a menos que um aviso de severidade error tenha sido disparado. Um rosto falsificado ou presente na lista de bloqueio ainda retorna 200: verifique liveness.status e liveness.warnings, 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.

liveness
object
vendor_data
string | null

Eco do vendor_data que você enviou, ou null.

metadata
object | null

Eco do objeto metadata que você enviou, ou null.

created_at
string<date-time>

Timestamp ISO 8601 (UTC) do momento em que a resposta foi gerada, por exemplo 2026-06-12T01:04:42.763237+00:00.

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