Get Credentials Batch by ID
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.
Authorization
apiKey clientId In: header
In: header
Path Parameters
Identifier for the Batch to be retrieved.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v2/credentials/628fc8e2-ee7e-4779-9eb7-d980e7a92f3a"{
"code": "processing",
"detail": "string",
"credentials": [
{
"status": 0,
"detail": "string",
"code": "string",
"input": {
"credential": {
"number": "string",
"code": "RN",
"state": "CA",
"certState": "CA"
},
"name": {
"prefix": "Dr.",
"first": "string",
"middle": "string",
"last": "string",
"suffix": "string"
},
"dob": "19770428",
"ssn": "000482915",
"zipCode": "string",
"customProperties": {
"property1": "string",
"property2": "string"
}
},
"verification": {
"isFound": true,
"lastName": "HOLLOWAY",
"firstName": "TOBIAS",
"middleName": "R",
"customFields": {
"boardName": "FLORIDA API TESTING BOARD",
"COMPACT_STATUS": "SINGLE STATE",
"property1": "string",
"property2": "string"
},
"credentialNumber": "908398",
"credentialStatus": "INACTIVE",
"screenshotURL": "http://example.com",
"expirationDate": "2024-05-18T00:00:00.000Z",
"originalIssueDate": "2002-04-01T00:00:00.000Z",
"disciplinaryAction": false,
"useScreenshotTemplate": true
}
}
],
"metadata": {
"property1": "string",
"property2": "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": 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"
}Verify Credentials Batch POST
Perform one-time verification checks on healthcare licenses, certifications, and registrations. Looking to enroll a credential in ongoing monitoring? See [here](/monitoring/CreateProfessionalMonitoring). Review the request and response bodies below to perform primary source verifications. An important note, submitted profession codes must match those in the Propelus system. To view those codes, utilize the [Get Profession Status](/professions/getProfessions) endpoint.
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.