Submit a bank statement PDF

POST

Upload a PDF file for the main extraction workflow. Once the bank statement has finished processing, you can retrieve the results using /v3/bank_statements/{id}/results.

Complete guide: Bank Statements

Request

This endpoint expects a multipart form containing a file.

filefileRequired

Response

Successful Response

idstring

A unique identifier for the bank statement job.

statusenum

Allowed values: processingcompletederror

The current status of the document.

created_atdatetime

The date and time when the job was created.

fileobject

Information about the bank statement file being processed.

namestringOptional

The name of the bank statement file, if available.

errorobjectOptional

Built with

1	curl -X POST https://api.ntropy.com/v3/bank_statements \
2	-H "X-Api-Key: <apiKey>" \
3	-H "Content-Type: multipart/form-data" \
4	-F file=@<filename1>

1	{
2	"id": "string",
3	"status": "processing",
4	"created_at": "2023-01-01T00:00:00Z",
5	"file": {
6	"no_pages": 0,
7	"size": 0
8	},
9	"name": "string",
10	"error": {
11	"code": "invalid_bank_statement",
12	"message": "string"
13	}
14	}