Response

This is the response you get after bank statement upload with the processing status as UPLOADED. All Statements uploaded go through multiple processing statuses see section after sample payload below. You can listen for an update in processing status via our webhook, see here: https://insights-periculum.readme.io/reference/insights-webhook

JSON

{
    "key": 5810,
    "uniqueCode": null,
    "name": "Moniepoint-Statement 8189522026.pdf",
    "source": "PDF",
    "clientFullName": null,
    "clientPhoneNumber": null,
    "accountType": null,
    "accountBalance": null,
    "accountId": null,
    "accountName": null,
    "bankName": null,
    "statementType": "CONSUMER",
    "uploadedBy": null,
    "startDate": null,
    "endDate": null,
    "createdDate": "2025-01-10T09:34:04.5707793Z",
    "processingStatus": "UPLOADED",
    "clientIdentification": [
        {
            "identifierName": "bvn",
            "identifierValue": null
        },
        {
            "identifierName": "nin",
            "identifierValue": null
        }
    ],
    "spendAnalysis": null,
    "transactionPatternAnalysis": null,
    "agentLocationAnalysis": null,
    "behavioralAnalysis": null,
    "cashFlowAnalysis": null,
    "incomeAnalysis": null,
    "confidenceOnParsing": null,
    "pdfCreatedDate": null,
    "pdfModifiedDate": null
}

Types Of Processing Status

Name	Description	Type
processingStatus	UPLOADED | PROCESSED | FAILED | PROCESSING | INSUFFIENT BALANCE | NO BALANCE | NO TRANSACTIONS | NOT ENOUGH TRANSACTIONS | ALTERED	string

NOTE: Variable definitions can be found here

Error Messages

json

{
    "message": "Please Upload a File"
}

JSON

{
    "message": "Kindly upload a PDF file"
}

JSON

{
    "message": "PDF is protected - Password required or incorrect password."
}

JSON

{
    "message": "The file page count of file: 1005 is greater than the allowed page count: 1000"
}

JSON

{
    "message": "Insufficient balance."
}

JSON

{
    "message": "A statement with the same name has already been analyzed. Please rename and upload this statement again."
}

js

{
    "message": "The file size is greater than 20MB."
}

JSON

{
    "message": "An error has occured please try again"
}

JSON

{
    "message": "Pdf Upload is not allowed"
}