Create a statement

A user can choose to share their financial data by uploading official pdf bank statements instead of creating a bank connection. Once the statement object is successfully created you can use it to obtain the user's latest financial data extracted from the bank statement i.e. accounts and transactions.

👍
The endpoint also accepts csv files conforming to our file specification. Contact us directly for more details.

Create a new statement by uploading an official pdf bank statement or csv file statement. When a new statement request is made, the server will create a job that will process the following steps:

	Step	Description
1	verify-credentials	The server will verify the file, validate the statement layout and attempt to parse the target statement

2	retrieve-accounts	The server will retrieve the complete list of accounts and their details e.g. account number, name and balances

3	retrieve-transactions	The server will fetch the associated transactions for each of the accounts

You can check the status of each step by querying the job resource (returned when the statement is created).

Arguments
statement file, required	Official PDF bank statement for the specified institution to be uploaded. Csv files conforming to our file specification are also accepted.

institutionId string, required	The identifier of the institution to which the statement relates e.g. "AU01001". Note that sandbox institutions (i.e. AU00000 do not support the file upload option.

🚧
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

Returns

Returns a created job resource, if the operation succeeded. Returns an error if the post failed (e.g. not supplying required properties).

POST /users/{user.id}/statements

POST /users/ea3a81/statements HTTP/1.1
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: multipart/form-data; boundary=----xxxxxxxx

Content-Disposition: form-data; name="statement"; filename="/Users/DSmith/bankstatement_filename.pdf"

Content-Disposition: form-data; name="institutionId"
AU04301

Content-Disposition: form-data; name="Accept"

multipart/form-data
------xxxxxxxx--

HTTP/1.1 202 Accepted
Content-Type: application/json

{
  "type": "job",
  "id": "61723",
  "links": {
    "self": "https://au-api.basiq.io/jobs/61723"
  }
}