Sign in
Extraction

Extract File

Upload and process a PDF or Excel bank statement for extraction.

Provide either file (binary upload) or file_url.

Args: file: The PDF or Excel file to extract data from file_url: URL pointing to a supported file (alternative to file upload) password: Optional password for encrypted PDFs

post/api/v1/extract

Response

Successful Response

successboolean required

Whether the request was successful

messagestring required

Human-readable message

request_idstring

Unique identifier for the request

job_idstring required

Unique identifier for the extraction job

status'uploaded' | 'queued' | 'processing' | 'completed' | 'failed' | 'signin_required' | 'expired' required

Standardized status codes for the API

deduplicatedboolean

True if this response refers to an existing in-flight job for identical content

Changes

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