/
Via PDF (Step 2: Analysis Result)

Via PDF (Step 2: Analysis Result)

Owned by Philip Awopetu (Unlicensed)
Last updated: Apr 08, 2025

Get PDF Analysis Status

 

Endpoint: https://api.indicina.co/api/v3/client/pdf/extract/{jobId}/status

Method: GET

Authentication: Bearer <Token>

Content Type: application/json

Note: {jobId} in the Endpoint

Use this endpoint to retrieve the status and results of a PDF statement analysis based on an existing Job ID. The Job ID is provided in the response when you submit a PDF for analysis.

Sample Request

To get the analysis status and results, simply make a GET request to the endpoint, replacing {jobId} with the actual Job ID you received during the PDF statement analysis process.

image-20250408-173822.png

Status Updates: PDF Analysis Progress

After submitting a PDF for extraction (Phase 1), you can use the Job ID to check the progress of the analysis using the endpoint mentioned earlier. Below are two possible status responses you might encounter:

1. Status: IN_PROGRESS

When the analysis is still ongoing, you will receive a response like the following:

{ "status": "success", "data": { "jobId": "80abdfbf-0ad4-4340-abf5-f2082f6f92f5", "status": "IN_PROGRESS", "scoreCardIds": [], "message": "" } }

 

  • The status field is marked as IN_PROGRESS, indicating that the PDF analysis is still processing. No results are available yet. The results will be available once the extraction process is completed.

 

2. Status: DONE

Once the analysis is complete, you will receive a DONE status along with detailed analysis results:

{ "status": "success", "data": { "jobId": "80abdfbf-0ad4-4340-abf5-f2082f6f92f5", "status": "DONE", "scoreCardIds": [], "message": "", "decideResponse": { "data": { "id": "3d19cf61-6be9-4e48-b263-304546200bda", "country": "Nigeria", "currency": "NGN", "breakdowns": [ { "name": "salary", "values": [ { "date": "2022-09", "amount": 419570.14 }, { "date": "2022-10", "amount": 480837.37 }, { "date": "2022-11", "amount": 629131.79 }, { "date": "2023-04", "amount": 505966.17 }, { "date": "2023-05", "amount": 496864.36 } ] }, { "name": "otherIncome", "values": [] }, { "name": "individualSalary", "values": [ { "date": "2022-09-23", "amount": 419570.14 }, { "date": "2022-10-21", "amount": 480837.37 }, { "date": "2022-11-24", "amount": 629131.79 }, { "date": "2023-04-20", "amount": 505966.17 }, { "date": "2023-05-24", "amount": 496864.36 } ] }, { "name": "loan", "values": [] }, { "name": "loanRepayment", "values": [] } ], "spendAnalysis": { "expenseChannels": [ { "key": "atmSpend", "value": 0 }, { "key": "webSpend", "value": 0 }, { "key": "posSpend", "value": 0 }, { "key": "ussdTransactions", "value": 20.94 }, { "key": "mobileSpend", "value": 0 }, { "key": "spendOnTransfers", "value": 272992.17 }, { "key": "internationalTransactionsSpend", "value": 0 } ], "expenseCategories": [ { "key": "bills", "value": 1000 }, { "key": "entertainment", "value": 0 }, { "key": "savingsAndInvestments", "value": 0 }, { "key": "gambling", "value": 0 }, { "key": "airtime", "value": 3750 }, { "key": "bankCharges", "value": 1017.53 }, { "key": "chequeWithdrawal", "value": 0 }, { "key": "cashWithdrawal", "value": 0 }, { "key": "shopping", "value": 0 }, { "key": "eatingOut", "value": 1610.75 } ], "hasRecurringExpense": "Yes", "averageMonthlyExpenses": 456378.36, "averageRecurringExpense": 171000 }, "accountDetails": { "isPdfMetaDateModified": true }, "incomeAnalysis": { "dsr": 0, "microSME": "No", "gigWorker": "No", "pensioner": "No", "medianIncome": 488850.87, "salaryEarner": "Yes", "averageSalary": 506473.97, "salaryRecency": 678, "averagePension": 0, "lastSalaryDate": "2023-05-24", "salaryFrequency": "1", "expectedSalaryDay": 24, "averageOtherIncome": 0, "numberSalaryPayments": 6, "numberOtherIncomePayments": 0, "numberSalaryInLast3Months": 0, "numberSalaryInLast4Months": 0, "confidenceIntervalonSalaryDetection": 0.59 }, "cashFlowAnalysis": { "lastDay": "2023-08-07", "firstDay": "2022-09-23", "debitCount": 219, "creditCount": 16, "monthPeriod": "September - August", "affordability": 0, "averageDebits": 22923.114, "averageBalance": 131009.13, "averageCredits": 161773.114, "closingBalance": 4425.19, "harmonicMeanCR": 6894.96, "harmonicMeanDR": 4.04, "openingBalance": 0, "accountActivity": 0.19, "yearInStatement": "2022,2023", "maxEmiEligibility": 45821, "totalMonthlyDebit": [ { "month": "2023-05", "amount": 629261.5 }, { "month": "2023-06", "amount": 187203.51 }, { "month": "2022-09", "amount": 400053.75 }, { "month": "2022-11", "amount": 641612.88 }, { "month": "2023-02", "amount": 259818.25 }, { "month": "2023-04", "amount": 449236.7 }, { "month": "2023-07", "amount": 782428.27 }, { "month": "2022-10", "amount": 515130.62 }, { "month": "2022-12", "amount": 500000 }, { "month": "2023-01", "amount": 276712.26 }, { "month": "2023-03", "amount": 378704.26 } ], "emiConfidenceScore": 0.08, "totalDebitTurnover": 5020162, "totalMonthlyCredit": [ { "month": "2023-02", "amount": 4000 }, { "month": "2023-04", "amount": 505966.17 }, { "month": "2023-06", "amount": 8000 }, { "month": "2023-07", "amount": 4000 }, { "month": "2022-09", "amount": 419570.14 }, { "month": "2022-11", "amount": 637131.79 }, { "month": "2022-12", "amount": 4000 }, { "month": "2023-08", "amount": 4000 }, { "month": "2022-10", "amount": 500837.37 }, { "month": "2023-03", "amount": 4000 }, { "month": "2023-05", "amount": 496864.36 } ], "averageMonthlyDebit": [ { "month": "2023-05", "amount": 31463.08 }, { "month": "2023-06", "amount": 8509.25 }, { "month": "2022-09", "amount": 133351.25 }, { "month": "2022-11", "amount": 37741.93 }, { "month": "2023-02", "amount": 25981.83 }, { "month": "2023-04", "amount": 18718.2 }, { "month": "2023-07", "amount": 13726.81 }, { "month": "2022-10", "amount": 73590.09 }, { "month": "2022-12", "amount": 500000 }, { "month": "2023-01", "amount": 11068.49 }, { "month": "2023-03", "amount": 11475.89 } ], "totalCreditTurnover": 2588369.83, "averageMonthlyCredit": [ { "month": "2023-02", "amount": 4000 }, { "month": "2023-04", "amount": 505966.17 }, { "month": "2023-06", "amount": 4000 }, { "month": "2023-07", "amount": 4000 }, { "month": "2022-09", "amount": 419570.14 }, { "month": "2022-11", "amount": 159282.95 }, { "month": "2022-12", "amount": 4000 }, { "month": "2023-08", "amount": 4000 }, { "month": "2022-10", "amount": 250418.69 }, { "month": "2023-03", "amount": 4000 }, { "month": "2023-05", "amount": 496864.36 } ], "noOfTransactingMonths": 12, "netAverageMonthlyEarnings": 50095.61 }, "statementAccuracy": { "checks": { "airtimeOutlier": false, "balanceAccuracy": false, "transactionFeeOutlier": true } }, "behaviouralAnalysis": { "loanAmount": 0, "accountSweep": "No", "cardRequests": 0, "gamblingRate": 0, "loanInflowRate": 0, "loanRepayments": 0, "returnedCheque": 0, "inflowOutflowRate": "Negative Cash Flow", "lateLoanRepayments": 0, "selfTransferActivity": 0, "loanRepaymentInflowRate": 0, "topIncomingTransferAccount": "Tajudeen/David", "topTransferRecipientAccount": "David/Tito" }, "transactionPatternAnalysis": { "NODWBalanceLess": { "count": 32, "amount": 5000 }, "lastDateOfDebit": "2023-07-31", "highestMAWODebit": { "month": "October", "week_of_month": 5 }, "lastDateOfCredit": "2023-08-07", "recurringExpense": [ { "amount": 5000, "description": "ref:391235623 tito george fuel" }, { "amount": 5000, "description": "nip transfer tito teju interbank ref: 45312160" }, { "amount": 51000, "description": "nip transfer ifo rccg city of joy parish interbank ref: 411972125" } ], "highestMAWOCredit": { "month": "November", "week_of_month": 4 }, "transactionRanges": [ { "max": 100000, "min": 10000, "count": 37 }, { "max": 500000, "min": 100000, "count": 17 }, { "max": 10000, "min": null, "count": 179 }, { "max": null, "min": 500000, "count": 2 } ], "NODWBalanceLess5000": 32, "transactionsLess10000": 179, "MAWWZeroBalanceInAccount": { "month": "March", "week_of_month": 13 }, "mostFrequentBalanceRange": "100000-500000", "transactionsGreater500000": 2, "mostFrequentTransactionRange": "<10000", "transactionsBetween10000And100000": 37, "transactionsBetween100000And500000": 17 } }, "status": "success", "message": "" } } }

The status field is marked as DONE, indicating that the analysis has completed successfully. The response contains detailed results such as income analysis, spend analysis, transaction patterns, cash flow, and more. This data can be used to assess the financial health or behavior of the customer based on the bank statement analysis.