POST /analyses executa a análise de risco AML/KYC sobre uma pessoa ou empresa e retorna um veredito determinístico. O uuid retornado é o identificador usado por todo o resto da API: sub-recursos da própria análise, relatórios (/reports) e triagem de mídia adversa (/adverse-media).
POST /analyses
Cria e executa a análise de forma síncrona. A resposta já contém o veredito completo.
Escopo: analyses:create
Corpo da requisição
Exatamente um deentity_id ou document:
Resposta (AnalysisResponse)
Contagem de sinais e status por base consultada ficam em
GET /analyses/{uuid}/signals, não nesta resposta. A resposta não traz URLs de sub-recurso: monte-as a partir do uuid (/analyses/{uuid}/graph, /signals, etc., ver tabela abaixo).
Erros
Catálogo completo em Erros.
GET /analyses/{uuid}
Veredito de uma análise já computada. Escopo: analyses:read. A resposta tem o mesmo formato do POST; elapsed_ms é o tempo deste GET, não o do POST que criou a análise.
GET /analyses
Lista análises, paginado. Escopo: analyses:read. O envelope da lista traz items, has_more, total e elapsed_ms (tempo que o servidor gastou nesta listagem).
Recomendação para baixa latência
Reutilize a conexão HTTP entre as chamadas (keep-alive, ou conexão persistente). Cada conexão HTTPS nova faz um handshake TCP e TLS antes da requisição, o que soma de 50 a 150 ms conforme a distância. Reutilizando a conexão, só a primeira chamada paga esse custo.Python
Node.js
curl
Sub-recursos da análise
Todos exigemanalyses:read, montados a partir do uuid retornado por POST /analyses:
GET /analyses/{uuid}/dossier é uma releitura da análise já computada e paga: chamadas repetidas não criam nova análise nem geram cobrança adicional.Evidências de um sinal
GET /analyses/{uuid}/signals/{code}/evidences
Evidências de um sinal (evidence_count em /signals). As listas longas dentro de content (processes, persons, …) são paginadas: toda lista filha direta de content vem fatiada no mesmo intervalo.
Escopo:
analyses:read.
Grafo
GET /analyses/{uuid}/graph
Grafo de relacionamentos da contraparte (AnalysisGraphResponse), com sinais, UBOs e PEPs de rede.
GET /analyses/{uuid}/graph/nodes/{node_key}
Detalhe de um nó: campos, relacionamentos, evidências e sinais associados. Escopo: analyses:read.
GET /analyses/{uuid}/graph/edges/{edge_key}
Detalhe de uma aresta: tipo de relacionamento, endpoints e campos próprios. Escopo: analyses:read.
Agregação de evidências
Registros do mesmo tipo de evidência sobre o mesmo nó âncora (ex.: várias sanções da mesma entidade) chegam agrupados em um nó agregado (EvidenceSummary). Dois endpoints movem registros entre o agregado e nós individuais:
POST /analyses/{uuid}/graph/nodes/{node_key}/disaggregate: extrai registros específicos do agregado, materializando cada um como nó/aresta próprios.
graph) e os registros extraídos (disaggregated: node_key, edge_key, signal_codes de cada um). record_ids são ids naturais do registro (ex.: SanctionData.id), como string (podem exceder 2^53).
POST /analyses/{uuid}/graph/nodes/reaggregate: reagrupa nós individuais de volta em um agregado. Todos os node_keys informados devem compartilhar a mesma entidade âncora e tipo de evidência.
graph) e aggregate_node_key.
Ambos: escopo analyses:read, erro 404 se a análise ou um nó não existir, 422 em corpo inválido.
Desagregar, reagregar e expandir não alteram a análise gravada: cada uma entra num log de operações do grafo, com o autor, e GET /analyses/{uuid}/graph devolve o grafo da análise com as operações aplicadas. Se outra operação entrar na mesma análise ao mesmo tempo, a resposta é 409 e nada é gravado.
DELETE /analyses/{uuid}/graph/operations/{op_id}: desfaz a última operação ativa do log, como numa pilha, e devolve o grafo atual (o mesmo corpo de GET .../graph). Desfazer outra operação responde 409; operação inexistente, 404. Escopo: o da operação desfeita: analyses:create para um expand, analyses:read para desagregar e reagregar.
Notas e expansão de nó
GET /analyses/{uuid}/graph/nodes/{node_id}/expandable-relationships: lista domínios de relacionamento ainda não expandidos a partir de um nó (entities, corporate, sanctions, legal, watchlists, publications). Escopo: analyses:read.
POST /analyses/{uuid}/graph/nodes/{node_id}/expand: expande e persiste esses relacionamentos na análise.
analyses:create.
GET/POST /analyses/{uuid}/graph/nodes/{node_id}/notes: lista ou cria uma nota de texto livre (body, de 1 a 5000 caracteres, sem espaços nas pontas) anexada a um nó. Escopo: analyses:read (GET) / analyses:create (POST).
PATCH/DELETE /analyses/{uuid}/graph/nodes/{node_id}/notes/{note_uuid}: edita o texto (body, de 1 a 5000 caracteres) ou exclui uma nota. Só o usuário que escreveu a nota pode editá-la ou excluí-la; os demais recebem 403, e a listagem indica isso em can_edit. A exclusão é lógica: a nota some da listagem e da contagem. Escopo: analyses:create.
GET /analyses/{uuid}/graph/notes: contagem de notas por nó, para a análise inteira. Escopo: analyses:read.
Export em lote de dossiês
POST /analyses/bulk-dossier-jobs: enfileira a criação de PDFs para até 1000 itens de uma vez. Cada item referencia uma análise existente (analysis_uuid) ou um documento cru (document, roda a análise na hora). Retorna job_id imediatamente. Escopo: analyses:create.
GET /analyses/bulk-dossier-jobs: lista jobs, paginado. Escopo: analyses:read.
GET /analyses/bulk-dossier-jobs/{job_id}: status agregado (status: running/completed/completed_with_errors/failed) e por item (pending/completed/failed). Escopo: analyses:read.
GET /analyses/bulk-dossier-jobs/{job_id}/download: baixa o ZIP com os PDFs prontos. 404 se o job não existe ou o ZIP ainda não está disponível. Escopo: analyses:read.
