Upload Bank statement for analysis and credit scoring
Upload Bank Statements
POST{{BASE_URL}}/api/v1/bank/statements
This endpoint allows you to upload Bank Statements for extraction, analysis and scoring
Headers
Name
Type
Description
Authentication*
string
Authentication token to track down API usage.
Request Body
Name
Type
Description
national_id*
String
User's national ID
file*
String
Base64 encoded file string
file_name*
String
Name of the file
callback_url*
String
Where to send result
bank*
String
Statement bank (Lowercase: im, equity, sbm, kcb, absa, e.tc)
passcode
String
Passcode for encrypted files
{"status": 202,"message": "Statement saved successfully. Extraction process initiated","data": {"reference_id":"bdcb2d95-ad53-4245-8af7-f745ae7d4f33",}}
{"status": 400,"message": "Validation failed for one or more arguments","errors": ["nationalId: must not be null","file: Base64 encoded file is required","file: must not be null","nationalId: National Id is required" ]}