SSN Verification
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..."
}
}'Input Parameters
{
"result": {
"result": "Match/No Match/Partial Match",
"message": [
{
"message": "...message...",
"description": "...description..."
}
]
}
}Response Parameters
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..."}] |