🔍Bank Identification Service
Using OCR technology we are able to identify the bank and statement template leading to enable bank statement parsing.
The Bank Identification Service enables the asynchronous process of creating thebank_account_id
validating the document, processing and storing of transactions. This means we handle the Create new Bank Account
api call.
Upload Bankstatement for Customer V1.1
POST
{{environmentUrl}}/{{tenantId}}/api/v1.1/customers/{{customerId}}/upload-bankstatement
There is a maximum of 6 bank statements that can be uploaded in one API call.
Request Body
Key | Value | Description |
---|---|---|
statements[]* | form-data | Select the file/s you would like to upload. The file/files needs to be a valid bank PDF statement that the customer has downloaded from their internet banking. See here for more information on the types of statements that can be uploaded. There is a maximum of 6 bank statements that can be uploaded in one API call. |
statement_result_url* | String | Add a value for this parameter to send the outcome of the statement processing. i.e. the URL to which you would like to receive the results of the successful, transaction processing. You can save the value in the environment variable {{StatementResultURL}}. |
category_engine | String | To enable refined transaction categorisation you will need to set the
|
Webhook Requirements | statement_result_url
statement_result_url
The webhook gets triggered once the processing of the transactions in the statement(s) is successful. Once you receive this successful payload, you can query any of the /transactions
, /statements
, /accounts
and /transaction-reports
endpoints to retrieve the affordability data you require.
As this is a specific post query, we need to make sure we are sending customer/clients to a safe destination, as such, there is validation done on the Redirect and Statement Result URL.
The Filed under validation must have a valid A or AAAA record when querying the dns_get_record PHP function.
A a simple guideline:
Must be RFC compliant
Must include the hostname
Be careful with special characters that might mess with the structure of the post request
Statement Upload V1.1 – Statement Success
Statement Upload V1.1 – Statement Failure
Last updated