Skip to main content

Step 2: Manage Licenses

Updated

Step 2 involves attaching licenses to professionals for monitoring, using CRUD operations based on professional_id and license_id. Licenses require licenseNumber, professionCode, and stateCode, with optional customProperties. Operations include listing, adding, fetching, modifying, and deleting licenses. Deleting a license permanently removes its monitoring data. Identity details remain on the professional record. 

 

With your professionals in place, Step 2 attaches the credentials you want watched. Each license you add to a professional becomes something monitoring can track. The operations mirror Step 1’s CRUD — only now, everything hangs off a professional_id.

The five operations

Licenses are nested under a professional, so every path starts with that professional’s ID. 

Get, Modify, and Delete also need the license_id Propelus assigns when you add the license.

Operation Method & endpoint What it does
List GET /v1/professionals/{professionalId}/licenses List every license on a professional.
Add POST …/{professional_id}/licenses Attach a new license.
Get GET …/licenses/{licenseId} Fetch one license’s details.
Modify PATCH …/licenses/{licenseId} Update a license.
Delete DELETE …/licenses/{licenseId} Remove a license.
(!) Identity lives on the professional
A monitoring license is lean — just which credential to watch. Name, date of birth, and other identity details come from the professional record you created in Step 1, so you don’t repeat them here.
 

Add a license

Three required fields identify the credential. Each license must be unique for the professional.

Field Required What it is
licenseNumber Required The license number. Format varies by profession and state.
professionCode Required The type of license, e.g. RN. See state & profession codes.
stateCode Required The 2-letter state code, or CERT for a national certification.
certState Conditional The 2-letter state when stateCode is CERT. Omit it if there’s no associated state.
customProperties Optional Your own license identifiers — echoed back with results.
For your technical team
POST https://api.propelus.com/v1/professionals/{professional_id}/licenses
{
  "licenseNumber": "RN1234567",
  "professionCode": "RN",
  "stateCode": "FL",
  "customProperties": { "sourceSystem": "HRIS" }
}
→ 201 Created — returns the license, including its Propelus license_id.
 

List, Get, Modify & Delete

Listing returns every license on the professional. Get, modify, and delete target a single license by its license_id.

GET   /v1/professionals/{professionalId}/licenses → 200, all licenses
GET  /v1/professionals/licenses/{licenseId} → 200, one license
PATCH /v1/professionals/licenses/{licenseId} → 200, status / code / detail
DELETE/v1/professionals/licenses/{licenseId} → 200, status / code / detail

A list response nests the licenses inside an items object, with size counts so you can tell how many came back:

{
  "items": {
    "id": "497f6eca-6276-49f1-a9b3-1c2d3e4f5a6b",
    "items": [
      {
        "licenseNumber": "RN1234567",
        "professionCode": "RN",
        "stateCode": "FL",
        "certState": "",
        "customProperties": {}
      }
    ],
    "size": 1
  },
  "size": 1
}

Modify and Delete return a small confirmation envelope — code tells you what happened (created, updated, or deleted):

{
  "status": 0,
  "code": "updated",
  "detail": "License updated."
}
 
(!) Deleting a license is permanent
Removing a license also permanently deletes its monitoring results. 
There’s no undo — delete only when you’re sure you no longer need that credential watched.

 

Where to go next

Licenses attached? Continue to Step 3: Associate Monitoring Products — the step that takes monitoring live.