📄Upload Business Bank Statement

Automatically validate, extract and verify transactional data from a valid PDF Business bank statement.

Upload Business Bank Statement

POST {{baseUrl}}/business/bank-accounts/:bank_account_id/upload-bankstatement

Upload one or many valid PDF bank statements to a bank_account_id. The business bank statements will need to be uploaded one-by-one in sequential calls.

Path Parameters

Name

Type

Description

bank_account_id*

String

The UUID for a Business Bank Account that gets generated and returned in either POST Create without Customer or POST Create with Customer response.

It ensures that the transactional data is associated to the correct Bank Account Record.

Headers

Name

Type

Description

Content-Type*

multipart/form-data

Request Body

Name

Type

Description

statement*

form-data

Select the file you would like to upload. This needs to be a valid business 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.


```postman_json
{
    "data": {
        "id": "{{businessId}}",
        "bank_account_id": "{{bankAccountId}}",
        "statement_date": "2023-05-11",
        "start_date": "2023-04-12",
        "end_date": "2023-05-11",
        "temp_url": "https://fincheck-onboarding.s3.eu-west-1.amazonaws.com/uat/client_ecc22a4c-ae24-46d2-83df-3c5f90dbc753/bank_accounts/default_customer/adcfc44d-9e0a-4f0b-9549-e3b4429b2834/bank_account/781f967d-9b38-4741-bfd4-5bb44642a046.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQOIKJL7BXFF7LDWP%2F20230608%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20230608T074449Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=60a6ccaaccaf8bd4870e1963c0b12b7da1f11d7b642d7993b8279dd04b5983a3",
        "expires_in": "60m",
        "file": {
            "id": 565,
            "name": "781f967d-9b38-4741-bfd4-5bb44642a046.pdf",
            "type": "pdf",
            "url": "http://uat.apply.test.co.za/test/documents/781f967d-9b38-4741-bfd4-5bb44642a046.pdf"
        },
        "transaction_count": 74,
        "month": "Apr 2023",
        "fraud": {
            "fraud_checks": {
                "statement_balance": false,
                "create_date": "not applicable",
                "meta_mod_date": "not applicable",
                "meta_producer": false,
                "meta_creator": false,
                "meta_author": false
            }
        },
        "processed": true
    }
}
```

[
    {
        "code": "invalid_period",
        "message": "There was an error validating the statement",
        "data": {
            "error": "{\"message\":\"The provided statement is too old. Please upload a statement from the last 3 months.\",\"statement_date\":\"Sep 2022\"}"
        }
    }
]

[
    {
        "code": "invalid_bank",
        "message": "There was an error validating the statement",
        "data": {
            "error": "Could not be recognised as a valid FNB statement. Please check if it is a valid bank statement, and that your bank selection is correct."
        }
    }
]

```postman_json
[
    {
        "code": "duplicate_statement",
        "message": "There was an error validating the statement",
        "data": {
            "error": "{\"message\":\"Duplicate statement. Please upload a different statement from the last 3 months.\",\"statement_date\":\"Apr 2023\"}"
        }
    }
]
```

Last updated 11 months ago

Was this helpful?

hashtagUpload Business Bank Statement

hashtagPath Parameters

hashtagHeaders

hashtagRequest Body