Bank Statement Scorecard

9 min

Introduction

This service is used to provide details of scorecard from bank statement details.

The Scorecard API takes bank details and raw transactional data and provide a score based on the bank Statement. This API will either take direct bank statement pdf file in the input, or a JSON file in the form of Account Aggregator response.

How to call the API

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

If isBankStatementPdf in the input is set to true, the API is hit by passing Bank statement File URL, Bank Name, Account Type, Facility, as input parameter.

If isBankStatementPdf in the input is set to false, the API is hit by passing JSON File(containing JSON in the form of Account Aggregator Response) URL as input parameter.

The API returns a bank statement score object containing number of score card inputs and the final score.

API Input Guidelines

Need to pass following information if bank statement PDF is provided

isBankStatementPdf: true
Bank statement File PDF URL
Bank Name
Account Type
Facility

Need to pass following information if Account Aggregator JSON is provided

isBankStatementPdf: false
Bank statement File JSON URL

Sample Curl

Production

curl --location --request POST 'https://api.signzy.app/api/v3/advanced-bank-statement-analysis/scorecard' \
--header 'Authorization: <Token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "isBankStatementPdf": true,
    "fileUrl": "https://persist.signzy.tech/api/files/4682180/download/1234.pdf",
    "bankName": "SBI",
    "accountType": "SAVING",
    "facility": ""
}'

Input Parameters

PARAMETER NAME	REQUIRED/OPTIONAL	DESCRIPTION
Authorization	REQUIRED	Contains the id parameter returned from the login step
Content-Type	REQUIRED	application/json
isBankStatementPdf	REQUIRED	Boolean to choose pdf or json mode
fileUrl	REQUIRED	data
bankName	REQUIRED (	string containing bank Name
accountType	REQUIRED	string containing one of ('SAVING', 'CURRENT', 'CREDIT_CARD')
facility	OPTIONAL	string containing facility

Sample Response

{
    "result": {
        "bankStatementScore": {
            "numberOfScoreCardInputs": 16,
            "score": 647
        }
    }
}

Response Parameter

PARAMETER NAME	DESCRIPTION
result.bankStatementScore.numberOfScoreCardInputs	number of score card inputs
result.bankStatementScore.score	number containing final score

Response Codes

The API endpoint can return the following response codes:

Response Code	Description	Example Input (Error Scenario)	Example Output (Error Scenario)
200	The request was processed successfully.	NA	NA
400	The request was not processed successfully. An error message is included in the response body.	{ "isBankStatementPdf": true, "fileUrl": "https://persist.signzy.tech/api/files/123/download/123.json" }	{ "error": { "name": "error", "message": "\"bankName\" is required", "status": 400, "reason": "VALIDATION_REQUEST", "type": "Bad Request", "statusCode": 400 } }
409	The request could not be processed due to some error in upstream.	NA	{ "error": { "name": "error", "message": "Error in fetching data", "status": 409, "reason": "UPSTREAM DOWN", "type": "Conflict", "statusCode": 409 } }}

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