GST Certificate

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

Submit Document

ind_gst_ocr

POST https://secctrl.tutelar.io/api/v1/kyc/vision/ind_gst_ocr

Post parameters description is given below,

Post Parameter	Type	Is Mandatory	Description
front_side	String	Yes	Image Url
back_side	String	No	Image Url

Sample Post Parameters

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

200: Success Response

{
    "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"
}

200: InProgress Response

{
    "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"
}

400: Validation Error Response

{
    "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"
    }
}

200: Failure Response

{
    "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"
}

Check Document Status

Get document details

GET https://secctrl.tutelar.io/api/v1/kyc/vision/ind_voter_id_ocr

Query parameters description is given below,

Query Parameter	Type	Is Mandatory	Description
reference_id	String	Yes	Document reference id

200: Success Response

{
    "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"
}

200: InProgress Response

{
    "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"
}

200: Failure Response

{
    "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"
}