# Patta Consolidate

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

## POST `https://secctrl.tutelar.io/api/v1/kyc/utility/patta_consolidate`

### Post parameters for description is given below

| Post Parameter   | Type   |              Is Mandatory | Description                                                 |
| ---------------- | ------ | ------------------------: | ----------------------------------------------------------- |
| `search_type`    | String |                       Yes | Accepted value: fileUpload , manual                         |
| `patta_file_url` | String | Yes (Only for fileUpload) | Uploaded Patta document URL only for search type fileUpload |
| `patta_no`       | String |     Yes (Only for manual) | District name                                               |
| `village_name`   | String |     Yes (Only for manual) | Taluk name                                                  |
| `taluk_name`     | String |     Yes (Only for manual) | Village name                                                |
| `district_name`  | String |     Yes (Only for manual) | Patta number                                                |
| `subdiv_no`      | String |                        No | Subdivision number                                          |

### 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"
}
```

### 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"
}
```

### 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"
}
```

### 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"
    }
}
```

### 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": "The source system is experiencing down time.",
        "code": "SOURCE_DOWN"
    },
    "requested_at": "2026-04-30T10:07:02.417Z",
    "completed_at": "2026-04-30T10:07:02.788Z"
}
```

## Check Document Status

## GET `https://secctrl.tutelar.io/api/v1/kyc/utility/patta_consolidate`

### Query parameters description is given below

| Query Parameter | Type   | Is Mandatory | Description           |
| --------------- | ------ | -----------: | --------------------- |
| `reference_id`  | String |          Yes | Document reference id |

### 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"
}
```

### 200: Partially Completed

```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": "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"
}
```

### 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"
}
```

### 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"
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.v2.tutelar.io/patta-consolidate.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
