Retrieve the verification status of professions verified by Propelus.

Endpoint:

HTTP Method: GET

Path: /v2/professions

Server URL: https://api.propelus.com

Developer Docs: https://propelus.com/developer/professions/getProfessions

Authentication

Two header-based authentication methods are required:

Header	Type	In	Description
x-api-key	token	header	API key credential
x-client-id	token	header	Client identifier credential

Query Parameters

Parameter	Type	Required	Description
professionState	string	No	Filters profession state code.
professionCode	string	No	Filters profession code when known.
boardName	string	No	Filters the board name. Allows partial names.
professionName	string	No	Filters on profession name.
professionStatus	string	No	Filters on profession status. Allowed values: "automated" \| "manual" \| "interrupted".

Example Request — JSON

fetch("https://api.propelus.com/v2/professions", {
  method: "GET",
  headers: {
    "x-api-key": "<your-api-key>",
    "x-client-id": "<your-client-id>"
  }
})

Example Request — cURL

curl -X GET "https://api.propelus.com/v2/professions" \
  -H "x-api-key: <your-api-key>" \
  -H "x-client-id: <your-client-id>"

Responses

200 — Success

Returns the list of professions Propelus can verify, each with its board details, license-number format, search criteria, verification type, and status. Use professionCode / professionState when submitting credentials to other endpoints.

{
  "code": "string",
  "message": "string",
  "items": [
    {
      "additionalBoardFee": false,
      "professionStatus": "MANUAL",
      "boardName": "Alabama Board of Nursing",
      "boardUrl": "https://abn.alabama.gov/applications/LicenseLookupInfo.aspx",
      "disciplinaryActionTracking": true,
      "licenseFormatRegex": "^[0-9]{9}$",
      "licenseFormatRegexMask": "012345678",
      "professionName": "Registered Nurse Alabama",
      "searchCriteria": [
        "licenseNumber",
        "professionCode"
      ],
      "verificationType": "WEB",
      "professionState": "AL",
      "professionCode": "RN"
    }
  ],
  "size": 0
}

Error Responses

This endpoint documents its error responses with no body — the 4XX and 5XX examples on the page are empty: https://propelus.com/developer/professions/getProfessions#response-body

4XX — Client Error

No response body.

5XX — Server Error