Advanced Search

6 min

Introduction

The Advanced Search API allows you to search for a person's information based on their identity and address details. You can retrieve information such as full name, national ID, date of birth, email address, and phone number.

Sample cURL

curl --request POST \
  --url https://signzy.tech/api/v2/patrons/..your-patron-id../globalverifications \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'Authorization: <Access-Token>' \
  --header 'content-type: application/json' \
  --data '{
    "task": "advancedSearch",
    "essentials": {
        "identity": {
            "fullName": "..fullName..",
            "firstName": "..firstName..",
            "lastName": "..lastName..",
            "nationalId": "..nationalId..",
            "dob": "..dob..",
            "emailAddress": "..emailAddress..",
            "countryCode": "..countryCode..",
            "phoneNumber": "..phoneNumber..",
            "idType": "...idType(by default-0)..."
        },
        "address": {
            "addressLine1": "..addressLine1..",
            "addressLine2": "..addressLine2..",
            "houseNumber": "..houseNumber..",
            "city": "..city..",
            "state": "..state..",
            "postalCode": "..postalCode.."
        }
    }
}'

Input Parameters

Parameter	Description	Type	Required
fullName	Full name of the person	String	Optional
firstName	First name of the person	String	Optional
lastName	Last name of the person	String	Optional
nationalId	National ID of the person	String	Compulsory
dob	Date of birth of the person in YYYY-MM-DD format	String	Optional
emailAddress	Email address of the person	String	Optional
countryCode	Country code of the person	String	Compulsory
idType	Type of NationalId to be Given	String	Optional
phoneNumber	Phone number of the person	String	Optional
addressLine1	Address line 1 of the person	String	Optional
addressLine2	Address line 2 of the person	String	Optional
houseNumber	House number of the person	String	Optional
city	City of the person	String	Optional
state	State of the person	String	Optional
postalCode	Postal code of the person	String	Compulsory

ID Type

ID TYPE	DESCRIPTION
0	Government or Tax ID number for the business in the country. This is the default
1	Passport Number for the individual in the country
3	Medicare card or local country health card number
4	Driving License Number
5	Passport VISA number

Sample Response

{
    "result": {
        "result": "Full Match/No Match/Partial Match",
        "verificationDetails": {
            "fullName": "...full match/partial match/No match on datasources...",
            "firstName": "...full match/partial match/No match on datasources...",
            "lastName": "...full match/partial match/No match on datasources...",
            "nationalId": "...full match/partial match/No match on datasources...",
            "address": "...full match/partial match/No match on datasources...",
            "postalCode": "...full match/partial match/No match on datasources...",
            "city": "...full match/partial match/No match on datasources...",
            "houseNumber": "...full match/partial match/No match on datasources...",
            "dob": "...full match/partial match/No match on datasources...",
            "thoroughfare": "...full match/partial match/No match on datasources...",
            "phoneNumber": "...full match/partial match/No match on datasources...",
            "emailAddress": "...full match/partial match/No match on datasources..."
        }
    }
}

Response Parameters

Parameter	Description
result	The overall result of the verification: Full Match/No Match/Partial Match
verificationDetails.fullName	Indicates if the full name matches the data sources: Full Match/Partial Match/No Match
verificationDetails.firstName	Indicates if the first name matches the data sources: Full Match/Partial Match/No Match
verificationDetails.lastName	Indicates if the last name matches the data sources: Full Match/Partial Match/No Match
verificationDetails.nationalId	Indicates if the national ID matches the data sources: Full Match/Partial Match/No Match
verificationDetails.address	Indicates if the address matches the data sources: Full Match/Partial Match/No Match
verificationDetails.postalCode	Indicates if the postal code matches the data sources: Full Match/Partial Match/No Match
verificationDetails.city	Indicates if the city matches the data sources: Full Match/Partial Match/No Match
verificationDetails.houseNumber	Indicates if the house number matches the data sources: Full Match/Partial Match/No Match
verificationDetails.dob	Indicates if the date of birth matches the data sources: Full Match/Partial Match/No Match
verificationDetails.thoroughfare	Indicates if the thoroughfare matches the data sources: Full Match/Partial Match/No Match
verificationDetails.phoneNumber	Indicates if the phone number matches the data sources: Full Match/Partial Match/No Match
verificationDetails.emailAddress	Indicates if the email address matches the data sources: Full Match/Partial Match/No Match