# Bank Statement Analyse

Data extraction from a bank statement analyse refers to the process of capturing and retrieving the information contained within the statement and presenting it in an Excel report.

## analyse\_bank\_statement

<mark style="color:green;">`POST`</mark> `https://secctrl.tutelar.io/api/v1/kyc/banking/analyse_bank_statement`

### Post parameters description is given below,

<table><thead><tr><th width="197">Post Parameter </th><th width="139">Type</th><th>Is  Mandatory</th><th>Description</th></tr></thead><tbody><tr><td>file</td><td>pdf</td><td>Yes </td><td>Statement pdf for analysing the bank statement</td></tr><tr><td>password</td><td>String</td><td>No</td><td>Password for the <br>bank statement ( If the statement has password authentication) </td></tr></tbody></table>

#### Sample Post Parameters

To call this API, you must send a **POST** request with `multipart/form-data` containing:

1. **file** – The bank statement PDF file that needs to be analyzed.
   * This should be attached in the form-data as a file upload.
   * Example: `file=@"/path/to/Account Statement.pdf"`
2. **password** – The password required to open the PDF (if the PDF is password-protected).
   * If the PDF has no password, send an empty string for this field.

```
--form 'file=@"/path/to/Account Statement.pdf"'
--form 'password="205038077"'
```

{% tabs %}
{% tab title="200: Success Response" %}

```json
{
    "success": true,
    "code": 200,
    "message": "The request has been successfully completed.",
    "reference_id": "c20ad4c9-1556-450f-98c7-db8013101f5c",
    "status": "completed",
    "result": {
        "account_name": "MR. ANUP DUBEY",
        "account_number": "50100158077633",
        "ifsc_code": "HDFC0001116",
        "account_type": "Savings Account",
        "bank_name": "HDFC Bank",
        "report_start_date": "2018-06-01",
        "report_end_date": "2018-10-10",
        "statement_analyse_status": "Report analysis have been completed successfully.",
        "report_download_url": "Download Url Presents here."
    },
    "requested_at": "2025-08-13T06:09:37.041Z",
    "completed_at": "2025-08-13T06:09:37.504Z"
}
```

{% endtab %}

{% tab title="200: InProgress Response" %}

```json
{
    "success": true,
    "code": 200,
    "message": "The request is being processed. Please wait for completion.",
    "reference_id": "10cc9473-ce11-425e-ac89-1f51ce6e78de",
    "status": "in_progress",
    "requested_at": "2024-04-22T05:28:49.245Z"
}
```

{% endtab %}

{% tab title="400: Validation Error Response " %}

```json
{
    "success": false,
    "code": 400,
    "message": "Only PDF files are allowed",
    "error": {
        "message": "Invalid file type",
        "field": "file",
        "code": "BAD_REQUEST"
    }
}
```

{% endtab %}

{% tab title="200: Failure Response" %}

```json
{
    "success": true,
    "code": 200,
    "message": "The request could not be completed due to an error.",
    "reference_id": "3c94fbf2-1dd0-4d8b-ac9b-d0cccfb1d02a",
    "status": "failed",
    "error": {
        "message": "Invalid details were provided. Please submit valid details.",
        "code": "ERROR"
    },
    "requested_at": "2024-04-22T05:34:58.477Z",
    "completed_at": "2024-04-22T05:35:06.000Z"
}
```

{% endtab %}
{% endtabs %}

#### Check Document Status

## &#x20;Get document details

<mark style="color:blue;">`GET`</mark> `https://secctrl.tutelar.io/api/v1/kyc/banking/analyse_bank_statement`

### Query parameters description is given below,

<table><thead><tr><th width="197">Query Parameter </th><th width="139">Type</th><th>Is  Mandatory</th><th>Description</th></tr></thead><tbody><tr><td>reference_id </td><td>String </td><td>Yes </td><td>Document reference id</td></tr></tbody></table>

{% tabs %}
{% tab title="200: Success Response" %}

```json

{
    "success": true,
    "code": 200,
    "message": "The request has been successfully completed.",
    "reference_id": "c20ad4c9-1556-450f-98c7-db8013101f5c",
    "status": "completed",
    "result": {
        "account_name": "MR. ANUP DUBEY",
        "account_number": "50100158077633",
        "ifsc_code": "HDFC0001116",
        "account_type": "Savings Account",
        "bank_name": "HDFC Bank",
        "report_start_date": "2018-06-01",
        "report_end_date": "2018-10-10",
        "statement_analyse_status": "Report analysis have been completed successfully.",
        "report_download_url": "Download Url Presents here."
    },
    "requested_at": "2025-08-13T06:09:37.041Z",
    "completed_at": "2025-08-13T06:09:37.504Z"
}
```

{% endtab %}

{% tab title="200: InProgress Response" %}

```json
{
    "success": true,
    "code": 200,
    "message": "The request is being processed. Please wait for completion.",
    "reference_id": "9888eb23-135e-45de-bb25-fb4cfe6ab6a2",
    "status": "in_progress",
    "result": {
        "account_name": "MR. ANUP DUBEY",
        "account_number": "50100158077633",
        "ifsc_code": "HDFC0001116",
        "account_type": "Savings Account",
        "bank_name": "HDFC Bank",
        "report_start_date": "2018-06-01",
        "report_end_date": "2018-10-10",
        "statement_analyse_status": "The Bank statement analysis is in progress. Please check after sometime!",
        "report_download_url": ""
    },
    "requested_at": "2025-08-13T09:52:33.797Z"
}

```

{% endtab %}

{% tab title="200: Failure Response" %}

```json
{
    "success": true,
    "code": 200,
    "message": "The request could not be completed due to an error.",
    "reference_id": "3c94fbf2-1dd0-4d8b-ac9b-d0cccfb1d02a",
    "status": "failed",
    "error": {
        "message": "Invalid details were provided. Please submit valid details.",
        "code": "ERROR"
    },
    "requested_at": "2024-04-22T05:34:58.477Z",
    "completed_at": "2024-04-22T05:35:06.000Z"
}
```

{% endtab %}
{% endtabs %}