Passport extraction V2

Introduction

The Passport Extraction API is designed to extract data from passport images. You can input the URL of the passport image, and the API will return structured data extracted from the image, such as the passport holder's name, date of birth, passport number, address and other relevant details.

API Endpoint's

Identity Object

POST https://preproduction.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

{
    "type": "passport",
    "email": "[email protected]",
    "callbackUrl": "https://your-domain.com/your-callback-system",
    "images": [
      "url", "url"
    ]
}

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

{
              "type": "passport",
              "email": "[email protected]",
              "callbackUrl": "https://your-domain.com/your-callback-system",
              "images": [
                "url", "url"
              ],
              "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

POST https://preproduction.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

{
    "service": "Identity",
    "itemId": "<..itemId-from-the-Identity-Object-request....>",
    "task": "autoRecognition",
    "accessToken": "<..access-token-from-the-Identity-Object-request..>",
    "essentials": {
       
    }
}

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	blank

Response

{
      "service": "Identity",
      "itemId": "...item id...",
      "task": "autoRecognition",
      "essentials": {},
      "accessToken": "...access token...",
      "id": "..id...",
      "response": {
        "files": ["..image url..."],
        "id": 3920,
        "instance": {},
        "result": {
          "parentsGuardianName": "..parentsGuardianName...",
          "issueDate": "..issueDate..",
          "expiryDate": "..expiryDate..",
          "birthDate": "..birthDate..",
          "name": "..name..",
          "country": [
            "..country.."
          ],
          "nationality": "..nationality..",
          "sex": "F/M/T",
          "address": "..address..",
          "pincode": "..pincode..",
          "passportNumber": "..passportNumber..",
          "fileNumber": "..fileNumber..",
          "placeOfBirth": "..placeOfBirth..",
          "placeOfIssue": "..placeOfIssue..",
          "splitAddress": {
            "district": [
              "..district.."
            ],
            "state": [
              [
                "..state.."
              ]
            ],
            "city": [
              "..city.."
            ],
            "pincode": "..pincode..",
            "country": [
              "IN",
              "IND",
              "INDIA"
            ],
            "addressLine": "..addressLine.."
            },
            "summary": {
                "number": "..passportNumber..",
                "name": "..name..",
                "dob": "..dob...",
                "address": "",
                "splitAddress": {
                    "district": [
                      "..district.."
                    ],
                    "state": [
                      [
                        "..state.."
                      ]
                    ],
                    "city": [
                      "..city.."
                    ],
                    "pincode": "..pincode..",
                    "country": [
                      "IN",
                      "IND",
                      "INDIA"
                    ],
                    "addressLine": "..addressLine.."
                },
                "gender": "F/M/T",
                "guardianName": "..guardianName..",
                "issueDate": "..issueDate...",
                "expiryDate": "..expiryDate.."
              }
        }
      }
    }