GET
/v1/definitions/{key}/rows/{rowId}/processingRead a record's document-processing status
The newest processing job on one record, with its event feed in order and the documents it covered, in one query. A record nobody has processed answers a ZERO job with an empty status rather than a 404, so 'not processed' and 'bad id' stay distinguishable. What a job actually extracted is read per tab: bank-statements, tax-returns, credit-reports, or financials for the rollup.
Access class: def:read.
Send request
Use the documented inputs to call this endpoint directly.
API serverbase URL
Bearer tokensessionoptional
Stored only in this browser for the session security scheme and reused on every API page in this group.
Parameters
Values are applied to the request and the example on the right.
keypath · stringrequired
rowIdpath · stringrequired
bodyquery · nulloptional
paramsquery · objectoptional
:keystringoptional
:rowIdstringoptional
queryquery · objectoptional
Responses
200application/json
the action's answer
{
"data": {
"documents": [
{
"at": "string",
"attemptNo": 1.5,
"contentSha256": "string",
"documentType": "string",
"extractions": [
"string"
],
"fileId": "",
"fileName": "string",
"id": "",
"outcome": "string",
"reason": "string"
}
],
"events": [
"string"
],
"externalJobId": "",
"findings": [
"string"
],
"finished": true,
"id": "",
"idempotencyKey": "string",
"requestedAt": "string",
"requestedBy": "string",
"status": "string"
}
}datarequired
defaultapplication/json
a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}errorstringrequired