Propelus is migrating from APIv1 to a streamlined APIv2 with a unified base URL, new authentication using x-api-key and x-client-id headers, consolidated endpoints, and unified webhook hosting.

Deprecated endpoints include legacy token authentication and Profiles. Monitoring now requires a three-step enrollment process, and new capabilities such as dedicated Entity Search are introduced. Complete developer documentation is available at https://propelus.com/developer/getting-started

About this guide

Propelus APIv2 brings a clean, consolidated set of endpoints under a single https://api.propelus.com/v2/ base. This guide maps every v1 endpoint to its v2 counterpart, so you can plan your migration with confidence. Endpoints are grouped by product area; within each group you'll find the operation, a short description, the v1 path, the v2 path, and a link to the relevant v2 developer documentation.

⚠️ Full v2 developer reference pages are live at propelus.com/developer
(and developer.propelus.com for v1)

What's changing, at a glance

• New authentication. v2 drops the v1 authentication endpoint — authenticate each v2 request with x-api-key and x-client-id in the message header.

• Consolidated resources. Multiple v1 verification endpoints now map to a single /v2/credentials resource; the Identity and AdverseCheck endpoints unify under /v2/entities (tier is selected via a “?source= “ parameter).

• Unified API host. Webhooks move from integrations.propelus.com over to a shared api.propelus.com/v2 base, so every v2 call uses one host.

• Restructured monitoring. Enroll in three steps — (1) create the professional, (2) attach credentials, then (3) assign a monitoring product.

• Retired endpoints. Legacy authentication, token-introspection, and the v1 Profiles endpoint are deprecated in v2.

• New capabilities. v2 introduces operations with no v1 equivalent, such as dedicated Entity Search.

Authentication

APIv1 issued a bearer token from an auth endpoint. v2 removes that step: every v2 request is authenticated directly via x-api-key and x-client-id in the request header. The legacy v1 token and introspection endpoints are retired.

Operation

APIv1 endpoint

APIv2 endpoint

Status

Get access token

POST

v1 OAuth token request. v2 has no token step — pass x-api-key + x-client-id headers on every call.

https://auth.propelus.com
/v1/auth/token

DEPRECATED

Token introspection

POST

v1 token validation. Not required under v2 key-based auth.

https://api.propelus.com
/v1/token/introspect

DEPRECATED

Verification (License & Certification)

The previously separate v1 license and license-and-certification verification endpoints are consolidated into a single v2 Credentials resource. Submit a batch to /v2/credentials, then retrieve results by batch ID (or receive them via webhook).

Operation	APIv1 endpoint(s)	APIv2 endpoint	Developer Documentation
Submit verification (License & Cert) POST Consolidated into the same /v2/credentials submission.	https://api.propelus.com /v1/licenses/verify https://api.propelus.com /v1/licensesandcertifications/verify	https://api.propelus.com /v2/credentials	On-Demand / Verify Credentials Batch
Get results (License & Cert) GET Consolidated into the same /v2/credentials results call.	https://api.propelus.com /v1/licensesandcertifications/results/	https://api.propelus.com /v2/credentials/{batchId}	On-Demand / Get Credentials Batch by ID
Get results by batch GET Retrieve batch results by batch ID. Results expire after 7 days; webhooks are available.	https://api.propelus.com /v1/licenses/results/ {batchId}	https://api.propelus.com /v2/credentials/{batchId}	On-Demand / Get Credentials Batch by ID

Exclusions & Sanctions

⚠️Identity Search and the AdverseCheck Essentials/Pro endpoints are unified into the new v2 Entities resource. In v2, the check tier is selected with a query parameter:
(?source=adverseCheckEssentials or ?source=adverseCheckPro).

Either a name or an NPI is required. Additional identifiers reduce false positives

Operation	APIv1 endpoint	APIv2 endpoint	Developer Documentation
Identity Search POST Search adverse actions associated with a professional or organization.	https://api.propelus.com /v1/identity/search	https://api.propelus.com /v2/entities	On-Demand / Search Entities
AdverseCheck (Essentials) POST Foundational adverse-action screening for professionals and organizations.	https://api.propelus.com /v1/adversecheck/ essentials	https://api.propelus.com /v2/entities?source=adverseCheckEssentials	On-Demand / Search Entities
AdverseCheck (Pro) POST Expanded screening for professionals and organizations, with broader coverage.	https://api.propelus.com /v1/adversecheck/pro	https://api.propelus.com /v2/entities?source=adverseCheckPro	On-Demand / Search Entities
Entity search POST Unified adverse-action search for professionals and organizations. Name and/or NPI is required; additional identifiers reduce false positives.	New in v2	https://api.propelus.com /v2/entities	On-Demand / Search Entities

Total Professional Check

The v1 Profiles endpoint is retired in v2.

Operation

API v1 endpoint

API v2 endpoint

Status

Profiles

POST

Retired in v2.

https://api.propelus.com
/v1/profiles

DEPRECATED

SSADMF (Deceased Search)

The Social Security Administration Death Master File search is now available in v2.

Operation

API v1 endpoint

API v2 endpoint

Status

Deceased search

POST

Death Master File (deceased) check.

https://api.propelus.com
/v1/deceased/search

https://api.propelus.com
/v2/entities?source=deceased

AVAILABLE

Monitoring

Continuous monitoring in v2 follows three steps: (1) create the professional, (2) optionally attach credentials, then (3) enroll in a monitoring product. ⚠️ Step-order matters.

Products include: credentialVerification, adverseCheckEssentials, and adverseCheckPro.

Operation	APIv1 endpoint	APIv2 endpoint	Developer Documentation
Add professionals POST Enrollment step 1* — create the professional (name + your ID required).*	https://api.propelus.com /v1/professionals	https://api.propelus.com /v2/professionals	Monitoring / Create a Professional
Add license(s) POST Enrollment step 2* — attach credentials to the professional (optional for AdverseCheck packages).*	https://api.propelus.com /v1/professionals/ {professionalId}/licenses	https://api.propelus.com /v2/professionals/ {professionalId}/ credentials	Monitoring / Create a Professional's Credential
Add products POST Enrollment step 3* — assign a monitoring product to the professional.*	https://api.propelus.com /v1/professionals/ monitoring/ {professionalId}	https://api.propelus.com /v2/monitoring professionalId is submitted in the request body	Monitoring / Create Professional Monitoring Product
Manage professionals GET PATCH DELETE Retrieve, update, or remove enrolled professionals.	https://api.propelus.com /v1/professionals/ {professionalId} https://api.propelus.com /v1/professionals (list all)	https://api.propelus.com /v2/professionals/ {professionalId} https://api.propelus.com /v2/professionals (list all enrolled)	Monitoring / Get / Patch / Delete Professional
Manage license(s) GET PATCH DELETE Retrieve, update, or delete a professional's credentials.	https://api.propelus.com /v1/professionals/ {professionalId}/ licenses/{licenseId}	https://api.propelus.com /v2/professionals/ {professionalId}/ credentials/{credentialId} https://api.propelus.com /v2/professionals /{professionalId} /credentials (list all monitored credentials)	Monitoring / Get Professional Credentials
Manage products GET DELETE List or remove a professional's enrolled monitoring products.	https://api.propelus.com /v1/professionals/ {professionalId}/ monitoring	https://api.propelus.com /v2/monitoring?professionalId={professionalId} https://api.propelus.com /v2/monitoring/ {monitoringId} (delete by ID)	Monitoring / List & Delete Enrolled Products

Webhooks

Webhooks move from the integrations.propelus.com host onto the unified v2 API base at api.propelus.com/v2.

Webhook registration starts with an activation handshake: Propelus sends a 6-character code to your endpoint. Submit that code to the Activate operation to take the webhook live.

Operation	APIv1 endpoint	APIv2 endpoint	Developer Documentation
Create POST Register an endpoint; triggers the activation handshake and returns a 6-character code to your webhook URL.	https://integrations.propelus.com /v1/webhooks	https://api.propelus.com /v2/webhooks	Webhooks / Create Webhook
Activate POST Confirm ownership by submitting the 6-character verification code.	https://integrations.propelus.com /v1/webhooks/{webhookId} /activate/{activationCode}	https://api.propelus.com /v2/webhooks/{webhookId} /activate	Webhooks / Activate Webhook
List GET Retrieve registered webhooks.	https://integrations.propelus.com /v1/webhooks	https://api.propelus.com /v2/webhooks	Webhooks / Get Webhooks
Update PATCH Modify a webhook, or retry a failed activation handshake.	https://integrations.propelus.com /v1/webhooks/{webhookId}	https://api.propelus.com /v2/webhooks /{webhookId}	Webhooks / Update Webhook
Remove DELETE Soft-delete a webhook (record retained 48h).	https://integrations.propelus.com /v1/webhooks/{webhookId}	https://api.propelus.com /v2/webhooks/ {webhookId}	Webhooks / Delete Webhook