Value Sets


Value sets returns a list of all the available datasets in the API and their corresponding values. With no query parameters, you get an array of the available datasets containing an id, name and description.

GET /api/v1/metadata/valuesets

When you pass the ID of the value set into query parameter, you get a single object containing an id, name and description.

GET /api/v1/metadata/valuesets/{id}

When you pass the ID, and add '/values' to the URI you get a response containing all the allowable values for that dataset.

Currently, these are datasets available in the API:

  • List of titles
  • List of genders
  • FCA/PRA approved values
  • Driving licence types
  • Lists the final report format options
  • Lists the different applicant types for order submission
  • Order Report Layouts
  • List of Refinement options for checks
  • Self employment status values for employment checks
  • Options for how soon Verifile can contact the employer for employment checks
  • Candidates reason for leaving the employer for employment checks
  • List of Membership Statuses
  • Nationality
  • List of 2 letter country codes (ISO 3166)
  • DBS Job Roles
  • DBS Check's purpose
  • DBS check's paper certificate destination when chosen
  • DBS Identity Documents
  • Filtered set of DBS Identity Documents
  • Candidate's consent to allow 3rd party to access DBS electronic certificate
  • List of document proofs of residential address for Disclosure Scotland checks
  • List of document proofs of candidate's identity for Disclosure Scotland checks
  • List of employment statuses for employment checks

Locality is a language tag (combination ISO 639-1 and ISO 3166-2). The default is "en-GB" and is currently the one only that is supported.

GET /api/v1/ metadata/valuesets/{id}/values