Get a Bank Statement set

GET 
/api/v8/partner/bank-statements-set/:document_id

Retrieve a Bank Statement set.

Request

Path Parameters

document_id int64required

The unique identifier of the document.

Responses

200

Returns a Bank Statement set.

application/json

Schema

Schema

id integerrequired

The unique identifier of the collections of processed documents.

document_ids integer[]

The unique identifiers of the documents created from processed PDF Splitter.

status stringrequired

Possible values: [processed, in_progress, deleted, failed]

page_breaks object[]
A list of page breaks to split a document. Each object defines what pages to use to create a new document.
Array [
page_start integerrequired
Possible values: > 0
Page start
page_end integerrequired
Possible values: > 0
]

Example (from schema)

{
  "id": 0,
  "status": "processed",
  "page_breaks": [
    {
      "page_start": 0,
      "page_end": 0
    }
  ]
}

Loading...