🚮Return All Failed Statements
Return all the failed PDF files and reasons for a Bank Account Record.
Last updated
Was this helpful?
Return all the failed PDF files and reasons for a Bank Account Record.
Last updated
Was this helpful?
This API call is useful if a manual review process is required within the application journey.
Example: A Customer uploads a Proof of Income document within their application process, instead of a valid PDF Bank Statement, an agent will be able to view the failed document submitted, contact the Customer and support the Customer with the collection of the correct documents.
We have seen in the past that Customers don't always upload the expected bank statement. They possibly upload a statement from a different bank (i.e. they say they're uploading an FNB statement and proceed to upload a Capitec statement), or they upload a scan of their bank statement rather than the original bank statement downloaded directly from their Banking Profile, or perhaps even a random PDF document, such as a payslip or tax invoice.
When the Customers attempts to upload the above scenarios through Upload Bankstatement V1.0 or Upload Bankstatement V1.1, the upload will fail due to the variety of upfront document validations our service performs.
We have catered for a failed PDF document retrieval process where failed files are stored within the Return All Failed Statements of a BankAccount endpoint.
See below in the flow diagram how the service works.
We have a purging policy of 7 days for all failed PDF files. After the 7 days, the failed PDF files will be deleted and unavailable for collection.
In addition to the document purging policy, the "temp_url" is valid for 60 minutes after the endpoint is called to action.
duplicate_statement
Duplicate statement. Please upload a different statement from the last 3 months.
The Customer uploads the same statement that they have already uploaded to the BankAccount. E.g. They upload their January bank statement twice. The statement could be valid or invalid. We will throw the duplicate_statement error if the same file is uploaded to the same BankAccount twice.
invalid_bank
Could not be recognised as a valid capitec statement. Please check if it is a valid bank statement, and that your bank selection is correct
The Customer uploads a valid PDF Bank Statement for a bank other than the bank that the BankAccount was created for. E.g. The BankAccount created was for Capitec, but the Customer uploaded an FNB statement.
invalid_layout
Invalid bank statement - layout
The Customer uploads a completely arbitrary PDF document that cannot be identified as a Bank Statement for any bank. E.g. The Customer uploads a PDF of their Municipal Bill.
invalid_period
The provided statement is too old. Please upload a statement from the last 3 months.
The Customer uploads a Bank Statement that is too old.
invalid_scanned
The bank statement provided is not in an accepted file format format. Please upload a PDF bank statement generated from your banking profile
The Customer Uploads a scan of their Bank Statement instead of the original that has been downloaded from their Online Banking.
*unknown_error
Most documents will fail one of the validations before reaching this point. However, there are rare occasions where you might see this error. In general it is an uncaught error and you will have seen a 500 Internal Server Error on the Upload response. *We cannot guarantee that the file will be returned for ALL instances of this error.
GET {{baseUrl}}/bank-accounts/:bank_account_id/failed-statementsbank_account_id*
String
The UUID for a Bank Account that gets generated and returned in the POST Create new Bank Account response.
If you wanted to view or download the Bank Statements from successful uploads, you would follow the normal process of calling the Return All Statements of a BankAccount endpoint.
