Feature Description
This feature allows users to seamlessly accept password‑protected bank statement PDFs, and generate a Bank Statement Analysis (BSA) report. All through a simple, secure two‑API integration.
API Flow
- Use the Authentication API to generate a secure JWT token, which is required to authorize the subsequent API request.
- Initiate the Upload PDF API and provide the following inputs:
- The bank statement in PDF format
- The password for the PDF (if applicable)
- The callback URL where the processed BSA output should be delivered
- Once processing is completed, the BSA output in JSON format is automatically sent to the specified callback URL.
Note: The JWT token expires in 30mins
APIs
1. Authenticate API
Endpoint: https://uatapp.finduit.in/api/FIU/Authentication
Description: This API is for authentication, so that only authorized users can call the Upload PDF API
Request
| Postman | Fields | Datatype | Mandatory | Description | Example |
|---|---|---|---|---|---|
| Body | fiuId | String | Y | Unique Id of FIU | STERLING-FIU-UAT |
| Body | redirection_key | String | Y | A secret key for each client which we be given by us to the clients | XYZABcDEf123g4H |
| Body | userId | String | Y | Unique Id of the users of FIU id | [email protected] |
Sample Request
{
"fiuID": "STERLING-FIU-UAT",
"redirection_key": "XYZABcDEf123g4H",
"userId": "[email protected]"
}
Response
| Fields | Datatype | Description | Example |
|---|---|---|---|
| txnId | String | Unique Id for the transaction | 23413414edhqe |
| fiuId | String | Unique Id of FIU | STERLING-FIU-UAT |
| statusCode | String | Status code of the API | 200 |
| message | String | Message regarding the status of the API | Success |
| sessionId | String | Unique Id of session | 9120e51a-d1f0-444e-ad23-8af19621faad |
| token | String | Unique JWT token generated, which will be used for authentication of the next API | eyJhbGciOiJod.... |
| clientIP | String | IP address of the client | 0.0.0.0 |
| usergroup | String | Unique Id of FIU | null |
Sample Response when success
{
"txnId": null,
"fiuId": "STERLING-FIU-UAT",
"statusCode": "200",
"message": "Success",
"sessionId": "9120e51a-d1f0-444e-ad23-8af19621faad",
"token": "eyJhbGciOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxLzA0L3htbGRzaWctbW9yZSNobWFjLXNoYTUxMiIsInR5cCI6IkpXVCJ9.eyJmaXVJZCI6IlNURVJMSU5HLUZJVS1VQVQiLCJ1c2VySWQiOiJhYWthc2guamFpbkBjYW1zb25saW5lLmNvbSIsInNlc3Npb24iOiI5MTIwZTUxYS1kMWYwLTQ0NGUtYWQyMy04YWYxOTYyMWZhYWQiLCJ0aW1lc3RhbXAiOiIwMS8wMS8wMDAxIDEyOjAwOjAwIGFtIiwiaXNBZG1pbiI6IiIsImV4cCI6MTc2ODgxNzEyMiwiaXNzIjoiaHR0cHM6Ly9GaW5zZXJ2ZS5jb20vSXNzdWVyIiwiYXVkIjoiaHR0cHM6Ly9GaW5zZXJ2ZS5jb20vQXVkaWVuY2UifQ.3AGfk_ltHYySjf_y9LW2Whq26HTWxPOoM57_mdu6Ad5guGszYjfC7grF-YHZuOglNk-rfPXzp8k_0MbDCp_rPQ",
"clientIP": null,
"userGroup": null
}
Sample Response when userId is invalid
{
"ver": null,
"timestamp": null,
"errorCode": null,
"errorMsg": null,
"txnid": null,
"statusCode": "400",
"message": "Invalid fiuID or userId"
}
Sample Response when redirection key is invalid
{
"ver": null,
"timestamp": null,
"errorCode": null,
"errorMsg": null,
"txnid": null,
"statusCode": "400",
"message": "Invalid fiuID or userId"
}
Sample Response when fiu_id is invalid
{
"ver": null,
"timestamp": null,
"errorCode": null,
"errorMsg": null,
"txnid": null,
"statusCode": "400",
"message": "Invalid fiuID or userId"
}
2. Upload PDF API
Endpoint: https://uatapp.finduit.in/api/UploadPDF
Description: This API is for uploading PDF bank statements along with a password and receiving processed output at the provided callback URL
| Postman | Fields | Datatype | Mandatory | Description | Example |
|---|---|---|---|---|---|
| Header | Bearer Token | JWT | Y | ||
| Body | fiuId | String | Y | Unique Id of FIU | STERLING-FIU-UAT |
| Body | userId | String | Y | Unique Id of the users of FIU id | [email protected] |
| Body | pdfFile | String | Y | The uploaded bank statement in PDF format | Federal_Bank.pdf |
| Body | bsaRequired | String (Y or N) | N | Check for if BSA is required or just json | Y |
| Body | pdfPassword | String | N | Password of the PDF, if the PDF has any | password123 |
| Body | clientTxnId | String | Y | A UUID which is passed by the client for tracking purposes. | 54f103fc-dd81-489c-9c74-5025a5f2aa1a |
| Body | callBackUrl | String | Y | The webhook to which the user will receive the analyzed data | https://uatapp.finduit.in/api/V2/Notification/receive |
Sample Request
| Key | Value |
|---|---|
| fiuId | STERLING-FIU-UAT |
| userId | [email protected] |
| pdfFile | Federal_Bank.pdf |
| bsaRequired | Y |
| pdfPassword | password123 |
| clientTxnId | 54f103fc-dd81-489c-9c74-5025a5f2aa1a |
| callBackUrl | https://uatapp.finduit.in/api/V2/Notification/receive |
Sample Response when success
{
"sessionId": "1b7cd726-1072-4ba1-a174-90e16288f15f",
"uploadId": "1d007734-da0c-490e-8dde-dac186b0ab11",
"fileName": "Federal_Bank.pdf",
"statusCode": 200,
"message": "File uploaded successfully",
"clientTxnId": "54f103fc-dd81-489c-9c74-5025a5f2aa1b"
}