👽Verify Online Banking Account

Verify an Online Banking Account by retrieving transactional data and PDF bank statements from the Customer's internet banking profile.

Verify Online Banking Account

GET {{baseUrl}}/bank-accounts/:bank_account_id/verify-online

Path Parameters

Name	Type	Description
bank_account_id*	String	The UUID for a Bank Account that gets generated and returned in the POST Create new Bank Account response. It ensures that the transactional data and statements retrieved in the online login session are saved to the correct Bank Account.

Query Parameters

Key	Type	Description
allow_redirect	Booelan	Set allow_redirect to "true" if you would like to redirect the end-user/customer after they have completed the online process. By default, it is null and therefore the redirect_url will not work unless allow_redirect = true.
result_url	String	Add a value for this parameter to send the outcome of the online login session. i.e. the URL to which you would like to receive the results of the online login session (successful, failed, in progress). You can save the value in the environment variable {{resultUrl}}.
redirect_url	String	Add a value for this parameter to dictate where the end-user/customer is redirected to after they have successfully completed the online process. i.e. the URL of the page to which you want the end-user/customer to return/progress to once their transaction data and bank statements have been collected. You can save the value in the environment variable {{redirectUrl}}.

Status Codes

201 - Created

Online Verification Session Created

{
    "data": {
        "uuid": "{{$randomUUID}}",
        "state": "Session started",
        "session_code": "QFJgX",
        "portalUrl": "https://uat.apply.fincheck.co.za/gathr-docs/banking-portal/QFJgX",
        "accounts_loading": 90,
        "statements_loading": 90,
        "login_loading": 90,
        "has_pin": 1,
        "has_otp": 0
    }
}

404 - Not Found

Bank Account ID Not Found

{
    "errors": {
        "code": "entity_not_found",
        "message": "Record not found in module_bank_accounts"
    }
}

422 - Unprocessable Content

Invalid bank account type

{
    "errors": [
        "This is not an online bank account. Please create an online bank account and try again."
    ]
}

Webhook Requirements | result_url

The webhook gets triggered once transaction and statement(s) has successfully been collected. Once you receive the relevant successful payloads, you can query the relevant/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 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