Create a statement

Create a new statement by uploading an official PDF bank statement or CSV file. The server will create a job that processes the following steps:

  1. verify-credentials: Verify the file, validate the layout, and attempt to parse the statement.
  2. retrieve-accounts: Retrieve the list of accounts and their details (account number, name, balances).
  3. retrieve-transactions: Fetch the transactions for each account.

The status of each step can be checked by querying the Retrieve a job.

Note that this function is not supported in sandbox environments (AU00000).

For CSV file format specifications, please contact our support team.

đźš§

Note that the time it takes to complete the processes above will vary depending on the volume of data along with the complexity of the bank statement. As a rough guide this entire process could take anywhere between 10 - 30 secs. Upload multiple statements in parallel to provide the best user experience

Path Params
string
required

The unique identifier of the user

Body Params
string
required

The identifier of the institution to which the statement relates (e.g., "AU01001"). Note: Sandbox institutions (AU00000) do not support file uploads.

file
required

The official PDF bank statement or CSV file to be uploaded. CSV files must conform to the file specification provided by Basiq.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json