Create Request | Advance BSA
This service is used for initiating a request to start advanced bank statement analysis.
This API uses the bank statement of the user's in the form of file URL and will provide a reference ID. It helps in auto-extracting the advanced details for the bank statement without having to manually provide the information. This API provides detailed information about the bank statement.
The authorization header in the request must include the access token obtained before this API can be consumed.
The API is hit by passing Bank statement File URL(s) and their passwords, Account Number, Account Type, Entity Type, Bank code as input parameters. API returns a reference id that can be used in fetch report, merge report APIs.
Need to pass following information
- Bank statement File URLs (with their passwords, if applicable)
- Entity Type
- Bank Code
- Account Type
- Account Number
PARAMETER NAME | REQUIRED/OPTIONAL | DESCRIPTION |
Authorization | REQUIRED | Contains the id parameter returned from the login step |
Content-Type | REQUIRED | application/json |
files | REQUIRED | List of objects containing "fileUrl", "password" |
files.fileUrl | REQUIRED | URl of the pdf/xml file on which bank statement Analytics is to be run |
files.password | OPTIONAL | If file is password protected |
data | REQUIRED | data containing entityType, bankCode, accountType, accountNumber |
data.entityType | REQUIRED | The type of entity whose bank statement is given as input. Takes possible values: "Individaul", "Company", "Trust", "Partnership" and "Sole_Proprietership". |
data.bankCode | REQUIRED | List of bank codes to identify the bank statement will be provided by our support team. |
data.accountType | REQUIRED | The type of account for which the bank statement is being run. Can take possible values: "savings", "Currrent", "Cash_Credit" and "Over_draft". |
data.accountNumber | REQUIRE | The account number of the bank account for the analyzer is being used. |
data.entityName | OPTIONAL/Required in Case of XML upload | Name of the entity for whose bank statement the analyzer is being used. |
data.pan | OPTIONAL/Required in Case of XML upload | PAN number of the entity whose bank statement is being used |
data.sanctionLimit | REQUIRED/OPTIONAL | Optional for Current and Savings account |
data.monthlyDrawingPowerLimit | OPTIONAL | List of objects having "month","year","amount" keys |
data.relatedPartyKeywords | OPTIONAL/Required in Case of XML upload | Key words to be specifically searched for in the bank statement |
data.userapplicationid | Required only for XML Upload | Fixed variable to be passed as "SM001" |
data.productID | Required only for XML Upload | Fixed variable to be passed as "1234" |
data.productType | Required only for XML Upload | Fixed variable to be passed as "1234" |
data.userName | OPTIONAL | |
PARAMETER NAME | DESCRIPTION |
result.referenceId | this reference Id can be used in fetch data API |
result.message | message containing request output |
The API endpoint can return the following response codes:
Response Code | Description | Example Input (Error Scenario) | Example Output (Error Scenario) |
200 | The request was processed successfully. | NA | NA |
400 | The request was not processed successfully. An error message is included in the response body. | { "files": [ { "fileUrl": "https://persist.signzy.tech/api/files/46821/download/123.pdf" } ], "data": { "entityType": "Individual", "bankCode": "FI00068", "accountType": "SAVING", "accountNumber": "00000036132112345" } }} } | { "error": { "name": "error", "message": "\"data.accountType\" must be [SAVINGS]", "status": 400, "reason": "VALIDATION_REQUEST", "type": "OK", "statusCode": 200 } }} |
409 | The request could not be processed due to some error in upstream. | NA | { "error": { "name": "error", "message": "Error in fetching data", "status": 409, "reason": "UPSTREAM DOWN", "type": "Conflict", "statusCode": 409 } }} |
- In case of Entity Type selected as “Individual”, then only Account Type “Savings” can be entered.
- In case of other entity types i.e. “Company”, “Partnership”, “Sole_Proprietorship” and “Trust”, any of the Account Type except “Savings” can be entered i.e. “Current”, “Cash_Credit” and “Over_Draft” account type.
- sanctionLimit key is mandatory for Cash_Credit and Over_Draft account type.
Getting help
Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.
You can reach out to us at [email protected].