On Demand
Search Entities
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.
Authorization
apiKey clientId x-api-key<token>
In: header
x-client-id<token>
In: header
Query Parameters
source?string
Sources in which the entity would be searched. Use: /v2/entities?source=adverseCheckEssentials
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Description @ request body.
Description @ request body.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v2/entities" \ -H "Content-Type: application/json" \ -d '{ "name": { "first": "Marcus", "last": "Whitfield", "prefix": "Dr." }, "credentials": [ { "number": "K5382916", "code": "RN", "state": "CA" }, { "number": "T0479261", "code": "MD", "state": "NY" } ], "alias": { "first": "Marc", "last": "Whitfield" }, "npi": "1739204857", "dob": "19770428", "ssn": "000482915", "customProperties": { "sourceSystem": "internal-system", "requestId": "req-001" } }'{
"status": 0,
"code": "found",
"detail": "string",
"entities": [
{
"propelusId": "string",
"score": 85,
"scoreCode": "high_confidence",
"names": [
{
"prefix": "Dr.",
"first": "string",
"middle": "string",
"last": "string",
"suffix": "string",
"full": "string"
}
],
"email": "user@example.com",
"npi": "1739204857",
"phones": [
{
"number": "+4155552671",
"type": "mobile"
}
],
"exclusions": [
{
"name": {
"prefix": "Dr.",
"first": "string",
"middle": "string",
"last": "string",
"suffix": "string",
"full": "string"
},
"address": {
"line1": "string",
"line2": "string",
"city": "string",
"state": "st",
"zip": "strin"
},
"dateOfBirth": "2019-08-24",
"additionalComments": "string",
"amendment": "string",
"excludedDate": "2019-08-24",
"excludingAgency": "HHS",
"exclusionsType": "string",
"licenseNumber": "string",
"profession": "string",
"reinstatementDate": "2019-08-24",
"npi": "string",
"additionalData": {
"medicaidProviderId": "string",
"medicareProviderNumber": "string",
"providerVerification": "string"
},
"reference": "string",
"cageCode": "string",
"listCode": "CON"
}
],
"specialtyCertifications": [
{
"type": "specialtyCertifications:abms",
"certificateId": 0,
"certificateName": "string",
"certificateType": "string",
"memberBoardId": 0,
"memberBoardName": "string",
"mocPathwayId": 0,
"mocPathwayName": "string",
"currentDurationType": "TL",
"initialCertification": {
"certificationId": 0,
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"durationType": "TL",
"reverificationDate": "2019-08-24"
},
"reCertifications": [
{
"durationType": "TL",
"certificationId": 0,
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"reverificationDate": "2019-08-24"
}
],
"status": {
"certificateStatus": "string",
"mocComplianceStatus": "string",
"modifiedDate": "2019-08-24"
},
"isDeceased": true
}
],
"boardActions": [
{
"type": "actions:fsmb",
"entity": "Department of Health and Human Services",
"orders": [
{
"date": "2025-07-18",
"effectiveDate": "2019-08-24",
"code": "OP",
"description": "Other prejudicial action",
"actions": [
{
"code": "A0244",
"description": "LICENSE ISSUED WITH A REPRIMAND",
"effectiveDate": "string",
"expirationDate": "string",
"basisCode": "string",
"basisDescription": "string"
}
]
}
]
}
],
"deaRegistrations": [
{
"type": "registration:dea",
"registrant": {
"name": "string",
"degree": "string",
"activity": {
"status": "string",
"businessCode": "string",
"businessSubCode": "string"
},
"additionalCompanyInfo": "string"
},
"contact": {
"address": "string",
"city": "string",
"state": "string",
"zipCode": "string"
},
"status": {
"transactionDate": "2019-08-24",
"expirationDate": "2019-08-24",
"paymentIndicator": "string"
},
"registrations": [
{
"deaNumber": "string",
"stateLicenseNumber": "string",
"stateCsLicenseNumber": "string",
"drugSchedules": "string"
}
]
}
],
"nppes": [
{
"type": "npi:registry",
"number": "1739204857",
"enumerationType": "NPI-1",
"entityType": "Individual",
"basic": {
"firstName": "string",
"lastName": "string",
"middleName": "string",
"namePrefix": "string",
"nameSuffix": "string",
"credential": "MD",
"soleProprietor": "YES",
"sex": "M",
"enumerationDate": "2007-01-05",
"lastUpdatedAt": "2007-07-08",
"certificationDate": "2019-08-24",
"deactivationDate": "2019-08-24",
"reactivationDate": "2019-08-24",
"replacementNpi": "string"
},
"addresses": [
{
"addressPurpose": "MAILING",
"addressType": "DOM",
"countryCode": "US",
"countryName": "United States",
"address1": "PO BOX 191227",
"address2": "string",
"city": "SAN JUAN",
"state": "PR",
"postalCode": "009191227",
"telephoneNumber": "+4155552671",
"faxNumber": "787-294-0319"
}
],
"taxonomies": [
{
"code": "174400000X",
"taxonomyGroup": "string",
"desc": "Specialist",
"state": "PR",
"license": "13731",
"primary": true
}
],
"identifiers": [
{
"identifier": "string",
"state": "string",
"issuer": "string",
"typeCode": "string",
"typeValue": "string",
"stateName": "string"
}
],
"otherNames": [
{
"lastName": "string",
"firstName": "string",
"middleName": "string",
"credential": "string",
"prefix": "string",
"suffix": "string",
"typeCode": "string",
"typeName": "Former Name"
}
]
}
],
"stateLicenses": [
{
"number": "string",
"state": "CA",
"professionCode": "RN",
"status": "active",
"expirationDate": "2025-12-31",
"taxonomies": [
{
"code": "string",
"name": "string"
}
],
"source": "string"
}
],
"dmf": {
"ssn": "string",
"deceased": true,
"isMatch": true,
"score": 95,
"middleNameDiscrepancy": false,
"dob": "1947-03-28",
"dod": "2021-09-14"
}
}
],
"customProperties": {
"property1": "string",
"property2": "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"
}Get Credentials Batch by ID GET
Retrieve credential verification results for a batch. Utilize the batch ID provided during the initial request to receive results for the batch. Propelus also provides webhook events for those looking to receive the responses as they are ready rather than polling. Note: results expire after 7 days.
Create a Professional POST
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.