Retrieves monitoring details for a professional.
Using the [professionalId], retrieve all relevant monitoring details for a professional.
Endpoint:
HTTP Method: GET
Path: /v2/monitoring/results
Server URL: https://api.propelus.com
Developer Docs: https://propelus.com/developer/monitoring/GetProfessionalMonitoringResults
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 |
| professionalId | string (UUID) | Yes | Unique identifier for the professional. |
Example Request — JavaScript
fetch("https://api.propelus.com/v2/monitoring/results?professionalId=628fc8e2-ee7e-4779-9eb7-d980e7a92f3a", {
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/monitoring/results?professionalId=628fc8e2-ee7e-4779-9eb7-d980e7a92f3a" \
-H "x-api-key: <your-api-key>" \
-H "x-client-id: <your-client-id>"Responses
200 — Success
Returns an array of the professional's monitoring records — each with its status and, for credential verifications, the verification result and last execution log.
[
{
"id": "628fc8e2-ee7e-4779-9eb7-d980e7a92f3a",
"status": "active",
"product": "credentialVerification",
"productCategory": "automated",
"nextScheduledDate": "2025-01-15",
"verification": {
"result": {
"status": 0,
"detail": "string",
"code": "string",
"input": {
"credential": {
"number": "string",
"code": "RN",
"state": "CA",
"certState": "CA"
},
"name": {
"prefix": "Dr.",
"first": "string",
"middle": "string",
"last": "string",
"suffix": "string"
},
"dob": "19770428",
"ssn": "000482915",
"zipCode": "string",
"customProperties": {
"property1": "string",
"property2": "string"
}
},
"verification": {
"isFound": true,
"lastName": "HOLLOWAY",
"firstName": "TOBIAS",
"middleName": "R",
"customFields": {
"boardName": "FLORIDA API TESTING BOARD",
"COMPACT_STATUS": "SINGLE STATE",
"property1": "string",
"property2": "string"
},
"credentialNumber": "908398",
"credentialStatus": "INACTIVE",
"screenshotURL": "http://example.com",
"expirationDate": "2024-05-18T00:00:00.000Z",
"originalIssueDate": "2002-04-01T00:00:00.000Z",
"disciplinaryAction": false,
"useScreenshotTemplate": true
}
},
"runId": "628fc8e2-ee7e-4779-9eb7-d980e7a92f3a",
"date": "2024-01-15T13:45:30Z"
},
"lastExecutionLog": {
"status": "success",
"result": {},
"date": "2024-01-15T13:45:30Z"
}
}
]Error Responses
Standardized error bodies. Validation-style errors include an errors array; each item contains detail, pointer, parameter, header, and code: https://propelus.com/developer/monitoring/GetProfessionalMonitoringResults#response-body
400 — Bad Request
401 — Unauthorized
403 — Forbidden
404 — Not Found
4XX — Client Error
5XX — Server Error