Batch Status Types

When fetching a batch via the API you must check the "status" in order to know whether the batch has failed, is still in progress or is complete.

For example when calling our Get Batch endpoint: /v1/batches/{batchId}

The response contains a status field:

{
  "batchId": "c87e2a4a-5169-4726-b078-7e9538ae28cd",
  "userBatchRef": "customer_vehicle_registration_statuses-sep_2024",
  "createdDatetime": "2024-09-14T23:19:00Z",
  "requestedDatetime": "2024-09-16T23:19:00Z",
  "rowsInBatch": 1000,
  "rowsProcessed": 989,
  "validationErrors": 8,
  "processingErrors": 3,
  "batchService": "VEHICLE_ID_WOVR",
  "batchServiceName": "Vehicle ID WOVR Batch",
  "status": "COMPLETE"
}

The below table explains the different status, what they mean and what action you should take.

PRE_PROCESSING	Initial status assigned on upload, preparing batch file for processing.	In Progress	No action required, please wait until (pre)processing is complete.
VALIDATING	The uploaded batch file is being validated to ensure format is correct.	In Progress	No action required, please wait until (pre)processing is complete.
SCHEDULED	Batch file has completed validation and is now ready to be picked up in the next round of batch processing.	In Progress	No action required, please wait until (pre)processing is complete.
PROCESSING	Batch has kicked off, transactions are generated and downstream providers being called to fetch required data	In Progress	No action required, please wait until (pre)processing is complete.
COMPLETED	Batch has completed successfully (may or may not contain errors).	Finished	Resulting report file is ready for download! (and error file if there are errors)
EXPIRED	Batches expire after 30 days, this status is used to represent an expired batch.	Finished	Resubmit the batch. A batch must be retrieved within 30 days of creation.
CANCELLED	Status to represent that the batch was manually cancelled by the user.	Finished	Resubmit the batch. The batch was manually cancelled by you.
FAILED	Shows that a batch has failed with an unrecoverable error. Example: Bad request, incorrect CSV file, report failed to generated, etc.	Finished	Check CSV file and inputs, resubmit the batch.