> For the complete documentation index, see [llms.txt](https://docs.tutelar.io/tutelar-api-document/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tutelar.io/tutelar-api-document/kyc-verification/document-verification/india/patta-consolidate.md).

# Patta Consolidate

The Patta Consolidated API returns Pata, EC, and FMBI details separately, along with their respective files

## patta\_consolidate

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

### Post parameters For  description is given below,

<table><thead><tr><th width="197.12109375">Post Parameter </th><th width="139">Type</th><th width="212.17578125">Is  Mandatory</th><th>Description</th></tr></thead><tbody><tr><td>search_type </td><td>String </td><td>Yes </td><td>Accepted value: fileUpload , manual</td></tr><tr><td>patta_file_url</td><td>String</td><td>Yes (Only for fileUpload) </td><td>Uploaded Patta document URL only for search type fileUpload</td></tr><tr><td>patta_no</td><td>String</td><td>Yes (Only for manual)</td><td>District name</td></tr><tr><td>village_name</td><td>String</td><td>Yes (Only for manual)</td><td>Taluk name</td></tr><tr><td>taluk_name</td><td>String</td><td>Yes (Only for manual)</td><td>Village name</td></tr><tr><td>district_name</td><td>String</td><td>Yes (Only for manual)</td><td>Patta number</td></tr><tr><td>subdiv_no</td><td>String</td><td>No</td><td>Subdivision number</td></tr></tbody></table>

#### Sample Post Parameter - File Upload Mode

```json
{
  "search_type": "fileUpload",
  "patta_file_url": "https://example.com/sample.pdf"
}
```

#### Sample Post Parameter - Manual Search Mode

```json
{
  "search_type": "manual",
  "district_name": "Kanchipuram",
  "taluk_name": "Kundrathur",
  "village_name": "Padappai",
  "patta_no": "660773",
  "subdiv_no": "41014"
}
```

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

```json
{
    "success": true,
    "code": 200,
    "message": "The request has been partially completed. Some tasks have either failed or are still pending.",
    "reference_id": "005d1731-85dd-4ad5-b8ff-eb67a7d2e42d",
    "status": "completed",
    "result": {
        "overall_status": "completed",
        "cumulative_risk_status": "LOW",
        "cumulative_risk_score": 55,
        "workflow_type": "pdf",
        "patta": {
            "status": "completed",
            "pattaDetails": {
                "extraction_timestamp": "2026-02-11T05:47:34.870724Z",
                "source": "government_pdf",
                "district": "தேனி",
                "taluk": "உத்தமபாளையம்",
                "village": "ஓடைப்பட்டி",
                "patta": 5218,
                "holder_name": "பாண்டியன்",
                "relationship": "மகள்",
                "nominee_name": "நிவே தாபாண்டியன்",
                "datetime_reg_date": "27-02-2020",
                "datetime_name": "Udayarani P",
                "datetime_reg_time": "05:45:03 PM",
                "datetime_desg_name": "Tahsildar"
            },
            "patta_file_url": "http://0.000.000.000:0000:8000/image-pub/kyc/TUTWEBK00341/PataDocuments/Pata_file_1777544307487-1777544307657.pdf",
            "risk_score": 33,
            "risk_status": "HIGH"
        },
        "ec": {
            "status": "completed",
            "risk_score": 33,
            "risk_status": "LOW",
            "ec_file_url": "http://0.000.000.000:0000/image-pub/kyc/TUTWEBK00341/EcDocuments/ec_file_1777544307487-1777544307657.pdf",
            "sub_registrar_office": "படப்பை",
            "date": "30-Apr-2026",
            "village": "படப்பை",
            "survey_details": "410/14"
        },
        "fmbi": {
            "status": "completed",
            "risk_score": 0,
            "risk_status": "LOW",
            "fmbi_file_url": "http://0.000.000.000:0000:8000/image-pub/kyc/TUTWEBK00341/FmbiDocuments/fmbi_file_1777544307745-1777544307823.pdf",
            "fmb_sketch_present": true,
            "district": "Kancheepuram",
            "taluk": "Kundrathur",
            "village": "Patapai(R)",
            "survey_number": "410/14",
            "area": "Hect 00 Ares 0 Sqm 94",
            "area_ha": 0.0094,
            "area_display": "0.94 Ares",
            "scale": "1: 160mm",
            "approved_by": "Tahsildar",
            "date_of_issue": "30-04-2026"
        }
    },
    "requested_at": "2026-04-30T10:16:21.847Z"
}
```

{% endtab %}

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

```json
{
    "success": true,
    "code": 200,
    "message": "The request is being processed. Please wait for completion.",
    "reference_id": "c3d101d4-c9ec-48df-a25f-60354ec78c78",
    "status": "in_progress",
    "requested_at": "2024-04-22T04:47:39.590Z"
}
```

{% endtab %}

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

```json
{
    "success": false,
    "code": 400,
    "message": "searchType must be either fileUpload or manual",
    "error": {
        "message": "searchType must be either fileUpload or manual",
        "field": "search_type",
        "code": "BAD_REQUEST"
    }
}
{
    "success": false,
    "code": 400,
    "message": "Patta file url is required for fileUpload",
    "error": {
        "message": "Patta file url is required for fileUpload",
        "field": "patta_file_url",
        "code": "BAD_REQUEST"
    }
}
{
    "success": false,
    "code": 400,
    "message": "district_name is required",
    "error": {
        "message": "district_name is required",
        "field": "district_name",
        "code": "BAD_REQUEST"
    }
}
{
    "success": false,
    "code": 400,
    "message": "taluk_name is required",
    "error": {
        "message": "taluk_name is required",
        "field": "taluk_name",
        "code": "BAD_REQUEST"
    }
}
{
    "success": false,
    "code": 400,
    "message": "village_name is required",
    "error": {
        "message": "village_name is required",
        "field": "village_name",
        "code": "BAD_REQUEST"
    }
}
{
    "success": false,
    "code": 400,
    "message": "patta_no is required",
    "error": {
        "message": "patta_no is required",
        "field": "patta_no",
        "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": "e7c76ebf-a3f5-42b5-817f-ef9fc7bf1657",
    "status": "failed",
    "error": {
        "message": "Invalid details were provided. Please submit valid details.",
        "code": "ERROR"
    },
    "requested_at": "2026-04-30T10:07:02.417Z",
    "completed_at": "2026-04-30T10:07:02.788Z"
}
```

{% endtab %}
{% endtabs %}

#### Check Document Status

## Get document details

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

### 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 partially completed. Some tasks have either failed or are still pending.",
    "reference_id": "005d1731-85dd-4ad5-b8ff-eb67a7d2e42d",
    "status": "completed",
    "result": {
        "overall_status": "completed",
        "cumulative_risk_status": "LOW",
        "cumulative_risk_score": 55,
        "workflow_type": "pdf",
        "patta": {
            "status": "completed",
            "pattaDetails": {
                "extraction_timestamp": "2026-02-11T05:47:34.870724Z",
                "source": "government_pdf",
                "district": "தேனி",
                "taluk": "உத்தமபாளையம்",
                "village": "ஓடைப்பட்டி",
                "patta": 5218,
                "holder_name": "பாண்டியன்",
                "relationship": "மகள்",
                "nominee_name": "நிவே தாபாண்டியன்",
                "datetime_reg_date": "27-02-2020",
                "datetime_name": "Udayarani P",
                "datetime_reg_time": "05:45:03 PM",
                "datetime_desg_name": "Tahsildar"
            },
            "patta_file_url": "http://0.000.000.000:0000:8000/image-pub/kyc/TUTWEBK00341/PataDocuments/Pata_file_1777544307487-1777544307657.pdf",
            "risk_score": 33,
            "risk_status": "HIGH"
        },
        "ec": {
            "status": "completed",
            "risk_score": 33,
            "risk_status": "LOW",
            "ec_file_url": "http://0.000.000.000:0000/image-pub/kyc/TUTWEBK00341/EcDocuments/ec_file_1777544307487-1777544307657.pdf",
            "sub_registrar_office": "படப்பை",
            "date": "30-Apr-2026",
            "village": "படப்பை",
            "survey_details": "410/14"
        },
        "fmbi": {
            "status": "completed",
            "risk_score": 0,
            "risk_status": "LOW",
            "fmbi_file_url": "http://0.000.000.000:0000:8000/image-pub/kyc/TUTWEBK00341/FmbiDocuments/fmbi_file_1777544307745-1777544307823.pdf",
            "fmb_sketch_present": true,
            "district": "Kancheepuram",
            "taluk": "Kundrathur",
            "village": "Patapai(R)",
            "survey_number": "410/14",
            "area": "Hect 00 Ares 0 Sqm 94",
            "area_ha": 0.0094,
            "area_display": "0.94 Ares",
            "scale": "1: 160mm",
            "approved_by": "Tahsildar",
            "date_of_issue": "30-04-2026"
        }
    },
    "requested_at": "2026-04-30T10:16:21.847Z"
}
```

{% endtab %}

{% tab title="200: Partially Completed " %}

```jsonl
{
    "success": true,
    "code": 200,
    "message": "The request has been partially completed. Some tasks have either failed or are still pending.",
    "reference_id": "005d1731-85dd-4ad5-b8ff-eb67a7d2e42d",
    "status": "partially_completed",
    "result": {
        "overall_status": "partial",
        "cumulative_risk_status": 0,
        "cumulative_risk_score": 0,
        "workflow_type": "pdf",
        "patta": {
            "status": "failed",
            "error": "Request failed: HTTPSConnectionPool(host='tngis.tn.gov.in', port=443): Read timed out. (read timeout=60)"
        },
        "ec": {
            "status": "completed",
            "risk_score": 33,
            "risk_status": "LOW",
            "ec_file_url": "http://0.000.000.000:0000:8000/image-pub/kyc/TUTWEBK00341/EcDocuments/ec_file_1777544307487-1777544307657.pdf",
            "sub_registrar_office": "படப்பை",
            "date": "30-Apr-2026",
            "village": "படப்பை",
            "survey_details": "410/14"
        },
        "fmbi": {
            "status": "completed",
            "risk_score": 0,
            "risk_status": "LOW",
            "fmbi_file_url": "http://0.000.000.000:0000:8000/image-pub/kyc/TUTWEBK00341/FmbiDocuments/fmbi_file_1777544307745-1777544307823.pdf",
            "fmb_sketch_present": true,
            "district": "Kancheepuram",
            "taluk": "Kundrathur",
            "village": "Patapai(R)",
            "survey_number": "410/14",
            "area": "Hect 00 Ares 0 Sqm 94",
            "area_ha": 0.0094,
            "area_display": "0.94 Ares",
            "scale": "1: 160mm",
            "approved_by": "Tahsildar",
            "date_of_issue": "30-04-2026"
        }
    },
    "requested_at": "2026-04-30T10:16:21.847Z"
}
```

{% endtab %}

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

```json
{
    "success": true,
    "code": 200,
    "message": "The request is being processed. Please wait for completion.",
    "reference_id": "005d1731-85dd-4ad5-b8ff-eb67a7d2e42d",
    "status": "in_progress",
    "requested_at": "2026-04-30T10:16:21.847Z"
}
```

{% endtab %}

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

```json
{
    "success": true,
    "code": 200,
    "message": "The request could not be completed due to an error.",
    "reference_id": "7b2e98d5-b855-496a-8b07-c39f097dd3a9",
    "status": "failed",
    "error": {
        "message": "Invalid details were provided. Please submit valid details.",
        "code": "ERROR"
    },
    "requested_at": "2026-04-30T10:21:27.050Z"
}
```

{% endtab %}
{% endtabs %}