API docs for old integrations

Search based on DL number V2

Introduction
The Driving License Verification API provides a simple and secure way to verify driving license details of individuals in India. With this API, you can easily integrate driving license verification functionality into your application or service. The API accepts a valid driving license number and date of birth as input, and returns the corresponding details of the driving license holder, including their name, father or husband's name, address, photograph, class of vehicle authorized to drive, validity period, and more. This API is useful for businesses or organizations that need to verify the driving license details of individuals for various purposes, such as hiring, background checks, and insurance.
Use Cases
This API can be used to verify the authenticity and details of a driving license issued by the Indian government. The API provides information such as the driving license number, the date of birth, the validity period of the license, and details of the license holder such as their name, address, and photograph. The API can be used by any organization that needs to verify a person's driving license information, such as insurance companies, car rental agencies, or employers.
By using this API, organizations can ensure that the person they are dealing with has a valid driving license and that the license details provided to them are genuine. This can help reduce the risk of fraud and increase trust between the organization and the person holding the driving license. Additionally, it can save time and resources as the organization can quickly and easily verify the license details without having to manually check the license or rely on paper-based documents.
API Endpoint's
Identity Object
UAT Endpoint
POST https://preproduction.signzy.tech/api/v2/patrons/<patron-id>/identities
POST https://preproduction.signzy.tech/api/v2/patrons/<patron-id>/identities
﻿
Production Endpoint
POST https://signzy.tech/api/v2/patrons/<patron-id>/identities
POST https://signzy.tech/api/v2/patrons/<patron-id>/identities
﻿
Headers
Key
Value
Authorization
access token (returned as id field of login request)
Content-type
application/json
Request Data
JSON
{
    "type": "drivingLicence",
    "email": "[email protected]",
    "callbackUrl": "https://your-domain.com/your-callback-system",
    "images": [
    ]
}
{
    "type": "drivingLicence",
    "email": "admin@signzy.com",
    "callbackUrl": "https://your-domain.com/your-callback-system",
    "images": [
    ]
}
﻿
PARAMETERS
DESCRIPTION
TYPE
VALUE (COMPULSORY OR OPTIONAL)
type
Supported type parameter for creation of Identity objects
individualPan
businessPan
aadhaar
passport
drivingLicence
cheque
voterid
String
COMPULSORY
email
E-mail can't be empty
String
COMPULSORY
callbackUrl
callbackUrl is where the data is posted on each activity performed on this Identity object.
String
COMPULSORY
images
urls's to be extracted
List
COMPULSORY
Response
JSON
{
              "type": "drivingLicence",
              "email": "[email protected]",
              "callbackUrl": "https://your-domain.com/your-callback-system",
              "images": [
                
              ],
              "autoRecognition": [],
              "verification": [],
              "forgeryCheck": [],
              "accessToken": "..access-token-for-the-snoop-request..",
              "id": "..itemId-for-the-snoop-request....",
              "patronId": "..your-id-into-signzy-system-(userId-returned-from-the-login-call).."
            }

{
              "type": "drivingLicence",
              "email": "admin@signzy.com",
              "callbackUrl": "https://your-domain.com/your-callback-system",
              "images": [
                
              ],
              "autoRecognition": [],
              "verification": [],
              "forgeryCheck": [],
              "accessToken": "..access-token-for-the-snoop-request..",
              "id": "..itemId-for-the-snoop-request....",
              "patronId": "..your-id-into-signzy-system-(userId-returned-from-the-login-call).."
            }
﻿
﻿
Snoops
UAT Endpoint
POST https://preproduction.signzy.tech/api/v2/snoops
POST https://preproduction.signzy.tech/api/v2/snoops
﻿
Production Endpoint
POST https://signzy.tech/api/v2/snoops
POST https://signzy.tech/api/v2/snoops
﻿
Headers
Key
Value
Authorization
access token (returned as id field of login request)
Content-type
application/json
Request Data
JSON
{
    "service": "Identity",
    "itemId": "<..itemId-from-the-Identity-Object-request....>",
    "task": "fetch",
    "accessToken": "<..access-token-from-the-Identity-Object-request..>",
    "essentials": {
        "number": "...number...",
        "dob": "...dob..."
    }
}
{
    "service": "Identity",
    "itemId": "<..itemId-from-the-Identity-Object-request....>",
    "task": "fetch",
    "accessToken": "<..access-token-from-the-Identity-Object-request..>",
    "essentials": {
        "number": "...number...",
        "dob": "...dob..."
    }
}
﻿
Details of the request properties
Field
Type
Required
Description
service
string
Yes
The name of the service.
itemId
string
Yes
The ID of the item.
accessToken
string
Yes
The access token required to authenticate the request.
task
string
Yes
The task to be performed.
dob
string
No
The date of birth of the person associated with the ID number.
number
string
Yes
The DL ID number of the person.
Response
JSON
{
    "service": "Identity",
    "itemId": "..item Id..",
    "task": "fetch",
    "essentials": {},
    "accessToken": "...accessToken...",
    "id": "...id...",
    "response": {
        "files": [
            "...image url..."
        ],
        "id": 537,
        "instance": {
            "id": "...id...",
            "callbackUrl": "...callback url..."
        },
        "result": {
            "dlNumber": "...dlNumber...",
            "dob": "...dob...",
            "badgeDetails": [
                {
                    "badgeIssueDate": "...badgeDetails...",
                    "badgeNo": "...badgeNo...",
                    "classOfVehicle": [
                        "...classOfVehicle..."
                    ]
                }
            ],
            "dlValidity": {
                "nonTransport": {
                    "to": "...to...",
                    "from": "...from..."
                },
                "hazardousValidTill": "...hazardousValidTill...",
                "transport": {
                    "to": "...to...",
                    "from": "...from..."
                },
                "hillValidTill": "...hillValidTill..."
            },
            "detailsOfDrivingLicence": {
                "dateOfIssue": "...dateOfIssue...",
                "dateOfLastTransaction": "...dateOfLastTransaction...",
                "status": "...status...",
                "lastTransactedAt": "...lastTransactedAt...",
                "name": "...name...",
                "fatherOrHusbandName": "...fatherOrHusbandName...",
                "address": "...address...",
                "addressList": [
                    {
                        "completeAddress": "...completeAddress...",
                        "type": "...type...",
                        "splitAddress": {
                            "district": [],
                            "state": [
                                []
                            ],
                            "city": [],
                            "pincode": "...pincode...",
                            "country": [
                                "IN",
                                "IND",
                                "INDIA"
                            ],
                            "addressLine": "...addressLine..."
                        }
                    }
                ],
                "photo": "...photo...",
                "splitAddress": {
                    "state": [
                        []
                    ],
                    "district": [],
                    "city": [],
                    "pincode": "...pincode...",
                    "country": [
                        "IN",
                        "IND",
                        "INDIA"
                    ],
                    "addressLine": "...addressLine..."
                },
                "covDetails": [
                    {
                        "covCategory": "...covCategory...",
                        "classOfVehicle": "...classOfVehicle...",
                        "covIssuedate": "...covIssuedate..."
                    }
                ]
            }
        }
    }
}h
{
    "service": "Identity",
    "itemId": "..item Id..",
    "task": "fetch",
    "essentials": {},
    "accessToken": "...accessToken...",
    "id": "...id...",
    "response": {
        "files": [
            "...image url..."
        ],
        "id": 537,
        "instance": {
            "id": "...id...",
            "callbackUrl": "...callback url..."
        },
        "result": {
            "dlNumber": "...dlNumber...",
            "dob": "...dob...",
            "badgeDetails": [
                {
                    "badgeIssueDate": "...badgeDetails...",
                    "badgeNo": "...badgeNo...",
                    "classOfVehicle": [
                        "...classOfVehicle..."
                    ]
                }
            ],
            "dlValidity": {
                "nonTransport": {
                    "to": "...to...",
                    "from": "...from..."
                },
                "hazardousValidTill": "...hazardousValidTill...",
                "transport": {
                    "to": "...to...",
                    "from": "...from..."
                },
                "hillValidTill": "...hillValidTill..."
            },
            "detailsOfDrivingLicence": {
                "dateOfIssue": "...dateOfIssue...",
                "dateOfLastTransaction": "...dateOfLastTransaction...",
                "status": "...status...",
                "lastTransactedAt": "...lastTransactedAt...",
                "name": "...name...",
                "fatherOrHusbandName": "...fatherOrHusbandName...",
                "address": "...address...",
                "addressList": [
                    {
                        "completeAddress": "...completeAddress...",
                        "type": "...type...",
                        "splitAddress": {
                            "district": [],
                            "state": [
                                []
                            ],
                            "city": [],
                            "pincode": "...pincode...",
                            "country": [
                                "IN",
                                "IND",
                                "INDIA"
                            ],
                            "addressLine": "...addressLine..."
                        }
                    }
                ],
                "photo": "...photo...",
                "splitAddress": {
                    "state": [
                        []
                    ],
                    "district": [],
                    "city": [],
                    "pincode": "...pincode...",
                    "country": [
                        "IN",
                        "IND",
                        "INDIA"
                    ],
                    "addressLine": "...addressLine..."
                },
                "covDetails": [
                    {
                        "covCategory": "...covCategory...",
                        "classOfVehicle": "...classOfVehicle...",
                        "covIssuedate": "...covIssuedate..."
                    }
                ]
            }
        }
    }
}h
﻿
Details of the response properties
Property
Example Value
Description
dlNumber
WB0120110812345
Driving License number of the user
dob
10/12/1988
Date of birth of the user
badgeDetails
[ {badgeIssueDate:"", badgeNo:"", classOfVehicle:["LMV "] } ]
List of badge details, if any, associated with the driving license. Contains issue date, badge number and class of vehicle details.
dlValidity
{ nonTransport: {to:"18/07/2031", from:"19/07/2011"}, hazardousValidTill:"", transport:{to:"", from:""}, hillValidTill:"" }
Validity details of the driving license for non-transport, hazardous, transport and hill driving. Contains start and end date for non-transport license.
detailsOfDrivingLicence
{ dateOfIssue:"19/07/2011", dateOfLastTransaction:"", status:"", lastTransactedAt:"", name:"XXXXX", fatherOrHusbandName:"XXXX", addressList:[{ completeAddress:"XXXX", type:"permanent", splitAddress:{district:["KOLKATA"], state:[[ "WEST BENGAL", "WB" ]], city:["KOLKATA"], pincode:"700043", country:["IN", "IND", "INDIA"], addressLine:"XXXX"}}, { completeAddress:"XXXX", type:"temporary", splitAddress:{district:["KOLKATA"], state:[[ "WEST BENGAL", "WB" ]], city:["KOLKATA"], pincode:"700043", country:["IN", "IND", "INDIA"], addressLine:"XXXX"} }], address:"XXXX, photo:"", splitAddress:{district:["KOLKATA"], state:[[ "WEST BENGAL", "WB" ]], city:["KOLKATA"], pincode:"700043", country:["IN", "IND", "INDIA"], addressLine:"XXXXX"}, covDetails:[] }
Detailed information about the driving license holder, including personal information, address information, driving license issue details, and photo.
Error Codes
Error Code
Description
400
Bad Request - The request was invalid or malformed. Check the request parameters and try again.
401
Unauthorized - The request requires authentication, but either the credentials provided were invalid or the authentication token has expired. Make sure you have provided valid credentials and try again.
403
Forbidden - The requested resource is not accessible to the current user. Check if you have the necessary permissions to access the resource.
404
Not Found - The requested resource could not be found. Check the resource path and try again.
429
Too Many Requests - The request exceeds the rate limit for the API. Wait for a while before making another request.
500
Internal Server Error - The server encountered an unexpected error. Try again later or contact support.
503
Service Unavailable - The service is currently unavailable. Try again later or contact support.

Troubleshooting
Error
Possible Cause
Possible Solution
400 Bad Request
Missing or invalid required parameters, such as Aadhaar number or DL number.
Check if all required parameters are present and have correct values.
401 Unauthorized
Invalid or missing API key.
Check if the API key is correct and authorized.
403 Forbidden
Request is not allowed for this user or IP address.
Check if the user or IP address has the required permissions.
404 Not Found
Invalid Aadhaar number or DL number.
Check if the Aadhaar number or DL number is valid and correct.
429 Too Many Requests
Exceeding the API rate limit.
Wait for the allowed time or upgrade to a higher plan.
500 Internal Server Error
An error occurred on the server side.
Contact the API provider for assistance.
503 Service Unavailable
The API service is currently unavailable.
Try again later or contact the API provider for assistance.
﻿

DL verification V2

Passport extraction V2

Docs powered by Archbee

TABLE OF CONTENTS

Details of the request properties

Response

Details of the response properties

Error Codes

Troubleshooting

Key	Value
Authorization	access token (returned as id field of login request)
Content-type	application/json

PARAMETERS	DESCRIPTION	TYPE	VALUE (COMPULSORY OR OPTIONAL)
type	Supported type parameter for creation of Identity objects individualPan businessPan aadhaar passport drivingLicence cheque voterid	String	COMPULSORY
email	E-mail can't be empty	String	COMPULSORY
callbackUrl	callbackUrl is where the data is posted on each activity performed on this Identity object.	String	COMPULSORY
images	urls's to be extracted	List	COMPULSORY

Field	Type	Required	Description
service	string	Yes	The name of the service.
itemId	string	Yes	The ID of the item.
accessToken	string	Yes	The access token required to authenticate the request.
task	string	Yes	The task to be performed.
dob	string	No	The date of birth of the person associated with the ID number.
number	string	Yes	The DL ID number of the person.

Property	Example Value	Description
dlNumber	WB0120110812345	Driving License number of the user
dob	10/12/1988	Date of birth of the user
badgeDetails	[ {badgeIssueDate:"", badgeNo:"", classOfVehicle:["LMV "] } ]	List of badge details, if any, associated with the driving license. Contains issue date, badge number and class of vehicle details.
dlValidity	{ nonTransport: {to:"18/07/2031", from:"19/07/2011"}, hazardousValidTill:"", transport:{to:"", from:""}, hillValidTill:"" }	Validity details of the driving license for non-transport, hazardous, transport and hill driving. Contains start and end date for non-transport license.
detailsOfDrivingLicence	{ dateOfIssue:"19/07/2011", dateOfLastTransaction:"", status:"", lastTransactedAt:"", name:"XXXXX", fatherOrHusbandName:"XXXX", addressList:[{ completeAddress:"XXXX", type:"permanent", splitAddress:{district:["KOLKATA"], state:[[ "WEST BENGAL", "WB" ]], city:["KOLKATA"], pincode:"700043", country:["IN", "IND", "INDIA"], addressLine:"XXXX"}}, { completeAddress:"XXXX", type:"temporary", splitAddress:{district:["KOLKATA"], state:[[ "WEST BENGAL", "WB" ]], city:["KOLKATA"], pincode:"700043", country:["IN", "IND", "INDIA"], addressLine:"XXXX"} }], address:"XXXX, photo:"", splitAddress:{district:["KOLKATA"], state:[[ "WEST BENGAL", "WB" ]], city:["KOLKATA"], pincode:"700043", country:["IN", "IND", "INDIA"], addressLine:"XXXXX"}, covDetails:[] }	Detailed information about the driving license holder, including personal information, address information, driving license issue details, and photo.

Error Code	Description
400	Bad Request - The request was invalid or malformed. Check the request parameters and try again.
401	Unauthorized - The request requires authentication, but either the credentials provided were invalid or the authentication token has expired. Make sure you have provided valid credentials and try again.
403	Forbidden - The requested resource is not accessible to the current user. Check if you have the necessary permissions to access the resource.
404	Not Found - The requested resource could not be found. Check the resource path and try again.
429	Too Many Requests - The request exceeds the rate limit for the API. Wait for a while before making another request.
500	Internal Server Error - The server encountered an unexpected error. Try again later or contact support.
503	Service Unavailable - The service is currently unavailable. Try again later or contact support.

Error	Possible Cause	Possible Solution
400 Bad Request	Missing or invalid required parameters, such as Aadhaar number or DL number.	Check if all required parameters are present and have correct values.
401 Unauthorized	Invalid or missing API key.	Check if the API key is correct and authorized.
403 Forbidden	Request is not allowed for this user or IP address.	Check if the user or IP address has the required permissions.
404 Not Found	Invalid Aadhaar number or DL number.	Check if the Aadhaar number or DL number is valid and correct.
429 Too Many Requests	Exceeding the API rate limit.	Wait for the allowed time or upgrade to a higher plan.
500 Internal Server Error	An error occurred on the server side.	Contact the API provider for assistance.
503 Service Unavailable	The API service is currently unavailable.	Try again later or contact the API provider for assistance.