Documents

Unlock a password-protected document

Submit a password to unlock and process a password-protected PDF. The document must have status password_required. On success, the document transitions to processing status. Rate limit: 20 requests per minute.

post/documents/{id}/unlock

Request

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

Path parameters

idstring uuid required

The document UUID returned from the upload endpoint.

Request body

passwordstring required

The password to unlock the PDF. Used in memory only for decryption and never stored.

Response

Password accepted. Document is now processing.

idstring uuid required

Unique document identifier. Use this to poll status and request exports.

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.

Changes

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