List fraud rings

Returns detected fraud rings within a consortium. Fraud rings are discovered via BFS traversal when a match is confirmed as fraud, connecting sessions across orgs via shared documents, emails, phones, and devices.

Authentication

X-API-Keystring

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

Path parameters

consortium_idstringRequired

Query parameters

limitintegerOptional<=100Defaults to 25

offsetintegerOptionalDefaults to 0

Response

List of fraud rings.

datalist of objects

paginationany

Errors

401

Unauthorized Error

403

Forbidden Error

1	{
2	"data": [
3	{
4	"id": "frd-ring-9a8b7c6d5e4f3a2b1c0d",
5	"trigger_match_id": "match-4f3e2d1c0b9a8e7d6c5b",
6	"session_count": 12,
7	"org_count": 4,
8	"status": "active",
9	"created_at": "2024-01-15T09:30:00Z",
10	"max_depth": 3
11	}
12	],
13	"pagination": null
14	}

1	{
2	"data": [
3	{
4	"id": "frd-ring-9a8b7c6d5e4f3a2b1c0d",
5	"trigger_match_id": "match-4f3e2d1c0b9a8e7d6c5b",
6	"session_count": 12,
7	"org_count": 4,
8	"status": "active",
9	"created_at": "2024-01-15T09:30:00Z",
10	"max_depth": 3
11	}
12	],
13	"pagination": null
14	}

List fraud rings

Authentication

Path parameters

Headers

Query parameters

Response

Errors

Authentication

Path parameters

Headers

Query parameters

Response

Errors

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