Get match detail

GET

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

GET

/api/v1/consortiums/:consortium_id/matches/:match_id

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

1 {
2   "id": "cm_7f9d3a2b",
3   "consortium_id": "cons_42a1f9e7",
4   "match_type": "face",
5   "status": "under_investigation",
6   "created_at": "2024-01-12T14:22:00Z",
7   "face_similarity_score": 0.87,
8   "name_mismatch": false,
9   "dob_mismatch": false,
10   "document_type_mismatch": false,
11   "document_number_match": true,
12   "email_match": false,
13   "phone_match": true,
14   "device_match": false,
15   "days_between": 3,
16   "ghost_student_score": 45,
17   "ghost_student_tier": "monitor",
18   "primary_session_id": "sess_9c8b7d4f",
19   "primary_org_id": "org_12345",
20   "matched_session_id": "sess_4d3e2f1a",
21   "matched_org_id": "org_67890",
22   "primary_org_name": "Greenwood University",
23   "matched_org_name": "Lakeside College",
24   "investigated_by": "jane.doe@greenwood.edu",
25   "investigated_at": "2024-01-15T09:30:00Z",
26   "resolution_notes": "Initial review indicates possible identity overlap; further investigation required.",
27   "updated_at": "2024-01-15T09:30:00Z"
28 }

Returns detailed information about a specific consortium match. Your organization must be involved in the match (as primary or matched org).

Authentication

X-API-Keystring

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

Path parameters

consortium_idstringRequired

match_idstringRequired

Response

Match details.

idstring

consortium_idstring

match_typeenum

statusenum

created_atdatetime

face_similarity_scoredouble or null

Cosine similarity between face embeddings (0–1).

name_mismatchboolean

True if the names on the two sessions differ.

dob_mismatchboolean

True if the dates of birth differ.

document_type_mismatchboolean

document_number_matchboolean

True if the same document number appears at both orgs.

email_matchboolean

phone_matchboolean

device_matchboolean

days_betweeninteger or null

Days between the two sessions' creation dates.

ghost_student_scoreinteger or null

Composite fraud risk score (0–100).

ghost_student_tierenum

Risk tier derived from ghost_student_score.

primary_session_idstring or null

Present when sharing_level is “match_details” or higher.

primary_org_idstring or null

matched_session_idstring or null

matched_org_idstring or null

primary_org_namestring or null

matched_org_namestring or null

investigated_bystring or null

investigated_atdatetime or null

resolution_notesstring or null

Present when sharing_level is “full_investigation”.

updated_atdatetime

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

Authentication

Path parameters

Headers

Response

Errors