> 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/tutelar-api-document-v2/kyc-verification/document-extraction/india/gst-certificate-ocr.md).

# GST Certificate OCR

Extraction of details from image of a GST Certificate in real-time

##  ind\_gst\_ocr

<mark style="color:green;">`POST`</mark> `https://secctrl.tutelar.io/api/v2/kyc/vision/ind_gst_ocr`

### Header

| Name          | Value                     |
| ------------- | ------------------------- |
| Content-Type  | `application/json`        |
| Authorization | `Bearer eyJhbGciOiJ.....` |

### 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>front_side </td><td>String </td><td>Yes </td><td>Image Url</td></tr><tr><td>back_side</td><td>String</td><td>No</td><td>Image Url</td></tr></tbody></table>

#### Sample Post Parameters

```json
{
    "front_side": "Base64 or Url",
    "back_side": "Base64 or Url"
}
```

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

```json
{
    "success": true,
    "code": 200,
    "message": "The request has been successfully completed.",
    "reference_id": "86cedb68-50de-4fc1-8a83-af845c1db90c",
    "status": "completed",
    "result": {
        "gstin": "08AAICD6833H1ZG",
        "address": "Private Limited Company G-2, D-115, SHEETAL RESIDENCY, MANGALAM CITY, HATHOJ, Jaipur, Rajasthan, 302012",
        "constitution_of_business": "Private Limited Company",
        "date_of_liability": null,
        "legal_name": "DISCOUNT MART PRIVATE LIMITED",
        "pan_number": "",
        "trade_name": "DISCOUNT MART PRIVATE LIMITED",
        "type_of_registration": "Regular",
        "valid_upto": "NA",
        "valid_from": "NotApplicable"
    },
    "requested_at": "2024-04-22T06:40:53.442Z",
    "completed_at": "2024-04-22T06:40:55.334Z"
}
```

{% endtab %}

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

```json
{
    "success": true,
    "code": 200,
    "message": "The request is being processed. Please wait for completion.",
    "reference_id": "2fd4c21f-478d-4e52-bdc1-87ac29cdb300",
    "status": "in_progress",
    "requested_at": "2024-04-22T06:15:03.375Z"
}
```

{% endtab %}

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

```json
{
    "success": false,
    "code": 400,
    "message": "Invalid input. Please check your request and try again.",
    "error": {
        "message": "Upload the front image of Aadhar card",
        "field": "front_side",
        "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": "417ae0c7-e241-4857-badb-b2f9cf90eaeb",
    "status": "failed",
    "error": {
        "message": "invalid GST image",
        "code": "ERROR"
    },
    "requested_at": "2024-04-22T06:31:04.841Z",
    "completed_at": "2024-04-22T06:31:06.479Z"
}
```

{% endtab %}
{% endtabs %}

#### Check Document Status

## Get document details

<mark style="color:blue;">`GET`</mark> `https://secctrl.tutelar.io/api/v2/kyc/vision/ind_voter_id_ocr`

### 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": "86cedb68-50de-4fc1-8a83-af845c1db90c",
    "status": "completed",
    "result": {
        "gstin": "08AAICD6833H1ZG",
        "address": "Private Limited Company G-2, D-115, SHEETAL RESIDENCY, MANGALAM CITY, HATHOJ, Jaipur, Rajasthan, 302012",
        "constitution_of_business": "Private Limited Company",
        "date_of_liability": null,
        "legal_name": "DISCOUNT MART PRIVATE LIMITED",
        "pan_number": "",
        "trade_name": "DISCOUNT MART PRIVATE LIMITED",
        "type_of_registration": "Regular",
        "valid_upto": "NA",
        "valid_from": "NotApplicable"
    },
    "requested_at": "2024-04-22T06:40:53.442Z",
    "completed_at": "2024-04-22T06:40:55.334Z"
}
```

{% endtab %}

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

```json
{
    "success": true,
    "code": 200,
    "message": "The request is being processed. Please wait for completion.",
    "reference_id": "2fd4c21f-478d-4e52-bdc1-87ac29cdb300",
    "status": "in_progress",
    "requested_at": "2024-04-22T06:15:03.375Z"
}
```

{% endtab %}

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

```json
{
    "success": true,
    "code": 200,
    "message": "The request could not be completed due to an error.",
    "reference_id": "417ae0c7-e241-4857-badb-b2f9cf90eaeb",
    "status": "failed",
    "error": {
        "message": "invalid GST image",
        "code": "ERROR"
    },
    "requested_at": "2024-04-22T06:31:04.841Z",
    "completed_at": "2024-04-22T06:31:06.479Z"
}
```

{% endtab %}
{% endtabs %}