Propelus
Monitoring

Create a Professional

The first step in enrolling a professional and/or their credentials in monitoring is to create the professional in the Propelus system. From there, you will complete steps to create the credentials and select the product you'd like to enroll them in.

Create a professional with relevant demographic details. The only required fields are the professional's name and an associated ID.

POST
/v2/professionals

Authorization

apiKey clientId
x-api-key<token>

In: header

x-client-id<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

body for professional object.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v2/professionals" \  -H "Content-Type: application/json" \  -d '{    "externalId": "T-100",    "name": {      "first": "string",      "last": "string"    }  }'
{
  "status": 200,
  "detail": "string",
  "code": "created",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
{
  "status": 400,
  "code": "missing_fields",
  "detail": "string",
  "errors": [
    {
      "detail": "string",
      "pointer": "string",
      "parameter": "string",
      "header": "string",
      "code": "string"
    }
  ]
}
{
  "status": 400,
  "code": "missing_fields",
  "detail": "string",
  "errors": [
    {
      "detail": "string",
      "pointer": "string",
      "parameter": "string",
      "header": "string",
      "code": "string"
    }
  ]
}
{
  "status": 400,
  "code": "missing_fields",
  "detail": "string",
  "errors": [
    {
      "detail": "string",
      "pointer": "string",
      "parameter": "string",
      "header": "string",
      "code": "string"
    }
  ]
}
{
  "status": 429,
  "detail": "string",
  "code": "f5d62b05-370e-48be-a755-8675ca146431"
}
{
  "status": 400,
  "code": "missing_fields",
  "detail": "string",
  "errors": [
    {
      "detail": "string",
      "pointer": "string",
      "parameter": "string",
      "header": "string",
      "code": "string"
    }
  ]
}
{
  "status": 500,
  "detail": "string",
  "code": "unexpected_error"
}

Search Entities POST

Search for adverse actions associated with a professional or an organization. Adverse actions are sourced from primary sources directly. You may also sort by specific sources if necessary. Either `name` or `npi` is required — you may provide both. Additional identifiers help reduce false positives.

Get Professionals GET

Retrieves a paginated list of professionals.