Bank Account Verification Refresh

Introduction

This API helps refresh bank account balance and transaction details for an already connected account holder using the loginId linked with the customer. LoginId will be generated when the customer is first connected using Generate Link API.

The Refresh API avoids restarting the entire bank connectivity journey and attempts to reuse the existing bank session to fetch updated data.

Currently, the Refresh API is supported only for the US region (Flinks).

API Details

Sample cURL

Production

Pre-Production

curl --location --request POST 'https://api.signzy.us/api/v3/global-bank-verification/refresh' \
--header 'Authorization: <token>' \
--header 'Content-Type: application/json' \
--data '{
  "customerId": "694190f7a83d7d9dfce5953d",
  "country": "US",
  "loginId": "d74efed8-238d-443f-489d-08de3caff735",
  "getTransactions": true,
  "transactionsPeriod": "12",
  "getBankBalance": true
}'

curl --location --request POST 'https://api-preproduction.signzy.us/api/v3/global-bank-verification/refresh' \
--header 'Authorization: <token>' \
--header 'Content-Type: application/json' \
--data '{
  "customerId": "694190f7a83d7d9dfce5953d",
  "country": "US",
  "loginId": "d74efed8-238d-443f-489d-08de3caff735",
  "getTransactions": true,
  "transactionsPeriod": "12",
  "getBankBalance": true
}'

Request Body Parameters

Parameter	Data Type	Required	Description
customerId	string	Yes	A unique 24 digit clientid assigned to Signzy's customer. Client has to send the same id each request for tracking at Signzy's end.
country	string	Yes	Country of bank account. Supported value: US
loginId	string	Yes	Login ID generated after completing the Generate Link journey
getTransactions	boolean	Optional	Whether transactions should be refreshed. Default is true
transactionsPeriod	string	Optional	Transaction period in months. Supported values: 3 or 12. Default is 12
getBankBalance	string	Optional	Whether bank balance should be refreshed. Default is true

Sample Response

{
  "result": {
    "statusCode": 200,
    "loginId": "d74efed8-238d-443f-489d-08de3caff735",
    "requestId": "86b9c591-7836-4511-b3a2-0f0957326285",
    "traceId": "6947fbf2a83d7d9dfce5bd1a",
    "action": "Refresh Successful"
  }
}

Refresh Flow Behavior

When statusCode is 200, Signzy fetches updated data and posts it to the callback URL configured during onboarding. Refresh API will have the same response on callback as the Generate Link API.

When the statusCode is 203, additional user interaction is required to complete MFA. In this case, the user must pass the requestId received from the Refresh API into the Generate Link API to allow the customer to complete the connect journey. MFA issues typically occur when the customer has changed or updated their security or MFA settings on their account. This flow enables customers to re-complete only the MFA step, instead of restarting the entire journey from the beginning.

When statusCode is 205, the user must reconnect using the Generate Link API.

Response Body Parameters

Parameter	Description
result.statusCode	Status returned by the refresh process It can be 200, 203 or 205
result.loginId	Login ID used for refresh
result.requestId	Request ID needed for MFA case
result.traceId	Unique trace ID
result.action	Action taken based on refresh outcome There are 3 cases :- 200 - Refresh Successful 203 - Refresh Unsuccessful, MFA Required 205 - Refresh Unavailable, Reconnection Required

Sample Error

Case of wrong login Id

{
    "error": {
        "name": "error",
        "message": "No tracking data found for loginId: <loginId>",
        "status": 404,
        "reason": "ERROR",
        "type": "Not Found",
        "statusCode": 404
    }
}

Error Response Parameters

Parameter	Description
error	This parameter contains the error.
error.name	the name of the error
error.message	the error message
error.status	status of the api
error.reason	Reason for error
error.type	Type of the error
error.statusCode	Request Status code from Signzy

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]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.

We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!