Verification-1 API

12 min

Introduction

The PAN details must be manually validated by the user before sending them to the SIGNZY verification service. Upon receiving the details, they are cross-checked against government records to verify the authenticity of the details provided by the user. This is the basic verification service where only the name and PAN number will be verified.

This API will take input such Name on the PAN card and PAN number then it will verify it as per the data with the Indian Government for integrity and respond to the verification request as true/false.

How to call the API

Before going for Verification calls, you first need to create an Identity object. The user details must be unique and the PAN Number with the name is mandatory.

API Input Guidelines

Name of PAN card holder
PAN number

Step 1: Hit Identities API

Sample cURL Request

Preproduction

Production

curl --location --request POST 'https://preproduction.signzy.tech/api/v2/patrons/..patronId../identities' \
--header 'Authorization: <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "individualPan",
    "email": "<email Id>",
    "callbackUrl": "https://www.w3schools.com",
    "images": [<images Url>]
}'

curl --location --request POST 'https://signzy.tech/api/v2/patrons/..patronId../identities' \
--header 'Authorization: <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "individualPan",
    "email": "<email Id>",
    "callbackUrl": "https://www.w3schools.com",
    "images": [<Images Url>]
}'

Input Parameters

Parameters Name	Description	Required/Optional
Authorization	Contains the id parameter returned from the login step	Required
Content-Type	application/json	Required
type	Type of Identity	Required
callbackurl	URL where response will be posted	Required
images	Front and Back side Image of Passport	Required

Sample Response

{
    "type": "individualPan",
    "email": "<email Id>",
    "callbackUrl": "<call back URL>",
    "images": [
        " "
    ],
    "accessToken": " ",
    "autoRecognition": [],
    "verification": [],
    "forgeryCheck": [],
    "id": " ",
    "patronId": " "
}

Response Parameters

Parameter Name	Description
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 receive a response

Sample CURL

Preproduction

Production

curl --location --request POST 'https://preproduction.signzy.tech/api/v2/snoops' \
--header 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{
      "service":"Identity",
      "itemId":"<Identity-object-id>",
      "task":"verification",
      "accessToken":"<Identity-access-token>",
      "essentials":{
        "number":"<PAN-as-mentioned-on-the-card>",
        "name":"<Name-corresponding-to-the-given-pan>",
        "fuzzy":"true/false"
    }
}'

curl --location --request POST 'https://signzy.tech/api/v2/snoops' \
--header 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{
      "service":"Identity",
      "itemId":"<Identity-object-id>",
      "task":"verification",
      "accessToken":"<Identity-access-token>",
      "essentials":{
        "number":"<PAN-as-mentioned-on-the-card>",
        "name":"<Name-corresponding-to-the-given-pan>",
        "fuzzy":"true/false"
    }
}'

Input Parameters

PARAMETER NAME	DESCRIPTION
Content-Type	application/json
service	Type of Signzy service - “identity extraction”
itemId	Identity item id
accessToken	Identity access token
task	The type of task performed - “Verification”
essentials	Essential output data
essentials.name	Name written on PAN card
essentials.number	PAN Number
fuzzy	It performs the name match if it is true and does not if false should be written

Sample API Response

{
    "service": "Identity",
    "itemId": " ",
    "task": "verification",
    "essentials": {
        "name": "A",
        "number": " ",
        "fuzzy": "true",
        "instance": {}
    },
    "accessToken": " ",
    "id": " ",
    "response": {
        "name": "POOJA",
        "number": " ",
        "fuzzy": "true",
        "id": 6892,
        "instance": {
            "id": " ",
            "callbackUrl": "https://www.w3schools.com"
        },
        "result": {
            "verified": true,
            "message": "Verification completed with positive result",
            "upstreamName": "POOJA"
        }
    }
}

Response Parameters

PARAMETER NAME	DESCRIPTION
service	Type of Signzy service - “identity extraction”
itemId	Identity item id
task	The type of task performed - “Verification”
essentials	Essential output data
essentials.name	Name written on PAN card
essentials.number	PAN Number
essentials.fuzzy	It performs the name match if it is true and does not if false should be written
accessToken	Access token received from identity request
id	Unique user Id
response	Contain output result
response.name	Name of the PAN Holder
response.number	PAN Number
response.fuzzy	It performs the name match if it is true and does not if false should be written
response.id	Unique user Id
response.instance.id	Unique user Id
response.instance.callbackUrl	Shows callback Url
response.result	The output of the response
response.result.verified	Contains the verification status "true/false"
response.result.message	This parameter displays the verification success/failure message to the user.
response.result.upstreamName	This parameter checks the details of the PAN against the existing records in the database.

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