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.

Cabeçalhos

Idempotency-Key
string

Chave opcional de proteção contra repetições, até 255 carateres. Reutilizar a mesma chave com o mesmo corpo do pedido devolve a resposta original sem executar nem faturar uma segunda triagem. Reutilizar a chave com um corpo diferente devolve 409.

Maximum string length: 255

Corpo

application/json
full_name
string
obrigatório

Nome completo da pessoa ou empresa a analisar na triagem. Mínimo de 2 caracteres - o limite mínimo do próprio fornecedor de triagem. Um nome mais curto ou em branco retorna 400 neste campo antes de qualquer triagem ser executada, pelo que nada é faturado.

Minimum string length: 2
Exemplo:

"Antonio Ejemplo Modelo"

entity_type
enum<string>
padrão:person

Tipo de entidade a analisar. O valor predefinido é person.

Opções disponíveis:
person,
company
date_of_birth
string<date>

Data de nascimento (pessoas) ou data de constituição (empresas), YYYY-MM-DD. Melhora a precisão da correspondência através do peso da data de nascimento.

Exemplo:

"1972-02-29"

nationality
string

Código de país ISO 3166-1 alpha-2 (ex.: ES). Códigos inválidos retornam 400. Melhora a precisão da correspondência através do peso do país.

Exemplo:

"ES"

document_number
string

Número do documento de identidade. Sem ponderação — funciona como chave mestre: uma correspondência exata substitui a match_score da ocorrência por 100, uma divergência estrita penaliza-a. Enviado ao fornecedor de triagem como filtro de pesquisa apenas se tiver entre 2 e 50 carateres; um valor fora desse intervalo é aceite e armazenado, e a triagem é executada e faturada, apenas sem refinamento pelo número de documento.

aml_score_approve_threshold
number
padrão:80

Limiar de pontuação de risco igual ou inferior ao qual o resultado é Approved. Deve ser ≤ aml_score_review_threshold (caso contrário, 400).

Intervalo necessário: 0 <= x <= 100
aml_score_review_threshold
number
padrão:100

Limiar de pontuação de risco acima do qual o resultado é Declined. Pontuações entre os dois limiares produzem In Review.

Intervalo necessário: 0 <= x <= 100
aml_name_weight
integer
padrão:60

Ponderação da semelhança do nome na pontuação de correspondência por ocorrência. O somatório das três ponderações tem de ser exatamente 100 (caso contrário, 400).

Intervalo necessário: 0 <= x <= 100
aml_dob_weight
integer
padrão:25

Ponderação da data de nascimento na pontuação de correspondência por ocorrência.

Intervalo necessário: 0 <= x <= 100
aml_country_weight
integer
padrão:15

Ponderação do país/nacionalidade na pontuação de correspondência por ocorrência.

Intervalo necessário: 0 <= x <= 100
aml_match_score_threshold
integer
padrão:93

Ponto de corte por ocorrência: as ocorrências com match_score abaixo deste valor são False Positive (excluídas da avaliação de risco); no valor ou acima são possíveis correspondências Unreviewed.

Intervalo necessário: 0 <= x <= 100
include_adverse_media
boolean
padrão:false

Pesquisar também em notícias por cobertura negativa. Adiciona até ~30 s de latência enquanto os resultados são recolhidos — utilize um tempo limite de cliente de ≥60 s.

include_ongoing_monitoring
boolean
padrão:false

Continuar a fazer a nova triagem deste perfil e enviar alterações via webhook. Requer save_api_request=true (caso contrário, 400).

save_api_request
boolean
padrão:true

Persistir a triagem como uma sessão (visibilidade na consola, endpoint de decisão, webhooks, revisão de ocorrências). Defina como false para uma verificação sem estado.

vendor_data
string

O seu identificador para o utilizador submetido a triagem; devolvido e armazenado com a sessão.

metadata
object | null

JSON de formato livre armazenado com o pedido e devolvido na resposta.

sandbox_scenario
string

Slug de cenário exclusivo de sandbox. Apenas aceite quando a chave de API pertence a uma aplicação em modo sandbox; rejeitado em aplicações em produção. Uma triagem autónoma não tem sessão para armar, pelo que o slug é incluído no próprio pedido de triagem: decline_aml_hit devolve uma correspondência com formato de produção e define a triagem como Declined, review_aml_possible_match define-a como In Review, e um cenário que não arme qualquer resultado de AML mantém a triagem limpa. Consulte o catálogo de cenários em GET /v1/sandbox/scenarios/ ou em Sandbox & Test Data.

Exemplo:

"decline_aml_hit"

Resposta

Triagem concluída. aml.status reflete os seus limiares; cada resultado igual ou superior ao piso interno de inclusão é listado em aml.hits com o seu match_score de identidade, o risk_score da entidade e um score_breakdown que explica a correspondência.

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.

aml
object
vendor_data
string | null

Eco do vendor_data que enviou.

metadata
object | null

Eco do objeto metadata que enviou.

created_at
string<date-time>
Última modificação em 7 de novembro de 2026