API ReferenceConsortiums

Get match detail

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

Headers

Verifa-VersiondateOptional

API version date string (e.g. 2026-02-01). If omitted, the version pinned to your API key is used.

Key-InflectionenumOptionalDefaults to snake

Response key casing. Defaults to snake.

Allowed values:

Response

Match details.
idstring
consortium_idstring
match_typeenum
statusenum
created_atdatetime
face_similarity_scoredouble or nullOptional

Cosine similarity between face embeddings (0–1).

name_mismatchbooleanOptional
True if the names on the two sessions differ.
dob_mismatchbooleanOptional
True if the dates of birth differ.
document_type_mismatchbooleanOptional
document_number_matchbooleanOptional
True if the same document number appears at both orgs.
email_matchbooleanOptional
phone_matchbooleanOptional
device_matchbooleanOptional
days_betweeninteger or nullOptional
Days between the two sessions' creation dates.
ghost_student_scoreinteger or nullOptional

Composite fraud risk score (0–100).

ghost_student_tierenumOptional

Risk tier derived from ghost_student_score.

primary_session_idstring or nullOptional

Present when sharing_level is “match_details” or higher.

primary_org_idstring or nullOptional
matched_session_idstring or nullOptional
matched_org_idstring or nullOptional
primary_org_namestring or nullOptional
matched_org_namestring or nullOptional
investigated_bystring or nullOptional
investigated_atdatetime or nullOptional
resolution_notesstring or nullOptional

Present when sharing_level is “full_investigation”.

updated_atdatetimeOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error