Bank Statement Basic Details

Introduction

This API allows you to extract details from a bank statement PDF by providing the necessary input parameters. By integrating this API into your application, you can automate the process of extracting bank statement data, saving time and effort.

How to call the API

You will need to login before sending request.

task (string, required): This parameter specifies the type of task you want to perform. For the Bank Statement API, set this parameter to "details" to extract statement details.
essentials (object, required): This parameter contains essential information for processing the bank statement. It includes the following sub-parameters:
- url (string, required): The URL of the bank statement PDF file.
- password (string, optional): The password of the PDF file (if applicable). This parameter is optional and can be omitted if the PDF file is not password-protected.

API Input Guidelines

Before making API requests, please ensure that you have the necessary access token for authorization. If you do not have one, kindly obtain it from Signzy. The API follows the POST request method and requires the input parameters to be provided in the request body as JSON data.

Sample Curl

curl --request POST \
  --url https://signzy.tech/api/v2/patrons/..your-patron-id../bankStatementv1 \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'Authorization: <Access-Token>' \
  --header 'content-type: application/json' \
  --data '{"task": "details", "essentials": { "url": "...PDF url...", "password": "...password of PDF url... (Optional)"}}'

Input Parameters

Parameter	Type	Required	Description
task	string	Required	The type of task to perform. Set to "details" for bank statements.
essentials	object	Required	Essential information for processing the bank statement.
essentials.url	string	Required	The URL of the bank statement PDF file.
essentials.password	string	Optional	The password of the PDF file (if applicable).

Sample Reponse


    // Expected response
    {  
        "result": {
            "message": "...message...",
            "timeStamp": "...timeStamp...",
            "data": {
                "name": "...name...",
                "accountNumber": "...accountNumber...",
                "accountType": "...accountType...",
                "address": "...address...",
                "branch": "...branch...",
                "ifsc": "...ifsc...",
                "pan": "...pan...",
                "metadata": {
                    "author": "...author...",
                    "creator": "...creator...",
                    "producer": "...producer...",
                    "creationDate": "...creationDate...",     
                    "modificationDate": "...modificationDate..."     
                },    
                "statementPeriod": {
                    "from": "...from...",
                    "to": "...to..."
                },
                "validationChecks": {
                    "note": "...note...",
                    "trustablePdfProducer": "...true/false...",
                    "sameCreationModificationDate": "...true/false...",
                    "validFonts": "...true/false...",
                    "validStructure": "...true/false..."
                }
            }
        }
    }

Response Parameters

Field	Type	Description
result	object	The result object containing the response data.
result.message	string	A message indicating the status or outcome of the API request.
result.timeStamp	string	The timestamp indicating the time when the response was generated.
result.data	object	The extracted bank statement data.
result.data.name	string	The name associated with the bank account.
result.data.accountNumber	string	The account number associated with the bank statement.
result.data.accountType	string	The type or category of the bank account (e.g., savings, current).
result.data.address	string	The address linked to the bank account.
result.data.branch	string	The branch or location of the bank associated with the statement.
result.data.ifsc	string	The IFSC (Indian Financial System Code) of the bank branch.
result.data.pan	string	The PAN (Permanent Account Number) associated with the account.
result.data.metadata	object	Additional metadata related to the bank statement PDF file.
result.data.metadata.author	string	The author of the PDF file.
result.data.metadata.creator	string	The creator of the PDF file.
result.data.metadata.producer	string	The producer of the PDF file.
result.data.metadata.creationDate	string	The creation date of the PDF file.
result.data.metadata.modificationDate	string	The modification date of the PDF file.
result.data.statementPeriod	object	The period covered by the bank statement.
result.data.statementPeriod.from	string	The start date of the statement period.
result.data.statementPeriod.to	string	The end date of the statement period.
result.data.validationChecks	object	Various validation checks performed on the bank statement.
result.data.validationChecks.note	string	Additional notes or remarks related to the validation checks.
result.data.validationChecks.trustablePdfProducer	string	Indicates whether the PDF producer is considered trustworthy (true/false).
result.data.validationChecks.sameCreationModificationDate	string	Indicates whether the creation and modification dates are the same (true/false).
result.data.validationChecks.validFonts	string	Indicates whether the PDF has valid fonts (true/false).
result.data.validationChecks.validStructure	string	Indicates whether the PDF has a valid structure (true/false).

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