Get fraud ring detail

curl https://devapi.withverifa.com/api/v1/consortiums/consortium_id/rings/ring_id \
     -H "X-API-Key: <apiKey>" \
     -H "Content-Type: application/json"

{
  "created_at": "2024-01-15T09:30:00Z",
  "id": "ring_9f8b7c6d5e4a3b2c1d0e",
  "org_count": 4,
  "session_count": 12,
  "status": "active",
  "trigger_match_id": "match_4a3b2c1d0e9f8b7c6d5e",
  "connection_graph": {
    "nodes": [
      {
        "session_id": "session_001a2b3c4d5e6f7g8h9i",
        "depth": 0,
        "organization": "OrgA"
      },
      {
        "session_id": "session_002b3c4d5e6f7g8h9i0j",
        "depth": 1,
        "organization": "OrgB"
      },
      {
        "session_id": "session_003c4d5e6f7g8h9i0j1k",
        "depth": 2,
        "organization": "OrgC"
      }
    ],
    "edges": [
      {
        "source": "session_001a2b3c4d5e6f7g8h9i",
        "target": "session_002b3c4d5e6f7g8h9i0j",
        "link_type": "email"
      },
      {
        "source": "session_002b3c4d5e6f7g8h9i0j",
        "target": "session_003c4d5e6f7g8h9i0j1k",
        "link_type": "device"
      }
    ]
  },
  "consortium_id": "consortium_1234567890abcdef",
  "max_depth": 3,
  "session_ids": [
    "session_001a2b3c4d5e6f7g8h9i",
    "session_002b3c4d5e6f7g8h9i0j",
    "session_003c4d5e6f7g8h9i0j1k"
  ]
}

Returns a fraud ring with its full connection graph showing how sessions are linked across organizations.

curl https://devapi.withverifa.com/api/v1/consortiums/consortium_id/rings/ring_id \
     -H "X-API-Key: <apiKey>" \
     -H "Content-Type: application/json"

{
  "created_at": "2024-01-15T09:30:00Z",
  "id": "ring_9f8b7c6d5e4a3b2c1d0e",
  "org_count": 4,
  "session_count": 12,
  "status": "active",
  "trigger_match_id": "match_4a3b2c1d0e9f8b7c6d5e",
  "connection_graph": {
    "nodes": [
      {
        "session_id": "session_001a2b3c4d5e6f7g8h9i",
        "depth": 0,
        "organization": "OrgA"
      },
      {
        "session_id": "session_002b3c4d5e6f7g8h9i0j",
        "depth": 1,
        "organization": "OrgB"
      },
      {
        "session_id": "session_003c4d5e6f7g8h9i0j1k",
        "depth": 2,
        "organization": "OrgC"
      }
    ],
    "edges": [
      {
        "source": "session_001a2b3c4d5e6f7g8h9i",
        "target": "session_002b3c4d5e6f7g8h9i0j",
        "link_type": "email"
      },
      {
        "source": "session_002b3c4d5e6f7g8h9i0j",
        "target": "session_003c4d5e6f7g8h9i0j1k",
        "link_type": "device"
      }
    ]
  },
  "consortium_id": "consortium_1234567890abcdef",
  "max_depth": 3,
  "session_ids": [
    "session_001a2b3c4d5e6f7g8h9i",
    "session_002b3c4d5e6f7g8h9i0j",
    "session_003c4d5e6f7g8h9i0j1k"
  ]
}

Returns a fraud ring with its full connection graph showing how sessions are linked across organizations.

Authentication

X-API-Keystring

Organization API key. Keys are prefixed with vk_live_ (production) or vk_sandbox_ (sandbox).

Path parameters

consortium_idstringRequired

ring_idstringRequired

Response

Fraud ring details.

created_atdatetime

idstring

org_countinteger

session_countinteger

statusstring

trigger_match_idstring

The confirmed-fraud match that triggered ring detection.

connection_graphmap from strings to any

Graph structure with “nodes” (session objects with depth) and “edges” (connections with link_type: document, email, phone, device).

consortium_idstring

max_depthinteger

Maximum BFS depth reached during ring discovery.

session_idslist of strings

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

Get fraud ring detail

Authentication

Path parameters

Headers

Response

Errors

Authentication

Path parameters

Headers

Response

Errors

$	curl https://devapi.withverifa.com/api/v1/consortiums/consortium_id/rings/ring_id \
>	-H "X-API-Key: <apiKey>" \
>	-H "Content-Type: application/json"

1	{
2	"created_at": "2024-01-15T09:30:00Z",
3	"id": "ring_9f8b7c6d5e4a3b2c1d0e",
4	"org_count": 4,
5	"session_count": 12,
6	"status": "active",
7	"trigger_match_id": "match_4a3b2c1d0e9f8b7c6d5e",
8	"connection_graph": {
9	"nodes": [
10	{
11	"session_id": "session_001a2b3c4d5e6f7g8h9i",
12	"depth": 0,
13	"organization": "OrgA"
14	},
15	{
16	"session_id": "session_002b3c4d5e6f7g8h9i0j",
17	"depth": 1,
18	"organization": "OrgB"
19	},
20	{
21	"session_id": "session_003c4d5e6f7g8h9i0j1k",
22	"depth": 2,
23	"organization": "OrgC"
24	}
25	],
26	"edges": [
27	{
28	"source": "session_001a2b3c4d5e6f7g8h9i",
29	"target": "session_002b3c4d5e6f7g8h9i0j",
30	"link_type": "email"
31	},
32	{
33	"source": "session_002b3c4d5e6f7g8h9i0j",
34	"target": "session_003c4d5e6f7g8h9i0j1k",
35	"link_type": "device"
36	}
37	]
38	},
39	"consortium_id": "consortium_1234567890abcdef",
40	"max_depth": 3,
41	"session_ids": [
42	"session_001a2b3c4d5e6f7g8h9i",
43	"session_002b3c4d5e6f7g8h9i0j",
44	"session_003c4d5e6f7g8h9i0j1k"
45	]
46	}