This article outlines best practices for successful API testing with Propelus, emphasizing authentication via Client ID and API keys in headers. It details asynchronous on-demand credential verification, including required fields, batch processing, and expected results like credential status and screenshots. The AdverseCheck process is synchronous, using identity matching to report adverse events with inputs like name and NPI, returning identity details and sources of adverse actions. Review the Developer Documentation for more info.
💡Don’t forget to review the Developer Documentation.
Authentication
- Client ID + API keys are placed in the request headers
On-Demand Credential Verification
Asynchronous process
- Verifications should complete in <10 minutes.
- Send a GET request to pull credential verification results or enroll in webhook events.
- Batch up to 100 credentials.
- Requirements for successful verifications include:
- credential number.
- profession code.
- state indicator (CERT for national certifications).
- conditionally required: name (first and last), date of birth. Items requiring these fields can be found via our integrations endpoint (link above: "Developer Documentation").
- not required: customProperties. Can be sent, and will be echoed back in the response by Propelus, but will not be used for verification purposes.
- Results of a successful verification include:
- Name on the credential
- Status
- Expiration date
- Credential number
- Profession code
- State
- Primary source screenshot
- Returned as a URL.
- Download the image at the URL for your records. Propelus removes after 7 days.
- Disciplinary (Y/N) [if available at the primary source].
- Issue date [if available at the primary source].
- Screenshot token - includes timestamp of the primary source verification.
- customFields
- Only available via certain boards/professions.
- Examples: compactStatus or speciality.
- Test professions are available for preliminary tests, but valid credentials should be tested.
- Primary sources are checked at the time verification is requested. Propelus license information is real-time from the primary source.
AdverseCheck (Pro+ Essentials)
- Synchronous process (results returned immediately).
- Propelus uses identity matching to assign adverse action events to professional records in our database.
- Inputs:
- Name (required)
- NPI (preferred)
- State license (preferred)
- Outputs:
- Identity details including state, NPI, or any other associated elements
- Source of the adverse action (OIG, SAM, OFAC, etc)
- You may receive multiple identities with adverse events.
Where to go next