Retrieve the verification status of professions verified by Propelus.
Endpoint: GET /v2/professions
Source: https://propelus.com/developer/professions/getProfessions
Authorization
Authorization is passed via HTTP headers using apiKey + clientId:
-
x-api-key: <token>(in: header) -
x-client-id: <token>(in: header)
Query Parameters
All query parameters are optional.
| Parameter | Type | Description |
|---|---|---|
professionState |
string | Filters on profession state code |
professionCode |
string | Filters profession code when known |
boardName |
string | Filters the board name. Allows partial names |
professionName |
string | Filters on profession name |
professionStatus |
string | Filters on profession status. Value in: "automated" | "manual" | "interrupted"
|
Example Request Types
JSON
fetch("https://api.propelus.com/v2/professions", {
method: "GET",
headers: {
"x-api-key": "[your apiKey]",
"x-client-id": "[your clientId]"
}
})cURL
curl -X GET "https://example.com/v2/professions" -H "x-api-key: [your apiKey]" \ -H "x-client-id: [your clientId]"
Response Body
200 — application/json
{
"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
}4XX
Empty
5XX
Empty