Standard Search

5 min

Introduction

The API allows users to perform identity and address verification of an individual. With this API, users can verify personal information such as full name, date of birth, national ID, and address details such as address line 1, address line 2, house number, city, state, and postal code.

To use this API, users need to send a POST request to the API endpoint with relevant information in the request body. The API returns a response with the verification results, which includes a result flag and a message with a description.

Sample cURL Request

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": "standardSearch",
    "essentials": {
        "identity": {
            "fullName": "..fullName..",
            "firstName": "..firstName..",
            "lastName": "..lastName..",
            "nationalId": "..nationalId..",
            "dob": "..dob..",
            "countryCode": "..countryCode.."
        },
        "address": {
            "addressLine1": "..addressLine1..",
            "addressLine2": "..addressLine2..",
            "houseNumber": "..houseNumber..",
            "city": "..city..",
            "state": "..state..",
            "postalCode": "..postalCode.."
        }
    }
}'

Request Parameters

Parameter	Description	Type	Value
task	Type of search to be performed	String	Compulsory. Example: "standardSearch"
essentials	Object containing the input data for search operation	Object	Compulsory
identity	Object containing the identity details of the person to be searched	Object	Compulsory
fullName	Full name of the person	String	Optional. Example: "John Doe"
firstName	First name of the person	String	Optional. Example: "John"
lastName	Last name of the person	String	Optional. Example: "Doe"
nationalId	National ID of the person	String	Optional. Example: "123456789"
dob	Date of birth of the person in YYYY-MM-DD format	String	Optional. Example: "1980-01-01"
countryCode	ISO Alpha-2 country code of the person's country of residence	String	Optional. Example: "US"
address	Object containing the address details of the person to be searched	Object	Optional
addressLine1	Address line 1 of the person's address	String	Optional. Example: "123 Main Street"
addressLine2	Address line 2 of the person's address	String	Optional. Example: "Apt 4B"
houseNumber	House number of the person's address	String	Optional. Example: "123"
city	City of the person's address	String	Optional. Example: "New York"
state	State of the person's address	String	Optional. Example: "NY"
postalCode	Postal code of the person's address	String	Optional. Example: "10001"

Sample Response

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

Response Parameters

Parameter	Description	Type	Value
result	The result of the verification process	Object	Compulsory
result.result	The final result of the verification process	String	Possible values: "Full Match", "Partial Match", "No Match"
result.verificationDetails	The details of the verification process	Object	Compulsory
result.verificationDetails.fullName	Full name matched on the datasource	String	Possible values: "Full Match", "Partial Match", "No Match"
result.verificationDetails.firstName	First name matched on the datasource	String	Possible values: "Full Match", "Partial Match", "No Match"
result.verificationDetails.lastName	Last name matched on the datasource	String	Possible values: "Full Match", "Partial Match", "No Match"
result.verificationDetails.nationalId	National ID matched on the datasource	String	Possible values: "Full Match", "Partial Match", "No Match"
result.verificationDetails.gender	Gender matched on the datasource	String	Possible values: "Full Match", "Partial Match", "No Match"
result.verificationDetails.address	Address matched on the datasource	String	Possible values: "Full Match", "Partial Match", "No Match"
result.verificationDetails.postalCode	Postal code matched on the datasource	String	Possible values: "Full Match", "Partial Match", "No Match"
result.verificationDetails.city	City matched on the datasource	String	Possible values: "Full Match", "Partial Match", "No Match"
result.verificationDetails.houseNumber	House number matched on the datasource	String	Possible values: "Full Match", "Partial Match", "No Match"
result.verificationDetails.dob	Date of birth matched on the datasource	String	Possible values: "Full Match", "Partial Match", "No Match"
result.verificationDetails.thoroughfare	Thoroughfare matched on the datasource	String	Possible values: "Full Match", "Partial Match", "No Match"