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.
Note: when enrolling a business, it is required to use the full name option in the name object.
Authorization
apiKey clientId In: header
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 '{}'{
"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. _Note:_ when searching for adverse actions against a business, it is required to use the full name option in the name object. The product you request in `source` determines which result sets come back. `adverseCheckEssentials` returns matched records in `entities`. `adverseCheckPro` additionally returns `proEntities` — adverse actions reported alongside `entities` rather than resolved to a `propelusId`. The pro search within `adverseCheckPro` requires a first **and** last name it can resolve: either `first` + `last`, or a `full` containing at least two words. Any `dob` and `credentials` you send are forwarded as additional match input — the name is simply the one input the search cannot run without. When a first and last name cannot be resolved — a single-word `full`, or a request identified only by `npi` — the pro search cannot run: `proEntities` is omitted and a `warnings` entry explains why. Every other requested search whose own required inputs are present still runs and returns normally. Note that `adverseCheckPro` also includes the Death Master File search, which needs both `ssn` and `name`, so a request without `ssn` skips that search too and returns a second `warnings` entry for `dmf`. The request itself still succeeds. _Note:_ a `warnings` entry means the search never happened. Treat it as "unknown", not as "nothing found" — `code` and the result sets only describe the searches that ran.
List Professionals GET
Retrieves a paginated list of professionals.