Skip to main content
GET
curl
Retrieve the network as a graph: subject nodes for each vendor user, vendor business, or transaction party in the network, signal nodes for each shared device, IP, face, document number, phone, email, or address value linking them, and edges for the memberships between them. Use depth to bound how many hops out from a focus_kind/focus_id subject to return, this is what backs the Console’s graph view zooming into one applicant’s immediate connections instead of loading the whole network. Omit depth (or pass all) for the full neighborhood; truncated tells you whether a bounded request cut anything off.

Authorizations

x-api-key
string
header
required

Path Parameters

organization_id
string<uuid>
required

Organization UUID.

application_id
string<uuid>
required

Application UUID.

network_uuid
string<uuid>
required

Network UUID.

Example:

"n3a5e000-0000-4000-8000-000000000001"

Query Parameters

depth
enum<string>

Hops from the focus subject to include. Defaults to all (unbounded).

Available options:
1,
2,
3,
all
focus_kind
enum<string>

Subject type to center the graph on. Must be supplied together with focus_id; defaults to an arbitrary member when depth is bounded and neither is supplied.

Available options:
vendor_user,
vendor_business,
transaction_party
focus_id
string<uuid>

Subject UUID to center the graph on.

Response

Network graph.

network
object
depth
integer | null

Effective depth applied, or null when unbounded (depth=all).

truncated
boolean

True if the neighborhood was cut off by depth.

nodes
object[]
edges
object[]
metrics
object