Fetch API

13 min

Introduction

The Fetch API is used to retrieve or ‘fetch’ certain details of the PAN card holder.

The Following information is fetched:

Name of the PAN holder
Father's name
D.O.B

How to call the API

Before fetching the details via PAN number, you first need to create an Identity object. For best results, please make sure that the image you use fits tightly in camera view and is horizontally aligned. Each image/pdf should be less than 2MB.

API Input Guidelines

PAN number in upper/lower case.

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	URL of front and back side images in array form	Optional

Sample Response

{
    "type": "individualPan",
    "email": "[email protected]",
    "callbackUrl": "<https://www.w3schools.com",>
    "images": [],
    "accessToken": " ",
    "autoRecognition": [],
    "verification": [],
    "forgeryCheck": [],
    "id": " ",
    "patronId": " "
}

Response Parameter

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 receives a response

Sample Curl

Preproduction

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":"fetch",
      "accessToken":"<Identity-access-token>",
      "essentials": {
        "name": "..name..",
        "number": "..panNumber..",
        "fuzzy": "true"
    }
}'

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":"fetch",
      "accessToken":"<Identity-access-token>",
      "essentials": {
        "name": "..name..",
        "number": "..panNumber..",
        "fuzzy": "true"
    }
}'

Input Parameters

PARAMETER NAME	DESCRIPTION
Content-Type	application/json
service	Type of Signzy service - “identity extraction”
itemId	Contains the identity item id
accessToken	Identity access token
task	The type of task performed - “Fetch”
essentials	Contains the essential output data
essentials.name	Name of the individual
essentials.number	PAN number of the individual
essentials.fuzzy	it performs the name match if it is true and doesnot if falseit performs the name match if it is true and doesnot if false

API Response

{
    "service": "Identity",
    "itemId": " ",
    "task": "fetch",
    "essentials": {
        "name": "POOJA",
        "number": " ",
        "fuzzy": "true",
        "instance": {}
    },
    "accessToken": " ",
    "id": " ",
    "response": {
        "number": "<PAN Number to be seached>",
        "id": 12684,
        "name": "<Name to be searched for>",
        "fuzzy": "true",
        "instance": {
            "id": "6180c10b7157fd10dd4eezzzz",
            "callbackUrl": "<https://www.w3schools.com">
        },
        "result": {
            "number": "<PAN Number>",
            "name": "<PAN Holder's Name>",
            "fatherName": "<Father's Name>",
            "dob": "<dob>"
        }
    }
}

Output Parameters

PARAMETER NAME	DESCRIPTION
task	The type of task performed - “Fetch”
essentials	Contains the essential output data
essentials.name	Name of the individual
essentials.number	PAN number of the individual
essentials.fuzzy	Fuzzy match the name
accessToken	Identity access token
id	ID of the response
response.number	PAN number
response.id	Response ID
response.name	Name of the PAN card holder
response.fuzzy	it performs the name match if it is true and doesnot if false
instance.id	ID of the instance
instance.callbackUrl	endpoint where the response is posted
result	This holds final result parameters of the response.
result.name	The name of the PAN holder (or organization name for business PAN)
result.fatherName	The father's name of the PAN holder (for individual PAN only)
result.dob	This parameter holds the date of birth (for individual PAN) or the date of issue (in case of business PAN)
result.number	The PAN number of the individual/organization

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