API ReferenceConsortiums

Update match status

Update the investigation status of a consortium match. Terminal statuses (confirmed_fraud, false_positive, resolved) trigger a consortium.match_resolved webhook to both organizations involved.

Setting status to confirmed_fraud automatically triggers fraud ring detection via BFS traversal of connected sessions.

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:

Request

This endpoint expects an object.
statusenumRequired
Allowed values:
resolution_notesstring or nullOptional
Optional notes about the investigation outcome.

Response

Updated match.
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
422
Unprocessable Entity Error