People Search

5 min

Introduction

You will need to login before sending request. You are required to pass the access token received from the login call, as authorization header in the Email-ID Validation request along with additional parameters.

Use the following exchange parameters for People Finder API

Sample cURL Request

curl --request POST \
  --url http://signzy.tech/api/v2/patrons/..your-patron-id../peoplesearches \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'Authorization: <Access-Token>' \
  --header 'content-type: application/json' \
  --data '{"task":"peopleFinder","essentials":{"email": "..email..","phone": "..phone..","username": "..username..","userId": "..userId..","url": "..url..","name": "..name..","country": "..country..","state": "..state..","city": "..city..","street": "..street..","house": "..house..","zipcode": "..zipvode..","address": "..address..","ageRange": "..ageRange.."}}'

Input Parameters

Parameter	Description
--request	This parameter specifies the HTTP method to be used for the request. In this case, it is set to POST.
--url	This parameter specifies the URL to which the request is to be sent. The ..your-patron-id.. is a placeholder for the patron ID that needs to be replaced with an actual ID.
--header	This parameter is used to specify custom headers for the HTTP request. In this case, it sets the Accept, Accept-Language, Authorization, and content-type headers.
--data	This parameter specifies the data to be sent with the request, in this case, it is a JSON object that includes a task key with a value of peopleFinder and an essentials key with a JSON object value that includes various search criteria such as email, phone, username, userId, url, name, country, state, city, street, house, zipcode, address, and ageRange.

Sample Response


    // Data exchange
    For Test Credentials
    // POST :: https://preproduction.signzy.tech/api/v2/patrons/..your-patron-id../peoplesearches
    For Production Credentials
    // POST :: https://signzy.tech/api/v2/patrons/..your-patron-id../peoplesearches

      // 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
      {
          "task": "peopleFinder",
          "essentials": {
              "email": "..email..",
              "phone": "..phone..",
              "username": "..username..",
              "userId": "..userId..",
              "url": "..url..",
              "name": "..name..",
              "country": "..country..",
              "state": "..state..",
              "city": "..city..",
              "street": "..street..",
              "house": "..house..",
              "zipcode": "..zipvode..",
              "address": "..address..",
              "ageRange": "..ageRange.."
          }
      }

      // Sample Output response:
      {
      	"result": {
      		"profileData": {
      			"names": [{
      				"validSince": "..validSince..",
      				"lastSeen": "..lastSeen..",
      				"prefix": "..prefix..",
      				"first": "..first..",
      				"middle": "..middle..",
      				"last": "..last..",
      				"fullName": "..fullName."
      			}],
      			"usernames": [{
      				"validSince": "..validSince..",
      				"content": "..content.."
      			}],
      			"emails": [],
      			"phones": [{
      				"validSince": "..validSince..",
      				"lastSeen": "..lastSeen..",
      				"countryCode": "..countryCode..",
      				"number": "..number.."
      			}],
      			"gender": "..gender..",
      			"dob": "..dob..",
      			"addresses": [{
      				"validSince": "..validSince..",
      				"country": "..country..",
      				"state": "..state..",
      				"city": "...city..",
      				"street": "..street..",
      				"house": "..house..",
      				"apartment": "..apartment..",
      				"zipCode": "..zipCode..",
      				"display": "..display.."
      			}],
      			"jobs": [{
      				"validSince": "..validSince..",
      				"lastSeen": "..lastSeen..",
      				"country": "..country..",
      				"title": "..title..",
      				"organization": "..organization..",
      				"display": "..display..",
      				"startDate": "..startDate.."
      			}],
      			"educations": [{
      				"validSince": "..validSince..",
      				"lastSeen": "..lastSeen..",
      				"degree": "..degree..",
      				"school": "..school..",
      				"startDate": "..startDate..",
      				"display": "..display.."
      			}],
      			"userIds": [{
      				"validSince": "..validSince..",
      				"lastSeen": "..lastSeen..",
      				"content": "..content.."
      			}],
      			"images": [{
      				"validSince": "..validSince..",
      				"lastSeen": "..lastSeen..",
      				"url": "..url.."
      			}]
      		}
      	}
      }

Output Parameters