Pular para o conteúdo principal
POST
Calcular distância entre relacionamentos

Autorizações

Authorization
string
header
obrigatório

OAuth2 Authorization Code flow

Parâmetros de caminho

idOrDocument
string
obrigatório

Company ID (cmp_*) or document (CNPJ)

Corpo

application/json
document
string
obrigatório

Documento alvo para encontrar conexão a partir da empresa base (CPF ou CNPJ)

Exemplo:

"12345678909"

ignore
object[]

Lista de matches de CPF (nome + cpf) que devem ser ignorados na busca

maxDepth
number
padrão:6

Profundidade máxima do grafo para buscar conexões indiretas entre empresas e pessoas

Intervalo obrigatório: 1 <= x <= 8
maxPaths
number
padrão:100

Quantidade máxima de caminhos de conexão profundos a retornar

Intervalo obrigatório: 1 <= x <= 500

Resposta

Distance search result

sourceDocument
string
obrigatório

Documento da empresa de origem (CNPJ)

targetDocument
string
obrigatório

Documento alvo normalizado (CPF ou CNPJ)

targetType
enum<string>
obrigatório
Opções disponíveis:
cpf,
cnpj
found
boolean
obrigatório

Indica se a conexão foi encontrada

expansions
number
obrigatório

Quantidade total de expansões realizadas no dataset

paths
array[]
obrigatório

Todos os caminhos mínimos encontrados (array de IDs de nós por caminho)

deepPaths
array[]
obrigatório

Caminhos profundos encontrados entre origem e destino (empresas e pessoas), respeitando maxDepth

cpfMatches
object[]
obrigatório

Matches de CPF parcial encontrados (incluindo ignorados)

companiesBetween
object[]
obrigatório

Empresas intermediárias encontradas entre origem e destino (exclui os pontos de origem/destino)

peopleBetween
object[]
obrigatório

Pessoas intermediárias encontradas entre origem e destino (exclui os pontos de origem/destino)

entitiesBetween
object[]
obrigatório

Todas as entidades intermediárias encontradas (empresas e pessoas)

nodes
object[]
obrigatório
edges
object[]
obrigatório
distance
object

Distância mínima em arestas, quando encontrada