Indian ID Classification

Introduction

You need to upload an image of an Indian ID card and the optional boolean value of side. This API will respond with the ID type, the side of the ID card also the Color profile of that ID card. You may put direct URLs to ID cards, in case you have them.

API details

Endpoint

POST https://api.signzy.app/api/v3/indianid/classification

POST https://api-preproduction.signzy.app/api/v3/indianid/classification

Request Headers

Name	Value	Required	Description
Content-Type	application/json	Mandatory	The type of content that the request body contains.
Authorization	XXXXXXXXXXXXXXX	Mandatory	An authentication token to authorize the request. Reach out to the Signzy support team to get one created.

Request body parameters

Parameter	Data Type	Description	Required
img_url	str	image url	yes

{
    "img_url": "https://domain/...hosted_image.../image.jpg"
}

Code samples

curl --location 'https://api.signzy.app/api/v3/indianid/classification' \
--header 'Content-Type: application/json' \
--header 'Authorization: xxxxxxxxxxxxxxxxx' \
--data '{
    "img_url": "https://domain/...hosted_image.../image.jpg"
}'

Response body parameters

Parameter	Data Type	Description
result.colorProfile	string	Whether the uploaded ID card is in Color or Black and white profile. The possible values are "COLOR" or "B&W".
result.id_type	string	Type of identity card for eg: aadhaar/individualPan/businessPan/passport/dl/voterId/cheque/unknown
result.msg	string	Provides a proper message for eg: If provided all info is correct it shows a Success message, If the URL is not correct it will show URL is not valid
result.status	string	Status Code

{
    "result": {
        "colorProfile": "COLOR",
        "id_type": "passport",
        "msg": "success",
        "status": "200"
    }
}

The size of the document should not exceed 5 MB.

For best results, ensure the image you use fits tightly in the camera view and horizontally aligned.

Supported document types:

Image - JPEG, JPG, PNG and TIFF/TIF.

Single-page PDF - In the case of multipage PDF input the API will only consider the first page for classification.

Contact Us for Any Assistance

If you have any questions or need assistance, please reach out to our customer support team. You can contact us via email at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.

We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!