BSA Journey - Generate Web Journey Link

Introduction

This API lets integrators generate a secure web link for the BSA journey, where end users can upload their bank statements.

Sample Curl

curl --location 'https://api.signzy.app/api/v3/statement-analysis-url' \
--header 'Content-Type: application/json' \
--header 'Authorization: <client-auth-token>' \
--data '{
    "borrowerReferenceId": "",
    "callbackUrl": "<callback-url>",
    "redirectionUrl": "<redirection-url>"
}'

Input Parameters

Parameter	Type	Required	Description
borrowerReferenceId	string	Required	Id will be passed by integrator so that later they can check status and download the bsa report using same id. This id should be unique.
callbackUrl	string	Optional	On this callback url, integrators will recieve analysed bank statement results.
redirectionUrl	string	Optional	The url which will be used to redirect end user after journey completion.
customerName	String	Name of the customer which has to be matched with the statement name.	Optional
statementPeriod	String	Period of the statement can be passed as 6m, 3m, 1y, etc.	Optional
recencyDate	String	Users can pass the recency date from where the recency has to be checked. The format should be DD/MM/YYYY	Optional
recencyPeriod	String	User can define the period of recency. For ex: 6m, 3m	Optional

Sample Reponse

// Expected response
{
    "success": true,
    "data": {
        "redirectUrl": "https://uwuiflow-preproduction.signzy.app/bsajourney?journeyToken=eyJjaWQiOiJiNTNhYzc5Yy1iYTMxLTQyYWYtOGY4ZS00NjczZjViMzNkNjQiLCJicklkIjoiSk9VUk5FWV8wOCIsImV4cCI6MTc2MjE2MTk0MzgxMCwibiI6IjEwZjU2YWRkNWEyMWI4MzEifQ.ugP_bjsamWhz2HiHrdOb7HzT25Gq9TqTh2WaMPK5iAQ",
        "expiresAt": "2025-11-03T09:25:43.810Z"
    }
}

Response Parameters

Parameter	Description
success	Boolean value which shows if bsa journey url is created successfully or not.
data.redirectUrl	The url which will be used to perform BSA journey by enduser.
data.expiresAt	Expires at tells us expiry of journey URL.

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