API docs for old integrations

DL Extraction V2

Introduction
The Driving License Extraction API is a RESTful API that allows you to extract relevant information from a driving license image or PDF document. With this API, you can easily extract details such as DL number, issue date, expiry date, name, address, and more from a given image or PDF. The API uses advanced OCR and data extraction algorithms to accurately identify and extract the information from the document. This API is useful for businesses and organizations that need to automate the process of extracting information from driving licenses for various purposes such as KYC, identity verification, and more. With a simple API request, you can get the required information in a structured format, saving time and effort.
Use Cases
Verification of Driving Licenses: This API can be used to verify the authenticity of a driving license by extracting its details and checking them against the official records of the issuing authority. This can be useful for businesses that need to verify the identity and driving credentials of their customers or employees.
Digitization of Driving Licenses: This API can be used to digitize paper-based driving licenses by extracting their details and storing them in a digital format. This can be useful for government agencies that want to modernize their licensing systems and reduce paperwork.
KYC for Financial Services: This API can be used as part of a KYC (Know Your Customer) process for financial services. By verifying the identity and driving credentials of a customer, financial institutions can ensure that they comply with regulatory requirements and reduce the risk of fraud.
API Endpoints
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": [
        "<urls-to-uploaded-files>", "<urls-to-uploaded-files>"
    ]
}
{
    "type": "drivingLicence",
    "email": "admin@signzy.com",
    "callbackUrl": "https://your-domain.com/your-callback-system",
    "images": [
        "<urls-to-uploaded-files>", "<urls-to-uploaded-files>"
    ]
}
﻿
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": [
                "<urls-to-uploaded-files>","<urls-to-uploaded-files>"
              ],
              "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": [
                "<urls-to-uploaded-files>","<urls-to-uploaded-files>"
              ],
              "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":"autoRecognition",
    "accessToken":"<..access-token-from-the-Identity-Object-request..>",
    "essentials":{}
}
{
    "service":"Identity",
    "itemId":"<..itemId-from-the-Identity-Object-request....>",
    "task":"autoRecognition",
    "accessToken":"<..access-token-from-the-Identity-Object-request..>",
    "essentials":{}
}
﻿
PARAMETERS
DESCRIPTION
TYPE
VALUE (COMPULSORY OR OPTIONAL)
service
Category it belongs to
String
COMPULSORY
itemId
id parameter value returned from the Identity Object creation request.
String
COMPULSORY
task
Task can be
autoRecognition
verification
fetch
String
COMPULSORY
accessToken
accessToken parameter value returned from the Identity Object creation request.
String
OPTIONAL
essentials
essentials will be empty in case of autoRecognition, but required input values needed for verification and fetch.
Object
COMPULSORY
Response
JSON
{
    "service": "Identity",
    "itemId": "..item Id..",
    "task": "autoRecognition",
    "essentials": {},
    "accessToken": "...accessToken...",
    "id": "...id...",
    "response": {
        "files": [
            "...image url..."
        ],
        "id": 537,
        "instance": {
            "id": "...id...",
            "callbackUrl": "...callback url..."
        },
        "result": {
            "issueDate": "date-of-issue",
            "dob": "dob",
            "expiryDate": "date-of-expiry",
            "name": "name",
            "number": "dl number",
            "guardianName": "name of guardian",
            "address": "address",
            "splitAddress": {
                "state": [
                    []
                ],
                "district": [],
                "city": [],
                "pincode": "...pincode...",
                "country": [
                    "IN",
                    "IND",
                    "INDIA"
                ],
                "addressLine": "...addressLine..."
            },
            "dlType": [
                "array-of-vehicle-class"
            ],
            "summary": {
                "number": "..dl number..",
                "name": "..name..",
                "dob": "..dob..",
                "address": "..address...",
                "splitAddress": {
                    "state": [
                        []
                    ],
                    "district": [],
                    "city": [],
                    "pincode": "...pincode...",
                    "country": [
                        "IN",
                        "IND",
                        "INDIA"
                    ],
                    "addressLine": "...addressLine..."
                },
                "gender": "",
                "guardianName": "..name of guardian..",
                "issueDate": "..date-of-issue..",
                "expiryDate": "..date-of-expiry.."
            }
        }
    }
}
{
    "service": "Identity",
    "itemId": "..item Id..",
    "task": "autoRecognition",
    "essentials": {},
    "accessToken": "...accessToken...",
    "id": "...id...",
    "response": {
        "files": [
            "...image url..."
        ],
        "id": 537,
        "instance": {
            "id": "...id...",
            "callbackUrl": "...callback url..."
        },
        "result": {
            "issueDate": "date-of-issue",
            "dob": "dob",
            "expiryDate": "date-of-expiry",
            "name": "name",
            "number": "dl number",
            "guardianName": "name of guardian",
            "address": "address",
            "splitAddress": {
                "state": [
                    []
                ],
                "district": [],
                "city": [],
                "pincode": "...pincode...",
                "country": [
                    "IN",
                    "IND",
                    "INDIA"
                ],
                "addressLine": "...addressLine..."
            },
            "dlType": [
                "array-of-vehicle-class"
            ],
            "summary": {
                "number": "..dl number..",
                "name": "..name..",
                "dob": "..dob..",
                "address": "..address...",
                "splitAddress": {
                    "state": [
                        []
                    ],
                    "district": [],
                    "city": [],
                    "pincode": "...pincode...",
                    "country": [
                        "IN",
                        "IND",
                        "INDIA"
                    ],
                    "addressLine": "...addressLine..."
                },
                "gender": "",
                "guardianName": "..name of guardian..",
                "issueDate": "..date-of-issue..",
                "expiryDate": "..date-of-expiry.."
            }
        }
    }
}
﻿
Details of the response properties
Property
Example Value
Description
dlType
"LMV-NT"
The type of driving license.
issueDate
"19/07/2011"
The date of issue of the driving license.
expiryDate
"18/07/2031"
The expiry date of the driving license.
dob
"10/12/1988"
The date of birth of the license holder.
guardianName
"KAMAL"
The name of the guardian of the license holder.
name
"MILIND KUMAR"
The name of the license holder.
number
"WB-0120110857318"
The license number.
state
"West Bengal"
The state where the license was issued.
address
"BL NO.-19, FLAT-13, ..."
The address of the license holder.
gaurdianName
"KAMAL"
The name of the guardian of the license holder.
splitAddress
Object containing split address data
The address of the license holder, split into its component parts, including district, state, city, pincode, country and addressLine.
summary
Object containing summary data
A summary of the license holder's details, including name, date of birth, address, splitAddress, gender (if available), guardian name, issue date and expiry date.
Error Codes

Error Code
Description
400
Bad Request – The request could not be understood or was missing required parameters.
401
Unauthorized – Authentication failed or user does not have permissions for the requested operation.
403
Forbidden – Access denied.
404
Not Found – The requested resource could not be found.
429
Too Many Requests – Rate limit exceeded.
500
Internal Server Error – An error occurred on the server side.
503
Service Unavailable – The server is currently unavailable.
504
Gateway Timeout – The server did not receive a timely response from the upstream server.
Troubleshooting
Issue
Troubleshooting
Invalid or missing API key
Check that the API key is valid and has not expired. If it is invalid, obtain a new key and try again.
Incorrect API endpoint URL
Check that the endpoint URL is correct and matches the documentation. If it is incorrect, update the URL and try again.
Incorrect request headers
Check that the request headers match the documentation and are valid. If they are incorrect, update the headers and try again.
Invalid request data
Check that the request data is valid and in the correct format. If it is invalid, update the data and try again.
Unsupported file format
Check that the file format of the images being provided is supported by the API. If it is not supported, convert the images to a supported format and try again.
Images not in correct orientation
Check that the images are in the correct orientation as required by the API. If they are not, rotate the images to the correct orientation and try again.
Low-quality images
Check that the images are of sufficient quality to be processed by the API. If they are not, retake the images with better lighting and focus, or use higher-quality images, and try again.
Unreadable text on images
Check that the text on the images is legible and clear. If it is not, retake the images with better lighting and focus, or use higher-quality images, and try again.
API server down or slow response
Check if the API server is down or if it is experiencing high traffic causing slow response times. If the server is down, try again later. If it is slow, wait for some time and try again later.
Connection issues
Check for connectivity issues such as internet connectivity or firewall blocking the API endpoint. If there are connectivity issues, resolve them and try again.
﻿

Delete Token API

Passport verification 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	urls's to be extracted	List	COMPULSORY

Property	Example Value	Description
dlType	"LMV-NT"	The type of driving license.
issueDate	"19/07/2011"	The date of issue of the driving license.
expiryDate	"18/07/2031"	The expiry date of the driving license.
dob	"10/12/1988"	The date of birth of the license holder.
guardianName	"KAMAL"	The name of the guardian of the license holder.
name	"MILIND KUMAR"	The name of the license holder.
number	"WB-0120110857318"	The license number.
state	"West Bengal"	The state where the license was issued.
address	"BL NO.-19, FLAT-13, ..."	The address of the license holder.
gaurdianName	"KAMAL"	The name of the guardian of the license holder.
splitAddress	Object containing split address data	The address of the license holder, split into its component parts, including district, state, city, pincode, country and addressLine.
summary	Object containing summary data	A summary of the license holder's details, including name, date of birth, address, splitAddress, gender (if available), guardian name, issue date and expiry date.

Error Code	Description
400	Bad Request – The request could not be understood or was missing required parameters.
401	Unauthorized – Authentication failed or user does not have permissions for the requested operation.
403	Forbidden – Access denied.
404	Not Found – The requested resource could not be found.
429	Too Many Requests – Rate limit exceeded.
500	Internal Server Error – An error occurred on the server side.
503	Service Unavailable – The server is currently unavailable.
504	Gateway Timeout – The server did not receive a timely response from the upstream server.

Issue	Troubleshooting
Invalid or missing API key	Check that the API key is valid and has not expired. If it is invalid, obtain a new key and try again.
Incorrect API endpoint URL	Check that the endpoint URL is correct and matches the documentation. If it is incorrect, update the URL and try again.
Incorrect request headers	Check that the request headers match the documentation and are valid. If they are incorrect, update the headers and try again.
Invalid request data	Check that the request data is valid and in the correct format. If it is invalid, update the data and try again.
Unsupported file format	Check that the file format of the images being provided is supported by the API. If it is not supported, convert the images to a supported format and try again.
Images not in correct orientation	Check that the images are in the correct orientation as required by the API. If they are not, rotate the images to the correct orientation and try again.
Low-quality images	Check that the images are of sufficient quality to be processed by the API. If they are not, retake the images with better lighting and focus, or use higher-quality images, and try again.
Unreadable text on images	Check that the text on the images is legible and clear. If it is not, retake the images with better lighting and focus, or use higher-quality images, and try again.
API server down or slow response	Check if the API server is down or if it is experiencing high traffic causing slow response times. If the server is down, try again later. If it is slow, wait for some time and try again later.
Connection issues	Check for connectivity issues such as internet connectivity or firewall blocking the API endpoint. If there are connectivity issues, resolve them and try again.