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.

Cabeçalhos

Idempotency-Key
string

Chave opcional para repetir requisições com segurança, com até 255 caracteres. Reutilizar a mesma chave com o mesmo corpo de requisição retorna a resposta original, sem executar nem cobrar uma segunda análise. Reutilizar a chave com um corpo diferente retorna 409.

Maximum string length: 255

Corpo

application/json
full_name
string
obrigatório

Nome completo da pessoa ou empresa a ser analisada. Mínimo de 2 caracteres, o limite mínimo do próprio provedor de análise. Um nome mais curto ou em branco retorna 400 neste campo antes de qualquer análise ser executada, portanto nada é cobrado.

Minimum string length: 2
Exemplo:

"Antonio Ejemplo Modelo"

entity_type
enum<string>
padrão:person

Tipo de entidade a ser analisada. O padrão é 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 por meio do peso da data de nascimento.

Exemplo:

"1972-02-29"

nationality
string

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

Exemplo:

"ES"

document_number
string

Número do documento de identidade. Não tem peso: funciona como uma chave de ouro. Uma correspondência exata eleva a match_score do resultado para 100, e uma divergência clara a penaliza. É enviado ao provedor de análise como filtro de busca apenas quando tem 2-50 caracteres; um valor fora desse intervalo é aceito e armazenado, e a análise ainda é executada e cobrada, apenas sem ser restringida pelo número do documento.

aml_score_approve_threshold
number
padrão:80

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

Intervalo obrigatório: 0 <= x <= 100
aml_score_review_threshold
number
padrão:100

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

Intervalo obrigatório: 0 <= x <= 100
aml_name_weight
integer
padrão:60

Peso da similaridade de nome na pontuação de correspondência por ocorrência. Os três pesos devem somar exatamente 100 (caso contrário, 400).

Intervalo obrigatório: 0 <= x <= 100
aml_dob_weight
integer
padrão:25

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

Intervalo obrigatório: 0 <= x <= 100
aml_country_weight
integer
padrão:15

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

Intervalo obrigatório: 0 <= x <= 100
aml_match_score_threshold
integer
padrão:93

Limite de corte por resultado: resultados com match_score abaixo deste valor são False Positive (excluídos da avaliação de risco); os que estão neste valor ou acima são possíveis correspondências Unreviewed.

Intervalo obrigatório: 0 <= x <= 100
include_adverse_media
boolean
padrão:false

Também pesquisa veículos de notícias em busca de cobertura negativa. Adiciona até ~30 s de latência enquanto os resultados são coletados; use um timeout de cliente de ≥60 s.

include_ongoing_monitoring
boolean
padrão:false

Continua a reanalisar este perfil e envia as alterações via webhook. Requer save_api_request=true (caso contrário, 400).

save_api_request
boolean
padrão:true

Salva a análise como uma sessão (visibilidade no console, endpoint de decisão, webhooks, revisão de ocorrências). Defina como false para uma verificação sem estado.

vendor_data
string

Seu identificador para o usuário analisado; retornado na resposta e armazenado com a sessão.

metadata
object | null

JSON livre armazenado com a requisição e retornado na resposta.

sandbox_scenario
string

Slug de cenário exclusivo de sandbox. Só é aceito quando a chave de API pertence a uma aplicação em modo sandbox; é rejeitado em aplicações em produção. Uma triagem avulsa não tem sessão para preparar, então o slug vai na própria requisição de triagem: decline_aml_hit retorna um resultado com formato de produção e conclui a triagem como Declined, review_aml_possible_match a conclui como In Review, e um cenário que não prepara nenhum resultado AML deixa a triagem limpa. Consulte o catálogo de cenários em GET /v1/sandbox/scenarios/ ou Sandbox e dados de teste.

Exemplo:

"decline_aml_hit"

Resposta

Análise concluída. aml.status reflete seus limiares; toda ocorrência igual ou acima do piso interno de inclusão é listada em aml.hits com 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 dos vendor_data que você enviou.

metadata
object | null

Eco do metadata que você enviou.

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