/api/v1/underwrite/batch/{id}
- Scope
underwrite:writecases:read- Rate limit
- 200 requests / min
- Idempotency
- read-only
Authentication
Send your key as Authorization: Bearer …. It must carry the scopes underwrite:write, cases:read; a key without it receives 403 forbidden.
Path parameters
idstringrequiredRequest body
This operation takes no request body.
Response
200application/jsonSerializedBatchbatch_idstringrequiredstatusstringrequiredpending until every item has terminated, then completed. There is no intermediate value.
totalnumberrequiredItems submitted. Immutable: a batch never grows.
succeedednumberrequiredTerminated successfully.
failednumberrequiredTerminated in failure — at creation, or after the analysis gave up.
pendingnumberrequiredStill outstanding. total - succeeded - failed.
created_atstring | nullrequirednullablecompleted_atstring | nullrequirednullableNull until the batch completes; set once, by the fence that emits the event.
applicationsSerializedBatchItem[]requiredPER-ITEM OUTCOMES, not just a count. A batch that reported only totals
could say "12 submitted, 3 failed" and leave a partner to diff their own
request against GET /v1/cases to discover WHICH three — which defeats the
purpose of handing back a batch id instead of 50 case ids.
Errors
The statuses this operation can return, with the error.code values behind each. Every error body is the shared envelope described under Errors in Getting started.
401unauthorized403forbidden404not_found429rate_limit_exceeded500internal_error