API docs for old integrations

DL verification V2

Introduction
The Driving License Verification API is a RESTful API provided by Signzy Technologies Private Limited that enables businesses to verify the authenticity of a driving license. This API allows you to send a request with the driving license number, date of birth, and issue date (optional), and it returns a response with the verification status, a message indicating the outcome of the verification process, and additional information such as the issue date, expiry date, and vehicle class.
By integrating the Driving License Verification API into your workflow, you can ensure that your customers' driving licenses are valid and prevent fraud or misrepresentation. This API can be used in a variety of industries such as transportation, finance, and insurance. The API provides a reliable and efficient solution for verifying driving licenses, helping you to reduce manual effort and improve your customer experience.
Use Cases
The Driving License Verification API can be used in a variety of scenarios where it is essential to verify the authenticity of a driving license. Here are some examples of how the API can be used:
Transportation Industry: Ride-hailing companies can use the API to verify the driving licenses of their drivers before onboarding them onto their platform. This helps to ensure that the drivers have valid licenses and are legally authorized to drive.
Finance Industry: Banks and financial institutions can use the API to verify the driving licenses of their customers before providing them with vehicle loans. This helps to mitigate the risk of loan default by ensuring that the customers have valid licenses and can legally operate a vehicle.
Insurance Industry: Insurance companies can use the API to verify the driving licenses of their policyholders before issuing insurance policies. This helps to reduce the risk of fraudulent claims and ensures that the policyholders have valid licenses and can legally operate a vehicle.
Regulatory Compliance: Government agencies can use the API to verify the driving licenses of individuals for regulatory compliance purposes. This helps to ensure that individuals have valid licenses and are legally authorized to operate a vehicle.
By leveraging the Driving License Verification API, businesses and organizations can streamline their operations, reduce manual effort, and improve the accuracy and efficiency of their driving license verification process.
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
blank
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": "verification",
    "accessToken": "<..access-token-from-the-Identity-Object-request..>",
    "essentials": {
        "number": "<Driving-Licence-Number>",
        "dob": "<Date of Birth>", // format dd/mm/yyyy
        "issueDate": "<Issue-Date>" // format dd/mm/yyyy}
    }
}
{
    "service": "Identity",
    "itemId": "<..itemId-from-the-Identity-Object-request....>",
    "task": "verification",
    "accessToken": "<..access-token-from-the-Identity-Object-request..>",
    "essentials": {
        "number": "<Driving-Licence-Number>",
        "dob": "<Date of Birth>", // format dd/mm/yyyy
        "issueDate": "<Issue-Date>" // format dd/mm/yyyy}
    }
}
﻿
Parameter
Type
Required
Description
task
string
Yes
The task to be performed by the API. For the driving license verification, the value should be "verification".
essentials
object
Yes
The essential details of the driving license that you want to verify. This should include the driving license number, date of birth, and issue date (if available).
Response
JSON
{
    "service": "Identity",
    "itemId": "..item Id..",
    "task": "verification",
    "essentials": {},
    "accessToken": "...accessToken...",
    "id": "...id...",
    "response": {
        "files": [
            "...image url..."
        ],
        "id": 537,
        "instance": {
            "id": "...id...",
            "callbackUrl": "...callback url..."
        },
        "result": {
            "verified": true,
            "message": "Driving licence verification process completed successfully with positive result.",
            "moreInfo": {
                "issueDate": "...issueDate(Month DD,YYYY)...",
                "expiryDate": "...expiryDate(Month DD, YYYY)...",
                "vehicleClass": [
                    "...vehicleClass..."
                ]
            }
        }
    }
}
{
    "service": "Identity",
    "itemId": "..item Id..",
    "task": "verification",
    "essentials": {},
    "accessToken": "...accessToken...",
    "id": "...id...",
    "response": {
        "files": [
            "...image url..."
        ],
        "id": 537,
        "instance": {
            "id": "...id...",
            "callbackUrl": "...callback url..."
        },
        "result": {
            "verified": true,
            "message": "Driving licence verification process completed successfully with positive result.",
            "moreInfo": {
                "issueDate": "...issueDate(Month DD,YYYY)...",
                "expiryDate": "...expiryDate(Month DD, YYYY)...",
                "vehicleClass": [
                    "...vehicleClass..."
                ]
            }
        }
    }
}
﻿
Details of the response properties
Property
Example Value
Description
verified
true
A boolean value indicating whether the driving license was successfully verified.
message
"Driving licence verification..."
A message indicating the result of the driving license verification process.
moreInfo
{"issueDate": "Jul 19, 2011",...}
An object containing additional information about the driving license. This object will be empty if the license could not be verified.
moreInfo.issueDate
"Jul 19, 2011"
A string representing the date on which the driving license was issued in MMM DD, YYYY format. This value will be empty if the driving license could not be verified or if the issue date is not available.
moreInfo.expiryDate
"Jul 18, 2031"
A string representing the date on which the driving license will expire in MMM DD, YYYY format. This value will be empty if the driving license could not be verified.
moreInfo.vehicleClass
["LMV "]
An array of strings representing the types of vehicles that the license holder is authorized to drive. This value will be empty if the driving license could not be verified. Note that there may be whitespace characters at the end of each string.
Error Codes
Error Code
Description
400
Bad Request - The request was invalid or could not be understood by the server. This could be due to missing or invalid parameters.
401
Unauthorized - The request requires authentication or the provided authentication credentials are invalid.
403
Forbidden - The server understood the request, but is refusing to fulfill it due to access control restrictions or because the user has exceeded limits.
404
Not Found - The requested resource could not be found.
429
Too Many Requests - The user has sent too many requests in a given amount of time.
500
Internal Server Error - The server encountered an unexpected condition that prevented it from fulfilling the request.
Troubleshooting
Issue
Possible Cause
Troubleshooting
Invalid Driving License Number
The provided driving license number is invalid or incorrect.
Double-check the driving license number and make sure that it is entered correctly.
Incorrect Date of Birth
The provided date of birth is incorrect or in an invalid format.
Make sure that the date of birth is entered in the correct format (e.g., DD/MM/YYYY) and that it is a valid date.
Missing Issue Date
The issue date of the driving license is not provided.
Make sure that the issue date of the driving license is provided in the request body.
Invalid Authorization Token
The provided authorization token is invalid or has expired.
Check if the authorization token is still valid and if it is entered correctly.
Server Error
The server encountered an unexpected error while processing the request.
Check if the server is running and if there are any known issues that could be causing the error. Try resending the request after some time.
﻿

Passport verification V2

Search based on DL number V2

Docs powered by Archbee

TABLE OF CONTENTS

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	blank	List	COMPULSORY

Parameter	Type	Required	Description
task	string	Yes	The task to be performed by the API. For the driving license verification, the value should be "verification".
essentials	object	Yes	The essential details of the driving license that you want to verify. This should include the driving license number, date of birth, and issue date (if available).

Property	Example Value	Description
verified	true	A boolean value indicating whether the driving license was successfully verified.
message	"Driving licence verification..."	A message indicating the result of the driving license verification process.
moreInfo	{"issueDate": "Jul 19, 2011",...}	An object containing additional information about the driving license. This object will be empty if the license could not be verified.
moreInfo.issueDate	"Jul 19, 2011"	A string representing the date on which the driving license was issued in MMM DD, YYYY format. This value will be empty if the driving license could not be verified or if the issue date is not available.
moreInfo.expiryDate	"Jul 18, 2031"	A string representing the date on which the driving license will expire in MMM DD, YYYY format. This value will be empty if the driving license could not be verified.
moreInfo.vehicleClass	["LMV "]	An array of strings representing the types of vehicles that the license holder is authorized to drive. This value will be empty if the driving license could not be verified. Note that there may be whitespace characters at the end of each string.

Error Code	Description
400	Bad Request - The request was invalid or could not be understood by the server. This could be due to missing or invalid parameters.
401	Unauthorized - The request requires authentication or the provided authentication credentials are invalid.
403	Forbidden - The server understood the request, but is refusing to fulfill it due to access control restrictions or because the user has exceeded limits.
404	Not Found - The requested resource could not be found.
429	Too Many Requests - The user has sent too many requests in a given amount of time.
500	Internal Server Error - The server encountered an unexpected condition that prevented it from fulfilling the request.

Issue	Possible Cause	Troubleshooting
Invalid Driving License Number	The provided driving license number is invalid or incorrect.	Double-check the driving license number and make sure that it is entered correctly.
Incorrect Date of Birth	The provided date of birth is incorrect or in an invalid format.	Make sure that the date of birth is entered in the correct format (e.g., DD/MM/YYYY) and that it is a valid date.
Missing Issue Date	The issue date of the driving license is not provided.	Make sure that the issue date of the driving license is provided in the request body.
Invalid Authorization Token	The provided authorization token is invalid or has expired.	Check if the authorization token is still valid and if it is entered correctly.
Server Error	The server encountered an unexpected error while processing the request.	Check if the server is running and if there are any known issues that could be causing the error. Try resending the request after some time.