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 responses as they are ready rather than polling.
Note: results expire after 7 days.
Endpoint:
HTTP Method: GET
Path: /v2/credentials/{batchId}
Server URL: https://api.propelus.com
Developer Docs: https://propelus.com/developer/on-demand/getCredentialsBatch
Authentication
Two header-based authentication methods are required:
| Header | Type | In | Description |
| x-api-key | token | header | API key credential |
| x-client-id | token | header | Client identifier credential |
Path Parameters
| Parameter | Type | Required | Description |
| batchId | string (UUID) | Yes |
Identifier for the batch to be retrieved. |
Example Request — JSON
fetch("https://api.propelus.com/v2/credentials/628fc8e2-ee7e-4779-9eb7-d980e7a92f3a", {
method: "GET",
headers: {
"x-api-key": "<your-api-key>",
"x-client-id": "<your-client-id>"
}
})Example Request — cURL
curl -X GET "https://api.propelus.com/v2/credentials/628fc8e2-ee7e-4779-9eb7-d980e7a92f3a" \
-H "x-api-key: <your-api-key>" \
-H "x-client-id: <your-client-id>"Responses
200 — Success
Returns the batch's status and, per credential, the input echo and primary-source verification result. code is processing until the batch completes.
{
"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"
}
}Error Responses
Standardized error bodies. Validation-style errors include an errors array; each item contains detail, pointer, parameter, header, and code: https://propelus.com/developer/on-demand/getCredentialsBatch#response-body
400 — Bad Request
401 — Unauthorized
403 — Forbidden
404 — Not Found
4XX — Client Error
5XX — Server Error