Total Professional Check provides a consolidated professional profile in one API call, including matched identity, NPI, phone numbers, and any exclusions or sanctions. It requires a name and optionally accepts aliases, licenses, NPI, phone number, and more to refine the search. The response includes matched identities with confidence scores and detailed professional data, enabling a comprehensive view beyond just exclusions or sanctions.
What you send
It’s an identity search — only name is required, and every extra detail sharpens the match. Provide aliases, licenses, NPI, or a phone number to narrow it down.
| Field | Required | What it is |
|---|---|---|
| name | Required | The professional’s name. |
| names[] | Optional | Name plus aliases. If provided, the single name is ignored. Each entry has a name. |
| licenses[] | Optional | One or more licenses. Each: number (required), professionCode, stateCode (two-letter). |
| npi | Optional | 10-digit National Provider Identifier. |
| phoneNumber | Optional | 10-digit phone number. |
| dob | Optional | Date of birth, YYYYMMDD (partial allowed). Coming soon. |
| customProperties | Optional | Free-format object — echoed back on the response. |
{
"name": "Jordan Rivera",
"names": [
{ "name": "Jordan Rivera" },
{ "name": "J. Rivera" }
],
"licenses": [
{ "number": "RN1234567", "professionCode": "RN", "stateCode": "CO" }
],
"npi": "9853245678",
"phoneNumber": "8006936286"
}
What comes back
A code plus a list of matched identities. Each carries a full professional profile — and unlike the exclusions checks, every match includes a stable propelusId and typed phone numbers.
| Field | What it tells you |
|---|---|
| code |
found or not_found. |
| items[] | The matched identities. |
| propelusId | Propelus’ stable identifier for the matched professional. |
| npi | NPI of the matched professional. |
| score | Match confidence score. |
| names[] | Name parts: first, middle, last, prefix, suffix, fullName. |
| phones[] | Phone numbers, each with a number and a type. |
| exclusions[] | Any exclusion / sanction records found — same shape as the exclusions checks. |
{
"code": "found",
"items": [
{
"professional": {
"propelusId": "a1b2c3d4",
"npi": "9853245678",
"score": 87,
"names": [
{ "first": "Jordan", "last": "Rivera", "fullName": "Jordan M Rivera" }
],
"phones": [
{ "number": "8006936286", "type": "mobile" }
],
"attributes": {
"exclusions": [ { /* matched exclusion records — see exclusions checks */ } ]
}
}
}
]
}score
Where to go next
The exclusion records mirror the exclusions & sanctions checks. For the meaning of every status, see verification result codes.