People Search

Introduction

API Endpoint's

POST https://preproduction.signzy.tech/api/v2/patrons/..your-patron-id../peoplesearches

POST https://signzy.tech/api/v2/patrons/..your-patron-id../peoplesearches

Headers

Key	Value
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.."
          }
      }

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

Error Codes

Error Code	Description
400	Bad Request - The request is missing a required parameter, or the parameter values are invalid.
401	Unauthorized - The API request is not authorized. The API key or token provided is either invalid or does not have sufficient permissions to perform the requested action.
403	Forbidden - The API request is forbidden. The API key or token provided is valid, but the account associated with the key or token does not have sufficient permissions to perform the requested action.
404	Not Found - The requested resource could not be found. This error is typically returned when the URL is incorrect or when the requested resource has been deleted or moved.
429	Too Many Requests - The request exceeds the rate limit for the API. This error is typically returned when the API client has sent too many requests within a certain period of time.
500	Internal Server Error - The server encountered an unexpected error while processing the request. This error is typically returned when there is a problem with the API server.
503	Service Unavailable - The API service is temporarily unavailable. This error is typically returned when the API server is undergoing maintenance or is overloaded with too many requests.