List consortium matches

GET

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

GET

/api/v1/consortiums/:consortium_id/matches

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

1 {
2   "data": [
3     {
4       "id": "cm_9f8b7c6d",
5       "consortium_id": "cons_42a1f3e9",
6       "match_type": "face",
7       "status": "under_investigation",
8       "created_at": "2024-04-07T09:15:00Z",
9       "face_similarity_score": 0.87,
10       "name_mismatch": false,
11       "dob_mismatch": false,
12       "document_type_mismatch": false,
13       "document_number_match": true,
14       "email_match": false,
15       "phone_match": true,
16       "device_match": false,
17       "days_between": 3,
18       "ghost_student_score": 45,
19       "ghost_student_tier": "monitor",
20       "primary_session_id": "sess_1234abcd",
21       "primary_org_id": "org_5678efgh",
22       "matched_session_id": "sess_9876wxyz",
23       "matched_org_id": "org_4321ijkl",
24       "primary_org_name": "Greenwood University",
25       "matched_org_name": "Lakeside College",
26       "investigated_by": "investigator_jdoe",
27       "investigated_at": "2024-04-10T14:45:00Z",
28       "resolution_notes": "Further review required due to conflicting document types.",
29       "updated_at": "2024-04-10T15:00:00Z"
30     }
31   ],
32   "pagination": null
33 }

Returns cross-org matches within a consortium. Results are scoped to matches involving your organization. The fields returned depend on the consortium’s sharing_level setting.

Authentication

X-API-Keystring

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

Path parameters

consortium_idstringRequired

Query parameters

statusenumOptional

Filter by match status.

Allowed values:

match_typeenumOptional

Filter by match type.

Allowed values:

limitintegerOptional<=100Defaults to 25

offsetintegerOptionalDefaults to 0

Response

Paginated list of matches.

datalist of objects

paginationany

Errors

401

Unauthorized Error

403

Forbidden Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors