List Master Qualifications

GET/master-qualifications

Caller

This endpoint is available to any authenticated Open API key.

Summary

Returns active master qualifications used for worker documents. Master qualifications are Requidex's shared definitions for document types such as passports, visas, CVs, and CSCS cards.

Use this endpoint to determine which request collection a document belongs in, the minimum file count, expiry rules and whether the document is agency-specific, and whether CSCS Smart Check applies. Internal classification tags are not returned.

Query Parameters

Name	Type	Required	Description
query	string	No	Case-insensitive name search
page	integer	No	Page number (default 1)
limit	integer	No	Records per page (default 50, max 200)
sortBy	enum(name)	No	Sort field
sortOrder	enum(asc, desc)	No	Sort direction
fields	string	No	Comma-separated response fields or nested dot paths

Request Example

cURL

curl -X GET 'https://api.requidex.com/api/open/v1/master-qualifications' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Accept: application/json'

JavaScript

const response = await fetch("https://api.requidex.com/api/open/v1/master-qualifications", {
  method: "GET",
  headers: {
    Authorization: "Bearer <API_KEY>",
    Accept: "application/json",
  },
});

const json = await response.json();

Python

import requests

response = requests.get(
    'https://api.requidex.com/api/open/v1/master-qualifications',
    headers={
        'Authorization': 'Bearer <API_KEY>',
        'Accept': 'application/json',
    },
    timeout=30,
)

print(response.json())

Go

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://api.requidex.com/api/open/v1/master-qualifications", nil)
  req.Header.Set("Authorization", "Bearer <API_KEY>")
  req.Header.Set("Accept", "application/json")

  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)
  fmt.Println(string(body))
}

Response Fields

Field	Type	Description
success	boolean	Whether the request succeeded
data	array[object]	Master qualifications for the requested page. Show child attributes id string - Master qualification ID used as documentId in worker requests name string - Qualification or document name documentCollection enum - attachments, rightToWork, or identity. Worker create/update accepts the first two collections minUploadRequired integer - Minimum number of files required for the document agencySpecific boolean - Whether the attachment belongs only to the agency that added it; for example, a CV expiry object Show child attributes expires boolean - Whether an expiry date in YYYY-MM-DD format is required indefinite boolean - Whether the qualification is always treated as indefinite either boolean - Whether either an expiry date or indefinite: true is accepted smartCheck object Show child attributes eligible boolean - Whether Requidex automatically performs CSCS Smart Check when this document is created or updated
meta	object	Pagination metadata. Show child attributes page integer - Current page number limit integer - Maximum records returned per page total integer - Total matching records

Response Example (200)

{
  "success": true,
  "data": [
    {
      "id": "67bc36db80a1616ec3f47234",
      "name": "Visa",
      "documentCollection": "rightToWork",
      "minUploadRequired": 1,
      "agencySpecific": false,
      "expiry": { "expires": true, "indefinite": false, "either": false },
      "smartCheck": { "eligible": false }
    },
    {
      "id": "67bc36db80a1616ec3f47235",
      "name": "CSCS",
      "documentCollection": "attachments",
      "minUploadRequired": 2,
      "agencySpecific": false,
      "expiry": { "expires": true, "indefinite": false, "either": false },
      "smartCheck": { "eligible": true }
    },
    {
      "id": "67bc36db80a1616ec3f47236",
      "name": "CV",
      "documentCollection": "attachments",
      "minUploadRequired": 1,
      "agencySpecific": true,
      "expiry": { "expires": false, "indefinite": true, "either": false },
      "smartCheck": { "eligible": false }
    }
  ],
  "meta": { "page": 1, "limit": 50, "total": 3 }
}