Assign a monitoring product to a professional.
Configures a monitoring product to the Propelus-generated professional [id].
Endpoint:
HTTP Method: POST
Path: /v2/monitoring
Server URL: https://api.propelus.com
Source: https://propelus.com/developer/monitoring/CreateProfessionalMonitoring
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 |
Request Body
Content type: application/json
| Field | Type | Required | Description / Constraints |
| professionalId | string (UUID) | Yes |
Professional Id to be monitored. See Create a Professional. |
| product | MonitoringProduct | Yes |
Type of monitoring product to be configured for the professional. |
product allowed values:
"credentialVerification" | "adverseCheckEssentials" | "adverseCheckPro"
Example Request — JSON
const body = JSON.stringify({
"professionalId": "76b04dae-ca2e-47d8-b4d8-993fdf9ec3a5",
"product": "credentialVerification"
})
fetch("https://api.propelus.com/v2/monitoring", {
method: "POST",
headers: {
"Content-Type": "application/json",
"x-api-key": "<your-api-key>",
"x-client-id": "<your-client-id>"
},
body
})Example Request — cURL
curl -X POST "https://api.propelus.com/v2/monitoring" \
-H "x-api-key: <your-api-key>" \
-H "x-client-id: <your-client-id>" \
-H "Content-Type: application/json" \
-d '{
"professionalId": "76b04dae-ca2e-47d8-b4d8-993fdf9ec3a5",
"product": "credentialVerification"
}'Responses
202 — Accepted
Monitoring is queued and the response lists the monitors created. The page documents three example scenarios; two are shown below. A third — "credentialVerification — professional has no credentials yet" — is also documented on the page.
adverseCheckEssentials — professional monitored:
{
"code": "accepted",
"detail": "Monitoring for adverseCheckEssentials has been created for the professional.",
"professionalId": "628fc8e2-ee7e-4779-9eb7-d980e7a92f3a",
"product": "adverseCheckEssentials",
"monitors": [
{
"id": "8ed1671f-2912-44ff-876e-befb5cb5134a",
"status": "ready",
"product": "adverseCheckEssentials",
"productCategory": "automated",
"nextScheduledDate": "2026-05-15"
}
]
}credentialVerification — credentials being monitored:
{
"code": "accepted",
"detail": "Monitoring for credentialVerification has been created for the credentials of the professional.",
"professionalId": "628fc8e2-ee7e-4779-9eb7-d980e7a92f3a",
"product": "credentialVerification",
"monitors": [
{
"id": "043ec207-e195-4be4-849e-7893e12984dd",
"status": "ready",
"product": "credentialVerification",
"productCategory": "automated",
"nextScheduledDate": "2026-05-15"
},
{
"id": "e5325a86-3f1d-4797-864d-f07f35fdcd43",
"status": "ready",
"product": "credentialVerification",
"productCategory": "manualVerification",
"nextScheduledDate": "2026-05-15"
},
{
"id": "875521dd-f329-48a5-95a9-e7ac7ba94128",
"status": "running",
"product": "credentialVerification",
"productCategory": "automated",
"nextScheduledDate": "2026-05-15"
}
]
}credentialVerification — professional has no credentials yet:
{
"code": "pending",
"detail": "Monitoring for credentialVerification has been created, but the professional has no credentials to monitor.",
"professionalId": "628fc8e2-ee7e-4779-9eb7-d980e7a92f3a",
"product": "credentialVerification",
"monitors": []
}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/CreateProfessionalMonitoring#response-body
400 — Bad Request
401 — Unauthorized
403 — Forbidden
404 — Not Found
4XX — Client Error
5XX — Server Error