Statement Analysis - Analyze Statement
This API offers automated credit card and bank statement analysis, allowing lenders to gain comprehensive insights into borrower financial behavior. Analyzing spending patterns, payment consistency, and overall financial responsibility, enhances credit risk assessment and enables more personalized lending decisions. With its ability to provide quicker and more accurate assessments, the API aims to improve the efficiency and effectiveness of lending processes while ensuring customer satisfaction and competitiveness in the market.
Parameter | Type | Description | Mandatory/Optional |
authType | String | Authentication Token Generated in the Authenticate API. | Mandatory |
files | Array | List of Files that you need analysis on | Mandatory |
files[n].fileUrl | String | Bank Statement or Credit Card Statement file URL | Mandatory |
files[n].password | String | Password of the file provided | Optional |
Parameter | Type | Description |
report | Object | Contains the overall report information. |
report.reportId | String | Unique identifier for the report. |
report.reportName | String | The internal name of the report. |
report.reportStatus | String | This shows the status of the report. The status of a report changes till it reaches the last status. The possible status for a report can be one of the following
|
report.reportStatusDescription | String | This shows detailed information about accounts in the report with status. A possible status description for a report can be one of the following
|
report.reportCamStatus | String | This shows the status of the CAM report. Possible CAM status for a report can be one of the following
|
report.reportType | String | Type of report (e.g., "1"). |
report.lastUpdatedOn | String | Date and time the report was last updated in YYYY-MM-DD HH:MM: SS format. |
report.createdOn | String | Date and time the report was created in YYYY-MM-DD HH:MM: SS format. |
reportAccounts | Array of Objects | List of accounts included in the report. |
reportAccounts[i].account | Object | Details of a specific account. |
reportAccounts[i].account.accountId | String | Unique identifier for the account. |
reportAccounts[i].account.accountNumber | String | Account number (e.g., "6012XXXXXXX4312"). |
reportAccounts[i].account.ifscCode | String | The IFSC code of the bank to which the account belongs. |
reportAccounts[i].account.accountType | String | Account type code (e.g., "1" for Savings Account, "2" for Current Account). |
reportAccounts[i].account.accountTypeName | String | Name of the account type (e.g., "Savings Account"). |
reportAccounts[i].account.bankId | String | Unique identifier for the bank. |
reportAccounts[i].account.bankName | String | Name of the bank (e.g., "State Bank of India"). |
reportAccounts[i].account.status | String | Status of the created account. The possible status for the account can be the following
|
reportAccounts[i].account.statusDescription | String | Detailed information about the status of the created account with CAM report status. Possible status description for the account can be the following
|
reportAccounts[i].account.camStatus | String | Status of the CAM report of an account. Possible CAM status for the account can be the following
|
reportAccounts[i].account.startDate | String | The start date of the account data is included in the report (YYYY-MM-DD). |
reportAccounts[i].account.endDate | String | The end date of the account data is included in the report (YYYY-MM-DD). |
reportAccounts[i].account.phoneNumber | String | Phone Number extracted from bank statement. |
reportAccounts[i].account.jointHolderName | String | Joint account holder name extracted from bank statement. |
reportAccounts[i].account.accountHolderName | String | Account holder extracted from bank statement. |
reportAccounts[i].account.micrCode | String | MICR code extracted from the bank statement. |
reportAccounts[i].account.branchAddress | String | The branch address was extracted from the statement. |
reportAccounts[i].account.branchName | String | Branch name extracted from the statement. |
reportAccounts[i].account.panNumber | String | Pan number extracted from the statement. |
reportAccounts[i].account.email | String | Email address extracted from the statement. |
reportAccounts[i].account.customerAddress | String | Customer address extracted from the statement. |
reportAccounts[i].account.accountOpeningDate | String | Account opening date extracted from the statement. |
reportAccounts[i].account.verifiedAccount | String | Verification status of the account (e.g., "2"). |
reportAccounts[i].account.analysisStartDate | String | Custom analysis start date. |
reportAccounts[i].account.analysisEndDate | String | Custom analysis end date. |
reportAccounts[i].account.analysisPeriod | String | Analysis Period of the Bank Statement |
reportAccounts[i].account.transactionStartDate | String | Transaction Start Date |
reportAccounts[i].account.transactionEndDate | String | Transaction End Date. |
reportAccounts[i].account.currency | String | Currency code (e.g., "INR"). |
reportAccounts[i].account.currencyFormat | String | Format string for displaying currency values (e.g., "##,##,###.##"). |
reportAccounts[i].account.accountStatus | String | Status of the Account |
reportAccounts[i].account.accountReferenceNumber | String | Unique reference number for the account within the report (e.g., "PARN144"). |
reportAccounts[i].account.lastModifiedDate | Date and time | Last Modified Date of the report |
reportAccounts[i].fileDetails | Object | Contains the details about the files associated with each account |
reportAccounts[i].fileDetails.accountId | Number | Account id to which the file belongs. |
reportAccounts[i].fileDetials.accountReferenceNumber | String | The account reference number to which the file belongs. |
reportAccounts[i].fileDetails.success.fileId | Number | Id of the file. |
reportAccounts[i].fileDetails.success.status | String | Status of the file. Possible statuses of a file could be
|
reportAccounts[i].fileDetails.success.originalName | String | The original name of the file uploaded. |
reportAccounts[i].fileDetails.success.documentType | String | Type of file uploaded. Possible values could be
|
reportAccounts[i].fileDetails.success.password | String | The password is provided while creating the account. |
reportAccounts[i].fileDetails.success.creatorName | String | Creator of the file uploaded. |
reportAccounts[i].fileDetails.success.producerName | String | Producer of the file uploaded. |
reportAccounts[i].fileDetails.success.statusDescription | String | Description of file status. |
reportAccounts[i].fileDetails.failed.originalName | String | The original name of the file has been uploaded. |
reportAccounts[i].fileDetails.failed.errorMessage | String | Error reason for the failure of file. The possible error messages could be 'Password required', 'Incorrect password', or 'Incorrect bank statement'. |
reportGst | Array | Contains a list of GST details. |
reportCreditBureaus | Array | Contains a list of credit bureau details |