ePDF to BSA Feature

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

PostmanFieldsDatatypeMandatoryDescriptionExample
BodyfiuIdStringYUnique Id of FIUSTERLING-FIU-UAT
Bodyredirection_keyStringYA secret key for each client which we be given by us to the clientsXYZABcDEf123g4H
BodyuserIdStringYUnique Id of the users of FIU id[email protected]

Sample Request

{
    "fiuID": "STERLING-FIU-UAT",
    "redirection_key": "XYZABcDEf123g4H",
    "userId": "[email protected]"
}

Response

FieldsDatatypeDescriptionExample
txnIdStringUnique Id for the transaction23413414edhqe
fiuIdStringUnique Id of FIUSTERLING-FIU-UAT
statusCodeStringStatus code of the API200
messageStringMessage regarding the status of the APISuccess
sessionIdStringUnique Id of session9120e51a-d1f0-444e-ad23-8af19621faad
tokenStringUnique JWT token generated, which will be used for authentication of the next APIeyJhbGciOiJod....
clientIPStringIP address of the client0.0.0.0
usergroupStringUnique Id of FIUnull

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

PostmanFieldsDatatypeMandatoryDescriptionExample
HeaderBearer TokenJWTY
BodyfiuIdStringYUnique Id of FIUSTERLING-FIU-UAT
BodyuserIdStringYUnique Id of the users of FIU id[email protected]
BodypdfFileStringYThe uploaded bank statement in PDF formatFederal_Bank.pdf
BodybsaRequiredString (Y or N)NCheck for if BSA is required or just jsonY
BodypdfPasswordStringNPassword of the PDF, if the PDF has anypassword123
BodyclientTxnIdStringYA UUID which is passed by the client for tracking purposes.54f103fc-dd81-489c-9c74-5025a5f2aa1a
BodycallBackUrlStringYThe webhook to which the user will receive the analyzed datahttps://uatapp.finduit.in/api/V2/Notification/receive

Sample Request

KeyValue
fiuIdSTERLING-FIU-UAT
userId[email protected]
pdfFileFederal_Bank.pdf
bsaRequiredY
pdfPasswordpassword123
clientTxnId54f103fc-dd81-489c-9c74-5025a5f2aa1a
callBackUrlhttps://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"
}