Upload Statement (Extraction)
Upload Bank statement for analysis and credit scoring
Upload Bank Statements
POST {{BASE_URL}}/api/v1/statements/bank/upload
Upload Bank Statements
POST {{BASE_URL}}/api/v1/statement/mfi/bank/upload
This endpoint allows you to upload Mpesa Statements for extraction, analysis and scoring
Headers
Authentication*
string
Authentication token to track down API usage.
Request Body
national_id*
String
User's national ID
file*
String
Base64 encoded file string
file_name*
String
Renamed filename using user national id i.e 34213456.pdf
callback_url*
String
Where to send result
bank*
String
Statement bank (Lowercase: im, equity, sbm, kcb, absa, e.tc)
{
"status": 202,
"message": "Statement saved successfully. Extraction process initiated",
"data": {
"national_id": "27365875",
"bank": "absa",
"reference_id": "bdcb2d95-ad53-4245-8af7-f745ae7d4f33",
"file_name": "27365875.pdf"
}
}{
"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"
]
}Headers
Authentication*
string
pGe5OOCXWF6d
Request Body
national_id*
String
dsEDAfQH7wlF
file*
String
O7C1GA73NJrf
file_name*
String
qHofrA4edNAh
callback_url*
String
rfqVK2v27It3
bank*
String
GJOGo07mqhA3
Statement upload request Example
Statement Callback Response Example
Last updated
Was this helpful?