Skip to main content
GET
Retrieve a verification

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

verification_id
string<uuid>
required

The unique identifier for the verification.

Query Parameters

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
author,
organisation,
induction_completion,
training_completion,
assessment_record,
registration,
category_registration,
scheme_registration

Response

Get a verification.

JSON API response object

data
object
required

A verification records that a specific record (identified by ref_type and ref_id) was verified by a user at a point in time. The response surfaces the target record via a typed relationship key (one of induction_completion, training_completion, assessment_record, registration, category_registration, scheme_registration) — exactly one is populated per verification.

jsonapi
object
required
included
object[]

Related resources that can be included when a verification is returned

A user