Skip to main content
GET
/
v3
/
verifications
/
{verification_id}
Retrieve a verification
curl --request GET \
  --url https://api.ctrl-hub.com/v3/verifications/{verification_id} \
  --header 'X-Session-Token: <api-key>'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "attributes": {
      "ref_type": "induction-completions",
      "verified_at": "2023-11-07T05:31:56Z"
    },
    "relationships": {
      "author": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "organisation": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "induction_completion": {
        "data": {
          "type": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "training_completion": {
        "data": {
          "type": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "assessment_record": {
        "data": {
          "type": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "registration": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "category_registration": {
        "data": {
          "type": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "scheme_registration": {
        "data": {
          "type": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      }
    }
  },
  "jsonapi": {
    "version": "<string>"
  },
  "included": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "email": "jsmith@example.com",
        "identities": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "platform": "<string>",
            "meta": {}
          }
        ],
        "profile": {
          "work": {
            "occupation": "<string>",
            "cscs": "<string>",
            "eusr": "<string>",
            "start_date": "2023-12-25"
          },
          "personal": {
            "first_name": "<string>",
            "last_name": "<string>",
            "dob": "2023-12-25",
            "username": "<string>"
          },
          "contact": {
            "mobile": "<string>",
            "landline": "<string>"
          },
          "address": {
            "number": "",
            "street": "<string>",
            "area": "<string>",
            "town": "<string>",
            "county": "<string>",
            "postcode": "<string>",
            "country_code": "<string>",
            "what3words": "<string>"
          },
          "settings": {
            "preferred_language": "en-GB",
            "timezone": "<string>"
          }
        }
      },
      "meta": {
        "grants": [
          "<string>"
        ]
      },
      "relationships": {
        "organisations": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "teams": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "managing_organisation": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        }
      }
    }
  ]
}

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