bankstract
Api

Poll a parse job

JSON snapshot of a job, the polling fallback to SSE. result appears once state is done; the error fields once failed.

GET
/v1/parse/jobs/{job_id}

Path Parameters

job_id*Job Id

Header Parameters

authorization?string|null

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/parse/jobs/string"
{  "job_id": "string",  "state": "queued",  "result_kind": "json",  "progress": {    "stage": "string",    "current": 0,    "total": 0  },  "result": {    "format_version": "string",    "metadata": {      "bank": "string",      "account_holder": "string",      "account_number_masked": "string",      "statement_period_start": "2019-08-24T14:15:22Z",      "statement_period_end": "2019-08-24T14:15:22Z",      "opening_balance": "string",      "closing_balance": "string"    },    "totals": {      "credit": "string",      "debit": "string"    },    "row_wise_reconcilable": true,    "transactions": [      {        "date": "2019-08-24T14:15:22Z",        "narration": "string",        "debit": "string",        "credit": "string",        "balance": "string",        "reference": "string",        "currency": "string"      }    ]  },  "result_url": "string",  "format_version": "string",  "redactions": 0,  "error": "string",  "error_class": "string"}
{  "error": "string",  "error_class": "string",  "format_version": "string",  "marker_coverage": 0}
{  "error": "string",  "error_class": "string",  "format_version": "string",  "marker_coverage": 0}
{  "detail": [    {      "loc": [        "string"      ],      "msg": "string",      "type": "string",      "input": null,      "ctx": {}    }  ]}

Stream parse progress (SSE) GET

Server-Sent Events for a job: data lines carry {stage,current,total} progress, then a final `event: result` carries the ParseResponse (success) or the error envelope. No Authorization header: the unguessable job_id is the capability, since EventSource cannot send headers. One consumer per job.

Download a finished job's result GET

The byte channel for csv/redact jobs (the SSE result event carries JSON only). Returns the ParseResponse JSON for a json job, or the CSV / redacted bytes for csv / redact. 404 until the job is done, or after its result is swept.