Skip to content
VEC Digital API

Get batch status

GET
/business/batches/{batchId}/status

Returns the current status and progress information of a specific batch.

Authorizations

Parameters

Path Parameters

batchId
required
string format: uuid

UUID of the batch to check status

Responses

200

Successful operation

object
status

Current status of the batch

string
Allowed values: pending processing completed partially_completed failed waiting_for_approval
total_certificates

Total number of certificates in the batch

integer
processed_certificates

Number of successfully processed certificates

integer
failed_certificates

Number of failed certificates

integer
progress

Progress percentage (0-100)

number format: float

401

Authentication failed

object
message

Error message

string
Unauthorized - Invalid API token

403

Permission denied

object
message

Error message

string
Forbidden - Insufficient permissions
required_permission

Required permission to access this resource

string
batches:view

404

Resource not found

object
message

Error message

string
The requested ID 9d3a6b04-c4e5-485f-b945-8f1fd66396ce was not found.
error

Error code

string
resource_not_found

500

Server error

object
message

Error message

string
An unexpected error occurred. Our team has been notified.
error_code

Error code

string
SERVER_ERROR