Global Data Fetch Verification

5 min

Introduction

You will need to login before sending the request. You are required to pass the access token received from the login call, as authorization header in the request.

Sample cURL Request

curl --request POST \
  --url https://signzy.tech/api/v2/patrons/..your-patron-id../globaldataverifications \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'content-type: application/json' \
  --data '{"essentials":{"queryType":"entity/individual", "inputData":{"number":"...number...", "name":"...name...", "dob":"...dob...", "state":"...state...", "issueDate":"...issueDate...","fuzzy":"...fuzzy..."}}}'

Input Parameters

PARAMETERS	DESCRIPTION	TYPE	VALUE (COMPULSORY OR OPTIONAL)
queryType	Type of service to be called (Individual or entity)	String	COMPULSORY
inputData.type	Name of the service to be called	String	COMPULSORY
inputData.number	Number of the ID card or related to the Organization, whose details need to be verified. Applicable for all types	String	COMPULSORY
inputData.name	Name of the entity/individual being verified. Applicable for PAN, Indian Passport, VoterID and SSN Verification	String	COMPULSORY
inputData.surname	Surname of the individual being verified. Applicable for SSN Verification.	String	COMPULSORY
inputData.dob	Date of birth of the individual. Applicable for queryType individual, and type drivingLicense, indianPassport and ssnVerification	String	COMPULSORY (Conditional)
inputData.issueDate	Date of issue of the ID Card. Applicable for queryType individual, and type drivingLicense	String	COMPULSORY (Conditional)
inputData.phone	The phone number of the individual for which the verification is being done. Applicable for type ssnVerification(individual)	String	COMPULSORY (Conditional)
inputData.address	The address for which the verification is being done. Applicable for type ssnVerification(individual)	String	COMPULSORY (Conditional)
inputData.city	The city for which the verification is being done. Applicable for type ssnVerification(individual)	String	COMPULSORY (Conditional)
inputData.state	The state for which the verification is being done. Applicable for type voterid and ssnVerification(individual)	String	COMPULSORY (Conditional)
inputData.zipcode	The zipcode for which the verification is being done. Applicable for type voterid and ssnVerification(individual)	String	COMPULSORY (Conditional)
inputData.fuzzy	Indicating whether or not the lookup is a fuzzy or exact search. Applicable for PAN and Indian Passport	boolean	COMPULSORY (Conditional)

sample response


    For Test Credentials
    // POST :: https://preproduction.signzy.tech/api/v2/patrons/..your-patron-id../globaldataverifications
    For Production Credentials
    // POST :: https://signzy.tech/api/v2/patrons/...patronID.../globaldataverifications

    // patron ID is returned as userId parameter of login request.
    // Headers
    {
      'Authorization': '...access token (returned as id field of login request)...',
      'Content-type': 'application/json'
    }

    // Request data
    {
        "essentials": {
            "queryType": "individual / entity",
            "inputData": {
                "type": "...type to be hit...",
                "name": "...name...",
                "number": "...number ...",
                "state": "...state...",
                "dob": "... date of birth...",
                "issueDate": "... date of issue...",
                "fuzzy": "... fuzzy ..."
            }
        }
    }
  // Expected response
  {
      "result": {
          "queryType": "individual / entity",
          "summary": {
              "verified": "...if verification was successful or not...",
              "message": "...verification message..."
          },
          "detailed": "...detailed API response..."
      }
  }

Sample Response

PARAMETERS	DESCRIPTION	TYPE	VALUE (COMPULSORY OR OPTIONAL)
queryType	Type of service to be called (Individual or entity)	String	COMPULSORY
inputData.type	Name of the service to be called	String	COMPULSORY
inputData.name	Name of the entity/individual being verified	String	COMPULSORY (conditional)
inputData.number	Number of the ID card or related to the Organization, whose details need to be verified. Applicable for all types	String	COMPULSORY
inputData.state	The state for which the verification is being done	String	COMPULSORY (conditional)
inputData.dob	Date of birth of the individual. Applicable for queryType individual, and type drivingLicense, indianPassport and ssnVerification	String	COMPULSORY (conditional)
inputData.issueDate	Date of issue of the ID Card. Applicable for queryType individual, and type drivingLicense	String	COMPULSORY (conditional)
inputData.fuzzy	Indicating whether or not the lookup is a fuzzy or exact search. Applicable for PAN and Indian Passport	Boolean	COMPULSORY (conditional)