Download Bank Statement

Endpoint Overview

POST /api/v1/bank/statement/download

Description

This API endpoint allows you to download a comprehensive bank statement analysis based on a previously submitted client ID. The response includes detailed transaction data, account summaries, fraud check indicators, monthly analysis, and various financial metrics. This endpoint is part of the bank statement analysis workflow and provides the complete analyzed statement data after processing.

Key Benefits

Retrieve comprehensive bank statement analysis with transaction details

Access fraud detection indicators and potential risk factors

Obtain monthly and quarterly financial summaries for better financial assessment

View detailed transaction categorization and spending patterns

Use Cases

Financial Services

Lending

Compliance

Credit risk assessment based on transaction history and spending patterns

Loan application verification using bank statement data

Financial health analysis for wealth management clients

Technical Implementation

Authentication

All API requests require authentication using a JWT Bearer token. Authentication follows these steps:

Obtain API Credentials: Register with Surepass to receive your API key.

Generate JWT Token: Use your API key to generate a JWT token.

Include in Requests: Add the token to the Authorization header as Bearer TOKEN.

Different authentication tokens are used for sandbox and production environments:

Sandbox: https://sandbox.surepass.io

Production: https://kyc-api.surepass.io

Request Parameters

Request Headers

Header	Required	Description
Authorization	Yes	Bearer token for authentication (JWT format)
Content-Type	Yes	application/json

Request Body

Parameter	Type	Required	Description
client_id	String	Yes	Unique Client ID received in the previous step of the bank statement analysis process

Example Request

{
    "client_id": "statement_analysis_muGJfRXkgkXPgkFLdxqh"
}

Process Response

Response Parameters

Parameter	Type	Description
data	Object	Container for the response data
data.client_id	String	Unique Client ID used for the request
data.statement	Object	Complete transaction details and analysis
status_code	Integer	HTTP status code of the response
success	Boolean	Indicates if the request was successful
message	String	Human-readable status message
message_code	String	Machine-readable status code

Statement Object Structure

The statement object contains multiple sections of analysis:

Section	Description
Fraud Check Triggers - Fraud Check Details	List of transactions that triggered fraud checks
Summary - Scorecard	Account holder information and key metrics
Quaterly Average	Quarterly balance averages
Summary - Document Authenticity Check	Document verification results
Summary - Fixed Income / Obligation	Salary and EMI/loan information
Fraud Check Triggers - Fraud Checks	List of fraud indicators and their detection status
Salary Info	Salary transaction details if detected
Emi Details	EMI payment details if detected
Month Wise Details	Monthly financial summaries
CAM Sheet	Comprehensive account monitoring data by month
EOD	End-of-day balances for each date
All Transactions	Complete list of all transactions with categorization
Scoring Details	Financial metrics and scoring parameters

Example Successful Response (Abbreviated)

{
    "data": {
        "client_id": "statement_analysis_sJRzpcpuOAnnjDYHOtPJ",
        "statement": {
            "Fraud Check Triggers - Fraud Check Details": [
                {
                    "FCU Trigger": "Balance Reconciliation",
                    "Date": "22/10/2014",
                    "Credit/Debit": "debit",
                    "Description": "CALL REF. NO. 3442, FROM A/C 22222222",
                    "Amount": 140,
                    "Balance": 1613.5,
                    "Reference": null
                },
                // Additional transactions omitted for brevity
            ],
            "Summary - Scorecard": [
                {
                    "Item": "Account Holders",
                    "Details": "NA",
                    "Verification": "NA"
                },
                // Additional summary items omitted for brevity
            ],
            // Additional sections omitted for brevity
        }
    },
    "status_code": 200,
    "success": true,
    "message": "Success",
    "message_code": "success"
}

Possible Error Responses

Authentication Error

Invalid Client ID

Processing Error

{
    "error": null,
    "message": "Your token is invalid. Please ensure that correct token is being used.",
    "status_code": 401,
    "success": false,
    "message_code": "invalid_token"
}

This error occurs when the JWT token is invalid, expired, or missing.

Integration Best Practices

Security Recommendations

Store JWT tokens securely and never expose them in client-side code

Implement proper error handling to prevent sensitive information leakage

Use HTTPS for all API communications to ensure data encryption in transit

Implement token refresh mechanisms to handle token expiration gracefully

User Experience Guidelines

Implement a loading indicator during statement download as processing may take time

Cache statement data when appropriate to improve performance for repeated views

Present statement data in a user-friendly format with clear categorization

Provide filtering and search capabilities for large transaction datasets

Code Samples

cURL

Python

Node.js

Related APIs

Bank Statement Upload API: Allows uploading bank statements for analysis

Bank Statement Verification API: Verifies the authenticity of uploaded bank statements

Bank Statement Analysis Status API: Checks the status of a bank statement analysis request

Compliance and Legal Considerations

When handling bank statement data, ensure compliance with data protection regulations such as GDPR, CCPA, or other applicable regional privacy laws. Bank statement data contains sensitive personal and financial information that must be handled securely. Obtain proper consent from users before processing their bank statements and implement appropriate data retention and deletion policies.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

curl --location --request POST 'https://kyc-api.surepass.app/api/v1/bank/statement/download' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "client_id": "statement_analysis_muGJfRXkgkXPgkFLdxqh" }'

{ "data": { "client_id": "statement_analysis_sJRzpcpuOAnnjDYHOtPJ", "statement": { "Fraud Check Triggers - Fraud Check Details": [ { "FCU Trigger": "Balance Reconciliation", "Date": "22/10/2014", "Credit/Debit": "debit", "Description": "CALL REF. NO. 3442, FROM A/C 22222222", "Amount": 140, "Balance": 1613.5, "Reference": null }, { "FCU Trigger": "Balance Reconciliation", "Date": "24/10/2014", "Credit/Debit": "debit", "Description": "Amazon", "Amount": 132.3, "Balance": 1473.5, "Reference": null }, { "FCU Trigger": "Balance Reconciliation", "Date": "24/10/2014", "Credit/Debit": "debit", "Description": "Tebay Trading Co.", "Amount": 515.22, "Balance": 1341.2, "Reference": null }, { "FCU Trigger": "Balance Reconciliation", "Date": "25/10/2014", "Credit/Debit": "debit", "Description": "Morrisons Petrol", "Amount": 80, "Balance": 825.98, "Reference": null }, { "FCU Trigger": "Balance Reconciliation", "Date": "25/10/2014", "Credit/Debit": "credit", "Description": "Business Loan", "Amount": 20000, "Balance": 745.98, "Reference": null }, { "FCU Trigger": "Balance Reconciliation", "Date": "26/10/2014", "Credit/Debit": "debit", "Description": "James White Media", "Amount": 2461.55, "Balance": 20745.98, "Reference": null }, { "FCU Trigger": "Balance Reconciliation", "Date": "27/10/2014", "Credit/Debit": "debit", "Description": "ATM High Street", "Amount": 100, "Balance": 18284.43, "Reference": null }, { "FCU Trigger": "Balance Reconciliation", "Date": "01/11/2014", "Credit/Debit": "debit", "Description": "Acorn Advertising Studies", "Amount": 150, "Balance": 18184.43, "Reference": null }, { "FCU Trigger": "Balance Reconciliation", "Date": "01/11/2014", "Credit/Debit": "debit", "Description": "Marriott Hotel", "Amount": 177, "Balance": 18034.43, "Reference": null }, { "FCU Trigger": "Balance Reconciliation", "Date": "01/11/2014", "Credit/Debit": "debit", "Description": "Abellio Scotrail Ltd", "Amount": 122.22, "Balance": 17857.43, "Reference": null }, { "FCU Trigger": "Balance Reconciliation", "Date": "01/11/2014", "Credit/Debit": "debit", "Description": "Cheque 0000234", "Amount": 1200, "Balance": 17735.21, "Reference": null }, { "FCU Trigger": "Balance Reconciliation", "Date": "01/12/2014", "Credit/Debit": "credit", "Description": "Interest Paid", "Amount": 9.33, "Balance": 16535.21, "Reference": null }, { "FCU Trigger": "Balance Reconciliation", "Date": "01/12/2014", "Credit/Debit": "debit", "Description": "OVO Energy", "Amount": 2470, "Balance": 16544.54, "Reference": null }, { "FCU Trigger": "Balance Reconciliation", "Date": "21/12/2014", "Credit/Debit": "debit", "Description": "Various Payment"

Download Statement

Download Bank Statement#

Description#

Use Cases#

Technical Implementation#

Request Headers#

Request Body#

Example Request#

Response Parameters#

Statement Object Structure#

Example Successful Response (Abbreviated)#

Possible Error Responses#

Integration Best Practices#

Code Samples#

Request

Responses