Add a credential to a professional using the professional's ID.
After creating a professional, you will then add any relevant credentials using the professional ID generated during the creation of the professional, in Step 1. Creating credentials is optional if the professional is being enrolled in an AdverseCheck package.
An important note: after creating the professional's credentials, you will need to enroll them in a monitoring product (step 3).
Endpoint:
HTTP Method: POST
Path: /v2/professionals/{professionalId}/credentials
Server URL: https://api.propelus.com
Developer Docs: https://propelus.com/developer/monitoring/CreateProfessionalCredential
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 |
Path Parameters
| Parameter | Type | Required | Description |
| professionalId | string (UUID) | Yes |
Unique identifier for the professional. |
Request Body
Content type: application/json
| Field | Type | Required | Description / Constraints |
| number | string | Yes |
Credential number. Length ≤ 20. |
| code | string | Yes |
Propelus Code® associated with the credential type. Length ≤ 20. |
| state | string | Yes |
Two-letter state code where the credential is issued. Length: 2 ≤ length ≤ 4. |
| certState | string | No |
Optional two-letter state code. Only meaningful when state is CERT. Length ≤ 2. |
| customProperties | object | null | No |
Additional properties to be stored with the professional or credential. Properties ≤ 10. |
Example Request — JSON
const body = JSON.stringify({
"number": "string",
"code": "RN",
"state": "CA"
})
fetch("https://api.propelus.com/v2/professionals/628fc8e2-ee7e-4779-9eb7-d980e7a92f3a/credentials", {
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/professionals/628fc8e2-ee7e-4779-9eb7-d980e7a92f3a/credentials" \
-H "x-api-key: <your-api-key>" \
-H "x-client-id: <your-client-id>" \
-H "Content-Type: application/json" \
-d '{
"number": "string",
"code": "RN",
"state": "CA"
}'Responses
201 — Created
{
"status": 201,
"code": "created_non_monitored",
"detail": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}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/CreateProfessionalCredential#request-body
400 — Bad Request
401 — Unauthorized
403 — Forbidden
404 — Not Found
4XX — Client Error
5XX — Server Error