Global Data Fetch API

11 min

Introduction

The API is used to fetch the details depending upon the service that is called.

How to call the API

You will need to login before sending Global Data Fetch API request. You are required to pass the access token received from the login call, as authorization header in the request for Global Data Fetch API along with other parameters.

API Input Guidelines

Points to be noted here are,

1) queryType should be either individual or entity.

2) Response might vary depending upon the type of document provided.

Sample CURL

Preproduction

Production

curl --location --request POST 'https://preproduction.signzy.tech/api/v2/patrons/..patronId../globaldatafetches' \
--header 'Accept: */*' \
--header 'Accept-Language: en-US,en;q=0.8' \
--header 'content-type: application/json' \
--header 'Authorization: <token>' \
--data-raw '{
    "essentials": {
        "queryType": "individual",
        "inputData": {
            "type": "voterid",
            "number": " ",
            "state": " ",
            "dob": " ",
            "memberType": ""
        }
    }
}'

curl --location --request POST 'https://signzy.tech/api/v2/patrons/..patronId../globaldatafetches' \
--header 'Accept: */*' \
--header 'Accept-Language: en-US,en;q=0.8' \
--header 'content-type: application/json' \
--header 'Authorization: <token>' \
--data-raw '{
    "essentials": {
        "queryType": "individual",
        "inputData": {
            "type": "voterid",
            "number": " ",
            "state": " ",
            "dob": " ",
            "memberType": ""
        }
    }
}'

Input Parameters

PARAMETERS	DESCRIPTION	TYPE	VALUE (REQUIRED OR OPTIONAL)
Authorization	Contains the id parameter returned from the login step	String	REQUIRED
content-type	application/json	String	REQUIRED
queryType	Type of service to be called (Individual or entity)	String	REQUIRED
inputData.type	Name of the service to be called	String	REQUIRED
inputData.number	Number of the ID card or related to the Organization, whose details need to be fetched. Compulsory for all types	String	REQUIRED
inputData.countryCode	Country Code. (For mobile API only)	String	REQUIRED (conditional)
inputData.aadhaarNumber	Aadhaar Number related to the Organization, whose details need to be fetched. Required for type udhyogAadhaarUanUid	String	REQUIRED (conditional)
inputData.dob	Date of birth of the individual. Required for queryType individual, and type drivingLicense and indianPassport	String	REQUIRED (conditional)
inputData.state	The state for which the fetch is being done. Compulsory for type voterid (individual) and type snec (entity)	string	REQUIRED (conditional)
inputData.memberType	Member type. Required for type icsi (entity)	string	REQUIRED (conditional)
inputData.otp	OTP received by customer(For mobile API only)	String	REQUIRED (conditional)
inputData.referenceId	Ref ID received alongwith OTP. (For mobile API only)	String	REQUIRED (conditional)

APIs supported in Global Data Fetch

For Individual

API NAME	INPUTDATA. TYPE	NUMBER	DATE OF BIRTH	STATE	COUNTRY CODE	REFER ENCE ID	OTP
Pan	pan	Yes	No	No	No	No	No
Driving Licence	driving License	Yes	Yes	No	No	No	No
Indian Passport	indian Passport	Yes	Yes	No	No	No	No
Voter ID	voterid	Yes	No	Yes	No	No	No
Phone (Get OTP)	mobile FetchGet Otp	Yes	No	No	Yes	No	No
Phone	mobile Fetch	Yes	No	No	Yes	Yes	Yes

For Entity

API NAME	INPUT DATA TYPE	NUMBER	AADHAAR NUMBER	STATE	MEMBER TYPE
GSTIN Search	gstSearch	Yes	No	No	No
Detailed GSTIN Search	detailedGstSearch	Yes	No	No	No
PAN to GST API	panToGst	Yes	No	Yes	No
ROC - Quick Search by CIN	quickSearchCin	Yes	No	No	No
ROC - Simple Search by CIN	simpleSearchCin	Yes	No	No	No
ROC - Detailed Search by CIN	detailedSearchCin	Yes	No	No	No
ROC - Quick Search by DIN	quickSearchDin	Yes	No	No	No
ROC - Simple Search by DIN	simpleSearchDin	Yes	No	No	No
ROC - Detailed Search by DIN	detailedSearchDin	Yes	No	No	No
Shop & Establishment	snec	Yes	No	Yes	No
Udhyog Aadhaar - Search by UAN	udhyogAadhaarUan	Yes	No	No	No
FSSAI	fssai	Yes	No	No	No
ICSI	icsi	Yes	No	No	Yes
IEC	iec	Yes	No	No	No
ROC - Asset Charges by CIN	assetChargesCin	Yes	No	No	No
Udhyog Aadhaar - Search by UAN UID	udhyogAadhaarUanUid	Yes	Yes	No	No
TIN	tin	Yes	No	No	No
ICWAI - Search by Firm	icwaiFirm	Yes	No	No	No
ICWAI - Search by Member	icwaiMember	Yes	No	No	No
ICAI	icai	Yes	No	No	No

Note : For input parameters

a) The value "Yes" indicates that the parameter is compulsory for the API.

b) The value "No" indicates that the parameter is not compulsory for that API.

Other points to Note

1) List of supported Country Codes for Phone API:

2) Operators supported for Phone API (India) are:

Airtel
Vodafone
Jio
Idea

Sample Response

{
    "essentials": {
        "queryType": "individual",
        "inputData": {
            "type": "voterid",
            "number": "TQG1158xxx",
            "state": "West Bengal",
            "dob": "07/05/1991",
            "memberType": ""
        },
        "patronId": "5e3c565a06e47c21a81ccxxx"
    },
    "id": "632d3fcbc533b576b1exxxxx",
    "patronId": "5e3c565a06e47c21a81xxxxx",
    "result": {
        "queryType": "individual",
        "summary": {
            "name": " ",
            "number": "",
            "dob": "",
            "address": "",
            "splitAddress": {
                "district": [],
                "state": [
                    []
                ],
                "city": [],
                "pincode": "",
                "country": [],
                "addressLine": ""
            }
        },
        "detailed": {
            "name": "YUVRAJ SHARMA",
            "dob": "NA",
            "district": "Kalimpong",
            "state": "WEST BENGAL",
            "fatherName": "T P SHARMA",
            "gender": "Male"
        }
    }
}

Response Parameters

PARAMETERS	DESCRIPTION
essentials.queryType	Individual or Entity
inputData.type	Type of ID card used to fetch the details (for eg PAN etc)
inputData.number	ID card number (eg Adhaar number)
inputData.state	State in which the intity/individual is registered
inputData.dob	DOB of the individual (Registration date in case of an entity)
inputData.memberType	Member type
patronId	Unique Patron ID
Id	Unique ID
PatronId	Unique Patron ID
result.queryType	Individual or Entity
summary.name	Name of the individual/entity
summary.number	Document ID
summary.dob	DOB of the individual (Registration date in case of an entity)
summary.address	Full address of the individual/entity
splitAddress.district	District of the individual/entity
splitAddress.state	State of the individual/entity
splitAddress.city	City of the individual/entity
splitAddress.pincode	Pin code of the individual/entity
splitAddress.country	Country of the individual/entity
splitAddress.addressLine	First line of address of the individual/entity
detailed.epicNumber	EPIC number (if type is voterId)
detailed.name	Name of the individual
detailed.dob	Date of birth of the individual
detailed.district	District in which the individual resides
detailed.state	State in which the individual resides
detailed.fatherName	Father's name of the individual
detailed.gender	Gender of the individual

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