Verification API

12 min

Introduction

This API verifies the Driving Licence and Displays output in two categories.It displays positve message for successful DL verification along with other parameters and displays negative message for unsuccessful verification.

How to call the API

Before going for Verification calls, you first need to create an Identity object. Need to pass accessToken and itemid obtained from identity call along with other input parameters. Other input parameters include DL Number, Date of Issue, Date of Birth.

API Input Guidelines

A valid Dl number should be passed as a value along with name and the date in dd/mm/yyyy format.

Step 1: Hit Identities API

Sample cURL

Preproduction

Production

curl --location --request POST 'https://preproduction.signzy.tech/api/v2/patrons/..patronId../identities' \
--header 'Content-Type: application/json' \
--header 'Authorization: <token>' \
--data-raw '{
  "type": "drivingLicence",
  "email": "<email Id>",
  "callbackUrl": "<call Back Url>" 
}'

curl --location --request POST 'https://signzy.tech/api/v2/patrons/..patronId../identities' \
--header 'Content-Type: application/json' \
--header 'Authorization: <token>' \
--data-raw '{
  "type": "drivingLicence",
  "email": "<email Id>",
  "callbackUrl": "<call back Url>" 
}'

Input Parameters

Parameter Name	Required/Optional	Description
Authorization	Required	Contains the id parameter returned from the login step
Content-Type	Required	application/json
type	Required	Type of identity
email	Required	e-mail ID
callbackurl	Required	URL where response will be posted

Sample Response

{
    "type": "drivingLicence",
    "email": "[email protected]",
    "callbackUrl": "",
    "accessToken": "",
    "autoRecognition": [],
    "verification": [],
    "forgeryCheck": [],
    "id": "",
    "patronId": ""
}

Response Parameter

Parameter Name	Description
type	type of ID
email	email id
callbackUrl	url which holds output
accessToken	This is provided by identities API
autoRecognition	Auto recognises text from upload image
verification	verification is done
forgeryCheck	Forgery check is done
id	Unique user id
patronId	Unique patron id

Step 2: Hit Snoops API and receives a response

Sample cURL

Preproduction

Production

curl --location --request POST 'https://preproduction.signzy.tech/api/v2/snoops' \
--header 'Content-Type: application/json' \
--data-raw '{ "service": "Identity",
  "itemId": "",
  "task": "verification",
  "accessToken": "",
  "essentials": {
  	    "number":"",
        "dob":"",
        "issueDate":""
        }
} '

curl --location --request POST 'https://preproduction.signzy.tech/api/v2/snoops' \
--header 'Content-Type: application/json' \
--data-raw '{ "service": "Identity",
  "itemId": "",
  "task": "verification",
  "accessToken": "",
  "essentials": {
  	    "number":"",
        "dob":"",
        "issueDate":""
        }
} '

Input Parameters

Parameter Name	Required/Optional	Description
Content-Type	Required	application/json
Authorization	Required	Authorization token
service	Required	Type of Signzy service - “identity”
itemId	Required	Contains the identity item id
accessToken	Required	This is provided by the identities API
task	Required	The task need to be performed (i.e. verification in this case)
essentials	Required	Contains the essential output data
essentials.number	Required	DL Number
essentials.dob	Required	Date of birth of the DL holder
essentials.issueDate	Optional	Date of issue of DL

Sample API Responses

Positive Response

Negative Response

{
    "service": "Identity",
    "itemId": "",
    "task": "verification",
    "essentials": {
        "number": "",
        "dob": "",
        "issueDate": "",
        "instance": {
            "id": "",
            "callbackUrl": ""
        }
    },
    "accessToken": "",
    "id": "",
    "response": {
        "number": "",
        "dob": "",
        "issueDate": "",
        "instance": {
            "id": "",
            "callbackUrl": ""
        },
        "id": 1,
        "result": {
            "verified": true,
            "message": "Driving licence verification process completed successfully with positive result.",
            "moreInfo": {
                "issueDate": "",
                "expiryDate": "",
                "vehicleClass": [
                    "MCWG",
                    "LMV"
                ]
            }
        }
    }
}

//For negative Result
 "result": {
            "verified": false,
            "message": "Driving licence verification process completed successfully with negative result."
        }

Output Parameters

Positive response

Negative response

Parameter Name	Description
service	Type of Signzy service - “identity”
itemId	Contains the identity item id
task	The type of task performed - “Auto Recognition”
essentials	Contains the essential output data
essentials.number	DL number
essentials.dob	Date of birth of Licence holder
essentials.issueDate	Date of issue of the Driving Licence
essentials.instance.id	It contains instance id value
essentials.instance.callbackUrl	It contains url where the output will be posted.
accessToken	Contains the access token that was received from identity request
id	Contains the unique Id of the snoop request
response	Contains the output files
response.dob	Date of birth of licence holder.
response.issueDate	Date of issue of licence
instance.id	It contains instance id value
instance.callbackUrl	Url where output is stored
response.id	It contains response id value
response.result.verified	It displays the status of verification (i.e. true/false)
response.result.message	Displays result message
response.result.moreInfo.issueDate	Date of issue of Licence
response.result.moreInfo.expiryDate	Date of expiry of Licence
response.result.moreInfo.vehicleClass	It displays the type of vehicle for which licence issued

Parameter Name	Description
result.verified	False if the verification is unsucessful
result.message	Message showing the negative result

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected].