Documents

Get document processing status

Poll the status of an uploaded document. When status is completed, the response includes statement metadata and export URLs. Rate limit: 120 requests per minute.

get/documents/{id}

Request

  • Base URL: https://api.bankstatemently.com/v1
  • URL: https://api.bankstatemently.com/v1/documents/{id}
  • Auth: API key in header X-API-Key

Path parameters

idstring uuid required

The document UUID returned from the upload endpoint.

Response

Document status and metadata.

idstring uuid required

Unique document identifier.

status'processing' | 'completed' | 'failed' | 'password_required' required

The processing status of a document.

contentHashstring required

Content-addressable hash of the uploaded file.

createdAtstring date-time required

Timestamp when the document was created.

updatedAtstring date-time required

Timestamp of the last status update.

errorstring

Human-readable error message. Present only when status is failed.

Changes

No recorded changes to this operation across all 1 revision of this API.