search

Batch Inquiries

hashtag
Submitting Batch Inquiries

If you need to submit multiple inquiries at once, you should use the Batch Inquiries endpoint. This endpoint allows you to submit an array of inquiry objects in a single request, making it more efficient than submitting inquiries individually.

hashtag
How Batch Inquiries Work

  1. Submit a Batch Request Send a POST request to /v1/batch-inquiries/ containing an array of inquiry objects.

  2. Receive a Batch ID Upon successful submission, the response will show the batchId. Store this id for future reference.

  3. Check Batch Status Poll GET /v1/batch-inquiries/{batchId} until status shows COMPLETE or PARTIAL_SUCCESS.

  4. Retrieve Inquiry IDs Once the batch status is marked as complete, retrieve and store the Inquiry IDs through the GET /v1/batch-inquiries/{batchId}/inquiries call. This call will return an array of objects related to each submitted inquiry and their status. Due to the potential payload size, it is recommended to use a limit and offset on this endpoint. Example GET /v1/batch-inquiries/{batchId}/inquiries?limit=100&offset=0

  5. Retrieve Business Reports Using the Inquiry IDs retrieved in Step 4, users will be able to pull down the corresponding Business Report using the GET /v1/inquiries/{inquiry_id} call.

hashtag
Batch Status

Each batch has two levels of status codes:

  1. Batch-level status – Indicates the overall state of the entire batch.

  2. Inquiry-level status – Indicates the status of each individual inquiry within the batch. See the Inquiry Status Codes section for details.

hashtag
Batch Status Categories

Batch statuses fall into three groups:

Processing Statuses

These indicate that the batch is still being processed.

  • PENDING – The batch has been received but processing has not started yet.

  • RUNNING – The batch is currently being processed.

Completed Statuses

These indicate that processing has finished.

  • COMPLETED – All inquiries in the batch were processed successfully.

  • PARTIAL_SUCCESS – Processing has finished, but one or more inquiries in the batch failed.

Failure Statuses

These indicate that the batch did not complete successfully.

  • FAILED – The entire batch failed during processing.

  • CANCELLED – The batch was aborted before completion.

PreviousInquiry Status CodesNextLicense Verification

Last updated