Skip to main content
GET
Batch Progress and Results
Use the jobId or Location returned by batch enrollment. Authenticate with the company key used for submission. Another company’s job returns 404. 202 acceptance does not mean processing is complete. While a job is running, results contains only finished origination rows, ordered by the submitted zero-based index. A completed job can include failures; inspect failed, failures, and the per-row result before declaring the list successful. For the existing customer-create batch workflow, results is empty; use failures and the job counts. See retry rules before resubmitting an origination row.

Authorizations

X-API-Key
string
header
required

Path Parameters

jobId
string<uuid>
required

Job ID returned by POST /customers/batch

Response

Batch job status

jobId
string<uuid>
status
enum<string>

completed still allows individual row failures — check failures. failed means the job hit a fatal error.

Available options:
pending,
processing,
completed,
failed,
cancelled
totalCustomers
integer

Customers submitted in the batch

processed
integer

Customers successfully processed

failed
integer

Customers that failed

progressPercentage
number<float>
createdAt
string<date-time>
processingStartedAt
string<date-time> | null
processingCompletedAt
string<date-time> | null
errorMessage
string | null

Job-level error. Null unless status is failed.

failures
object[]

Every row that could not be created, sorted by submitted index and never truncated. Partial while status is processing; final once status is completed or failed. Empty for jobs that ran before August 2026.

results
OriginationBatchResult · object[]

Origination row outcomes in original zero-based index order. Partial until terminal; empty for legacy customer-create batches.