Create BSA Report
Introduction
The Create BSA Report API allows users to generate a comprehensive Bank Statement Analytics (BSA) report by submitting specific input parameters. This API analyzes multiple aspects of a bank statement, including transaction patterns, cash flows, and financial health indicators, to provide insights into the customer's financial behavior and creditworthiness. By leveraging advanced analytics and data processing, the API delivers a detailed report tailored to meet underwriting, financial analysis, and risk assessment needs.
API Input Guidelines
Need to pass on the following information:
- requestId: The request ID associated with the Financial data whose report will be generated.
- linkedRefNo: An array of linkedRefNo linked with a particular account.
- callbackUrl: The required callback url.
curl --request POST \
--url https://api.signzy.app/api/v3/account-aggregator-switch/create-bsa \
--header 'Authorization: <token>' \
--header 'Content-Type: application/json' \
--data '{
"requestId" : "<Request-Id>",
"linkedRefNo" : "<Account-linked-Ref-no>",
"callbackUrl": "<callbackUrl>"
}'Input Parameters
PARAMETER NAME | REQUIRED/OPTIONAL | DESCRIPTION | TYPE |
|---|---|---|---|
requestId | required | The unique consent handle generated while creating a new consent request | string |
linkedRefNo | required | An array of linkedRefNo linked with a particular bank account | array |
callbackUrl | optional | The required callback url | string |
templateId | required | Customized Output according to templateId. |  |
Sample Response
{
"result": {
"reportId": "<unique-report-Id>"
}
}Response Parameter
PARAMETER NAME | DESCRIPTION | TYPE |
|---|---|---|
result | This holds final result parameters of the response. |  |
result.reportId | Unique indentifier for the report | String |

Error Codes
Error Code | Description |
|---|---|
400 | Bad Request: In case the request is not as per required schema or any other case |
401 | Unauthorized: Authentication failed or user does not have permissions for requested operation. |
409 | Upstream Error/Conflict: Something wrong on AA's side. |
500 | Internal Server Error: An error occurred on the server. |

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].