API docs for old integrations

Passport verification V2

Introduction
﻿
﻿
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": "passport",
    "email": "[email protected]",
    "callbackUrl": "https://your-domain.com/your-callback-system",
    "images": [
  
    ]
}
{
    "type": "passport",
    "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": "passport",
              "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": "passport",
              "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": {
       "fileNumber":"...fileNumber...",
            "dob":"...dob...",
            "name":"...name...",
            "fuzzy" : "true/false"
    }
}
{
    "service": "Identity",
    "itemId": "<..itemId-from-the-Identity-Object-request....>",
    "task": "verification",
    "accessToken": "<..access-token-from-the-Identity-Object-request..>",
    "essentials": {
       "fileNumber":"...fileNumber...",
            "dob":"...dob...",
            "name":"...name...",
            "fuzzy" : "true/false"
    }
}
﻿
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 fileNumber, date of birth.
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/false,
        "message": "Verification completed successfully",
        "upstreamName": "..upstreamName.."
      }
    }
}
{
    "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/false,
        "message": "Verification completed successfully",
        "upstreamName": "..upstreamName.."
      }
    }
}
﻿
﻿

DL Extraction V2

DL verification V2

Docs powered by Archbee

TABLE OF CONTENTS

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 fileNumber, date of birth.