ApexVerify ApiBatch

Batch Result Export

View as Markdown
Export batch results in XLSX format, consistent with the frontend output, or as a JSON dump including data and result content, with optional additional sections such as statistics and details.

Authentication

X-API-Keystring
API Key authentication via header

Path parameters

batch_uuidstringRequiredformat: "uuid"

Query parameters

formatenumRequired
Allowed values:
include_detailsbooleanOptionalDefaults to true
include_statisticsbooleanOptionalDefaults to true

Response

Batch export as JSON or XLSX
BatchVerificationResultsEmailSerialobject
OR
BatchVerificationResultsPhoneSerialobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error