Extraction API

12 min

Introduction

This API will read the data from the DL image using an OCR technology and displays it in the response.

How to call the API

Before going for Auto reading calls, you first need to create an Identity object. Need to pass accessToken and itemid obtained from identity call along with other input parameters.

API Input Guidelines

Need to pass either url of front image or backimage or both.

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>",
  "images": [
    "frontimage.jpg","backimage.jpeg"
  ]
}'

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>",
  "images": [
    "frontimage.jpg","backimage.jpeg"
  ]
}'

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
images	Required	Front and back image of driving Licence

Sample Response

{
    "type": "drivingLicence",
    "email": "..email..
    "callbackUrl": "<https://www.w3schools.com",>
    "images": [
        "<https://<Front> side image URL>",
        "<https://<Back> side image URL>"
    ],
    "accessToken": "..accessToken..",
    "autoRecognition": [],
    "verification": [],
    "forgeryCheck": [],
    "id": "..id..",
    "patronId": "..patronId.."
}

Response Parameter

Parameter Name	Description
type	Type of identity (type of task to be performed)
email	email ID
callbackUrl	It is where the result will be posted
images	URL of Driving Licence
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' \
--header 'Authorization: "<token>"' \
--data-raw '{
    "service": "Identity",
    "itemId": "",
    "accessToken": "",
    "task": "autoRecognition",
    "essentials": {
    }
}'

curl --location --request POST 'https://signzy.tech/api/v2/snoops' \
--header 'content-type: application/json' \
--header 'Authorization: "<token>"' \
--data-raw '{
    "service": "Identity",
    "itemId": "",
    "accessToken": "",
    "task": "autoRecognition",
    "essentials": {

        "images" : [ "frontimage.jpg", "backimage.jpeg"]
    }
}'

Input Parameters

Parameter Name	Required/Optional	Description
Authorization	Required	Contains the id parameter returned from the login step
Content-Type	Required	application/json
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	This value always remains fixed for Driving Licence API, it is always AutoRecognition
essentials.images	Optional	Contains the urls of front and back images

Sample API Response


  {
    "service": "Identity",
    "itemId": "",
    "task": "autoRecognition",
    "essentials": {},
    "accessToken": "",
    "id": "",
    "response": {
        "files": [
            "frontimage.jpg",
            "backimage.jpg"
        ],
        "id": 633,
        "instance": {
            "id": "",
            "callbackUrl": ""
        },
        "result": {
            "dlType": [
                "LMV(NT)",
                "MCWG"
            ],
            "issueDate": "",
            "expiryDate": "",
            "dob": "",
            "guardianName": "",
            "name": "",
            "number": "",
            "state": "",
            "address": "",
            "gaurdianName": "",
            "splitAddress": {
                "district": [
                    ""
                ],
                "state": [
                    [
                        "",
                        ""
                    ]
                ],
                "city": [
                    ""
                ],
                "pincode": "",
                "country": [
                    "IN",
                    "IND",
                    "INDIA"
                ],
                "addressLine": ""
            },
            "summary": {
                "number": "",
                "name": "",
                "dob": "",
                "address": "",
                "splitAddress": {
                    "district": [
                        ""
                    ],
                    "state": [
                        [
                            "",
                            ""
                        ]
                    ],
                    "city": [
                        ""
                    ],
                    "pincode": "",
                    "country": [
                        "IN",
                        "IND",
                        "INDIA"
                    ],
                    "addressLine": ""
                },
                "gender": "",
                "guardianName": "",
                "issueDate": "",
                "expiryDate": ""
            }
        }
    }
}

Output Parameters

Parameter Name	Description
service	Type of Signzy service - “identity extraction”
itemId	Contains the identity item id
task	The type of task performed - “Auto Recognition”
essentials	Contains the essential output data
accessToken	Contains the access token that was received from identity request
id	Contains the unique Id of the snoop request
response.files	Contains the output files
response.id	Contains response id
response.instance.id	Contains the instance id
response.instance.callbackUrl	Contains the url where output will be stored
result.dlType	It holds the type of vehicle for which DL issued
result.issueDate	Date of issiue of Licence
result.dob	Date of birth of licence holder
result.guardianName	Gurdian Name of Licence holder
result.name	Name of Licence holder
result.number	Licence number
result.state	State which issued licence
result.address	Address stated in the DL
result.guardianName	Guardian Name of Licence holder
result.splitAddress.district	Name of district mentioned in licence
result.splitAddress.state	Name of state mentioned in Licence
result.splitAddress.city	Name of city mentioned in Licence
result.splitAddress.pincode	pincode number mentioned in Licence
result.splitAddress.country	Name of the country mentioned in DL
result.splitAddress.addressLine	First Line of Address mentioned in DL
result.summary.number	DL number mentioned in Licence
result.summary.name	Name of Licence holder
result.summary.dob	Date of birth of licence holder
result.summary.address	Address of Licence holder
result.summary.splitAddress.district	Name of district mentioned in licence
result.summary.splitAddress.state	State which issued licence
result.summary.splitAddress.city	Name of city mentioned in Licence
result.summary.splitAddress.pincode	Pincode number mentioned in Licence
result.summary.splitAddress.country	Name of the country mentioned in DL
result.summary.splitAddress.addressLine	First Line of Address mentioned in DL
result.gender	Gender of the Licence holder
result.guardianName	Gurdian Name of Licence holder
result.issueDate	Issue date of Licence
result.expiryDate	Expiry date of licence

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].