Skip to main content
A API da NL Labs AI expõe o motor de análise de risco AML/KYC por HTTP: busca de entidades, análise de contraparte (com grafo de relacionamentos), relatório regulatório, triagem de mídia adversa, e os catálogos versionados de regras e regulação usados em cada veredito.

​
Recurso central: a análise

POST /analyses roda o motor sobre um subject (pessoa ou empresa) e retorna um veredito. Toda a API gira em torno do uuid dessa análise:
  • O grafo de relacionamentos, os sinais identificados, os processos judiciais e o dossiê em PDF são lidos a partir dele (GET /analyses/{uuid}/...).
  • Um relatório regulatório (POST /reports) e uma triagem de mídia adversa (POST /adverse-media) são gerados a partir dele (analysis_uuid no corpo da requisição).
  • Um export em lote de dossiês PDF (POST /analyses/bulk-dossier-jobs) referencia várias análises de uma vez, ou cria as que faltarem.
Fluxo típico: GET /entities para resolver o subject → POST /analyses → consumir os sub-recursos e/ou gerar relatório/triagem a partir do uuid retornado.

​
Gateway único

Um único serviço HTTP serve todos os domínios (entities, analyses, reports, adverse_media, regulatory, rules, webhooks, workflow-endpoints), com a mesma autenticação. Veja Autenticação. workflow-endpoints é independente do fluxo de análise acima: invoca um workflow de automação configurado pelo tenant a partir de um CPF/CNPJ. Ver Workflow endpoints.

​
Convenções

  • Erro: {"detail": "<mensagem estável>"} — veja Erros.
  • CPF/CNPJ em respostas de busca (GET /entities) são sempre mascarados.
  • Exemplos usam o subject fictício entity_id: 410752090310337379, “Maria Silva”.