Saltar para o conteúdo principal
POST
curl
Carregue uma imagem de rosto codificada em base64 para uma lista de bloqueio ou de permissão facial. A Didit deteta os rostos na imagem, mantém o rosto de maior dimensão, armazena a imagem e um recorte desse rosto, e calcula o template biométrico facial com o qual as novas sessões são comparadas. O value da nova entrada é o UUID desse rosto. Disponível apenas para listas com entry_type: face e list_type: blocklist ou list_type: allowlist.
Se quiser adicionar à lista de bloqueio ou de permissão um rosto de uma sessão existente, use Criar entrada com reference_session_id: a entrada fica ligada à sessão.
A imagem tem de conter um rosto claramente visível e ter no máximo 2 MB depois de descodificada. Se não for detetado nenhum rosto, o pedido devolve 400 e não é criada nenhuma entrada. Se a análise facial estiver temporariamente indisponível, o pedido devolve 503: tente novamente mais tarde.
Para remover o rosto da lista, elimine a respetiva entrada: deixa de corresponder a novas sessões.

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.

Parâmetros de caminho

list_uuid
string<uuid>
obrigatório

UUID de uma lista com entry_type: face e list_type: blocklist ou allowlist.

Corpo

application/json
image
string<byte>
obrigatório

JPEG ou PNG codificado em base64, no máximo 2 MB após descodificado, mostrando um rosto claramente visível. Envie a string base64 simples, sem o prefixo data:image/...;base64,.

comment
string
padrão:""

Nota de texto livre opcional, como o motivo da inclusão na lista.

Resposta

A entrada de rosto foi criada.

Um valor numa lista.

uuid
string<uuid>
obrigatório

Identificador da entrada. Utilize-o como entry_uuid em Eliminar uma entrada da lista.

value
string
obrigatório

O valor listado: um número de telefone em E.164, um endereço de e-mail, um número de documento, um endereço IP ou intervalo CIDR, uma impressão digital do dispositivo, um endereço de carteira, uma conta bancária, um código de país ISO 3166-1 alfa-3, um vendor_data, qualquer cadeia de carateres numa lista de key, ou o UUID do rosto armazenado numa lista de rostos. Os valores que envia são armazenados em minúsculas, exceto números de telefone e códigos de país. A correspondência não diferencia maiúsculas de minúsculas.

display_label
string | null
obrigatório

Rótulo legível. A Didit preenche-o para entradas obtidas de uma sessão (por exemplo, o nome do titular e o número do documento) quando não envia nenhum.

Maximum string length: 512
comment
string
obrigatório

Nota em texto livre. String vazia quando não definida.

added_by
string | null
obrigatório

Quem adicionou a entrada: api (uma chave de API), o endereço de e-mail de um utilizador da consola ou console, system ou migration (entradas criadas pela Didit), ou rule (uma ação de regra de transação ou de monitorização).

reference_session_id
string<uuid> | null
obrigatório

Sessão de verificação da qual a entrada foi retirada. null quando a entrada foi adicionada por valor.

reference_session_number
integer | null
obrigatório

Número dessa sessão no âmbito da aplicação, como mostrado na consola.

reference_session_type
enum<string> | null
obrigatório

kyc para uma sessão de verificação de pessoa, kyb para uma sessão de verificação de empresa, null quando não existe sessão.

Opções disponíveis:
kyc,
kyb,
null
reference_object_uuid
string<uuid> | null
obrigatório

O registo que a entrada representa: o registo de rosto, documento, telefone ou e-mail lido a partir de uma sessão, o rosto criado por Carregar um rosto para uma lista, ou o UUID que enviou (por exemplo, o UUID de uma transação ou o didit_internal_id de um utilizador).

metadata
object | null
obrigatório

Contexto adicional. Contém as chaves definidas pela Didit (aqui listadas) combinadas com quaisquer metadata que tenha enviado ao criar a entrada, devolvidas conforme armazenadas. null quando não existir nenhum.

created_at
string<date-time>
obrigatório

Quando a entrada foi adicionada.

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