Skip to main content

Get Credentials Batch by ID - APIv2

Updated

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: GET api.propelus.com/v2/credentials/{batchId}

Source: https://propelus.com/developer/on-demand/getCredentialsBatch

 

Authorization (header)

Uses apiKey + clientId:

  • x-api-key: <token>
  • x-client-id: <token>

Path Parameters

  • batchId (required) — string, format uuid. Identifier for the batch to be retrieved.

Example Request Types

JSON

fetch("https://api.propelus.com/v2/credentials/628fc8e2-ee7e-4779-9eb7-d980e7a92f3a", {
  method: "GET",
  headers: {
    "x-api-key": [your apiKey]",
    "x-client-id": [your clientId]"
  }
})
 
cURL
curl -X GET "https://api.propelus.com/v2/credentials/628fc8e2-ee7e-4779-9eb7-d980e7a92f3a" \
  -H "x-api-key: [your apiKey]" \
  -H "x-client-id: [your clientId]"

 

Response Body — 200 (application/json)

{
  "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

The 400, 401, 403, 404, and 4XX responses all share the same shape:

{
  "status": 400,
  "code": "missing_fields",
  "detail": "string",
  "errors": [
    {
      "detail": "string",
      "pointer": "string",
      "parameter": "string",
      "header": "string",
      "code": "string"
    }
  ]
}

429:

{
  "status": 429,
  "detail": "string",
  "code": "f5d62b05-370e-48be-a755-8675ca146431"
}

5XX:

{
  "status": 500,
  "detail": "string",
  "code": "unexpected_error"
}

For additional detailed information such as TypeScript definitions and request body structure, see the Propelus API developer's documentation page on this topic.

 

Related v2 Endpoint

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.

Related articles