Get consortium detail

GET

https://devapi.withverifa.com/api/v1/consortiums/:consortium_id

Returns details for a specific consortium your organization belongs to.

Authentication

X-API-Keystring

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

Path parameters

consortium_idstringRequired

Consortium ID.

Response

Consortium details.

idstring

namestring

matching_thresholddouble

Minimum face similarity score (0.50–0.99) for a match.

sharing_levelenum

Controls what data members see. “signals_only” shows match counts only. “match_details” includes session IDs and org names. “full_investigation” includes resolution notes.

is_activeboolean

created_atdatetime

descriptionstring or null

retention_policy_daysinteger

match_summarymap from strings to integers

Match count by status (e.g., {“new”: 5, “confirmed_fraud”: 2}).

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

1	{
2	"id": "cg_abc123",
3	"name": "State University Consortium",
4	"matching_threshold": 0.75,
5	"sharing_level": "signals_only",
6	"is_active": true,
7	"created_at": "2024-01-15T09:30:00Z",
8	"description": "A collaborative group of universities sharing identity verification data to prevent fraud.",
9	"retention_policy_days": 365,
10	"match_summary": {
11	"new": 12,
12	"confirmed_fraud": 3,
13	"under_review": 5
14	}
15	}

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

Authentication

Path parameters

Headers

Response

Errors