Guia rápido

Este guia cobre o fluxo mais comum: localizar uma entidade, rodar a análise de risco e ler o veredito. Requer uma apikey já gerada.

Busque a entidade por documento

curl "https://api.nlbs.ai/api/entities?document=12345678900" \
  -H "X-API-Key: nlbs_sua_chave_aqui"

A resposta traz os items encontrados, cada um com um id canônico — é esse id que alimenta o próximo passo.

Rode a análise

curl -X POST "https://api.nlbs.ai/api/analyses" \
  -H "X-API-Key: nlbs_sua_chave_aqui" \
  -H "Content-Type: application/json" \
  -d '{"entity_id": 410752090310337379, "source": "minha-integracao"}'

A análise roda de forma síncrona — a chamada fica aberta até o workflow terminar (pode levar até alguns minutos para entidades mais complexas) e a resposta já vem com o veredito completo, sem necessidade de polling.

A resposta traz uuid (identificador da análise), subject (dados cadastrais), risk (score, banda, composição por pilar) e links — URLs dos sub-recursos (grafo de relacionamentos, sinais identificados, eventos relevantes, explicação operacional sob demanda).

Consulte o grafo de relacionamentos (opcional)

curl "https://api.nlbs.ai/api/analyses/{uuid}/graph" \
  -H "X-API-Key: nlbs_sua_chave_aqui"

Retorna os nós e arestas da rede de relacionamentos da entidade — útil para visualizar sócios, processos, sanções e demais vínculos que sustentam o score.

Próximo passo: relatório regulatório

Com uma análise concluída, você pode gerar o relatório técnico de suporte (COAF/SUSEP) — veja Relatórios.

Referência completa

Todos os endpoints, parâmetros e formatos de resposta estão documentados com exemplos testáveis em Referência da API.

Autenticação Análises de risco

⌘I

Primeiros passos

Conceitos

Próximo passo: relatório regulatório

Referência completa

​Próximo passo: relatório regulatório

​Referência completa

Próximo passo: relatório regulatório

Referência completa