Global Verification SSN Verification API

4 min

Introduction

This API allows you to perform SSN (Social Security Number) Verification on a user. The API takes in essential user details like SSN, given name, family name, date of birth, address, city, state, zip code, and phone number as input and returns verification results as output.

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":"ssnVerification","essentials":{"ssn":"...ssn...","givenName":"...givenName...","familyName":"...familyName...","address":"...address...","city":"...city...","state":"...state...","zipcode":"...zipcode...","dateOfBirth":"...dateOfBirth...","phoneNumber":"...phoneNumber..."}}'

Parameter	Description	Type	Value
task	The type of verification to be performed	String	Compulsory. Example: ssnVerification
essentials	The input parameters required for SSN verification	Object	Compulsory.
ssn	The social security number to be verified	String	Compulsory. Example: "123-45-6789"
givenName	The first name of the person whose SSN is being verified	String	Compulsory. Example: "John"
familyName	The last name of the person whose SSN is being verified	String	Compulsory. Example: "Doe"
address	The residential address of the person whose SSN is being verified	String	Compulsory. Example: "123 Main Street"
city	The city of the residential address of the person whose SSN is being verified	String	Compulsory. Example: "New York"
state	The state of the residential address of the person whose SSN is being verified	String	Compulsory. Example: "NY"
zipcode	The zip code of the residential address of the person whose SSN is being verified	String	Compulsory. Example: "10001"
dateOfBirth	The date of birth of the person whose SSN is being verified in YYYY-MM-DD format	String	Compulsory. Example: "1990-01-01"
phoneNumber	The phone number of the person whose SSN is being verified	String	Compulsory. Example: "555-555-5555"

Sample API Response

  {
	"result": {
            "result" : "Match/No Match/Partial Match",
            "message": [
                        {"message": "...message...",
                        "description": "...description..."}
                       ]
             }
   }

Parameter	Description	Type	Value
result	The result of the API request which includes the verification result.	Object	Compulsory.
result.result	Verification result which can be Match, No Match or Partial Match.	String	Example: "Match"
result.message	Information message which includes the message and its description.	Array	Example: [{"message": "...message...", "description": "...description..."}]