Create bank connect journey link

7 min

Introduction

This API enables the transfer of bank account data between separate banks with the bank account holder's consent. The data that can be transferred includes:

Personal information and user details
6 month transaction details
12 month transaction details
Ongoing checks on monthly basis
On-demand data pull

This API helps to get the customer id and the link to create the journey.

API Input Guidelines

Need to pass following information:

Webhook
Redirect URL

Sample Curl

Preproduction

New Tab

curl --location --request POST 'https://api-preproduction.signzy.app/api/v3/bank-connect/generate-link' \
--header 'Authorization: <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "webhook": "https://webhook.site/37545ddd-7b57-405e-add2-afe99f156b19",
    "redirectUrl": "https://www.signzy.com/"
}'

Input Parameters

PARAMETER NAME	REQUIRED/OPTIONAL	DESCRIPTION
Authorization	Required	Authorization token
Content-Type	Required	application/json
webhook	Required	Data of the response will be posted here.
redirectUrl	Required	The URL of the page to which you want to send the user.

Sample Response

{
    "result": {
        "customerUsername": "SignzyUser1675323336759",
        "customerId": "6019521730",
        "link": <link>
    }
}

Response Parameter

PARAMETER NAME	DESCRIPTION
result.customerUsername	Username of the account holder.
result.customerId	This gives the Customer ID.
result.link	This provides the link to start the journey.

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