Bank Statement Extraction

7 min

Introduction

This service is used for retrieving the details of bank statement by simply entering the bank statement file URL.

This API uses the bank statement of the user's in the form of file URL and will provide the details of that particular bank statement. It helps in auto-extracting the details for the bank statement without having to manually provide the information. This API provides detailed information about the bank statement.

How to call the API

The authorization header in the request must include the access token obtained before this API can be consumed.

The API is hit by passing Bank statement File URL, Bank Name, Account Type as input parameter. API returns all the details corresponding to the bank statement given in input, on a successful hit.

API Input Guidelines

Before diving into the API integration, it's important to follow these guidelines:

Obtain API Access: To use the Signzy API, you need to obtain an access token. This token serves as your authorization key and should be included in the API request headers.
Request Format: All API requests must be in JSON format. Ensure that the request body and headers are correctly formatted as per the API documentation.
Required Parameters: The API requires certain parameters to be provided in the request for successful execution. These parameters will be discussed in the next section.

Sample Curl

Production

curl --location --request POST 'https://api.signzy.app/api/v3/bank-statement/extraction' \
--header 'Authorization: <Token>' \
--header 'Content-Type: application/json' \

--data-raw '{
    "url": "..fileUrl",
    "bankName": "..bank name..",
    "accountType": "SAVING"
}'

Input Parameters

PARAMETER NAME	REQUIRED/OPTIONAL	DESCRIPTION
Authorization	REQUIRED	Contains the id parameter returned from the login step
Content-Type	REQUIRED	application/json
url	REQUIRED	File URL of the bank statement
bankName	REQUIRED	Name of partner bank for which statement is there
accountType	REQUIRED	Type of account

Sample Response

{
}

Response Parameter

PARAMETER NAME	DESCRIPTION

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