US Contact Enrichment

Overview
The US Contact Enrichment API offers a nuanced and efficient way to enhance contact data by providing enriched information about individuals from partial inputs. Ideal for applications that require detailed and accurate contact details—including alternate names, phone numbers, and email addresses—this API supports a variety of use cases from identity verification to detailed background checks.
Designed to work with diverse data combinations, it facilitates a more targeted approach to data enrichment, helping users identify and connect with individuals effectively. With its dynamic capabilities, the API is a subtle yet powerful tool for businesses and organizations looking to deepen their understanding of contacts and improve data integrity.
Use Cases
Identity Verification: Verify and enrich partial personal data with additional details like phone numbers and email addresses.
Data Augmentation: Enhance customer records by filling in missing information, such as alternate names and contact details.
Fraud Detection: Identify potential fraud by cross-referencing input data with enriched details, including inconsistencies in personal identifiers.
API Details
Request Body
Preproduction
Production
curl --location 'https://api.signzy.us/api/v3/us-api/contact-enrichment' \
--header 'Content-Type: application/json' \
--header 'Authorization: <----Auth Token---->' \
--data '{
    "firstName": "Alex",
    "middleName": "M.",
    "lastName": "Hernandez",
    "phoneNumber": "(555) 123-4567",
    "dob": "1982-07-15",
    "age": "41",
    "ssn": "123-45-6789",
    "email": "[email protected]",
    "county": "Los Angeles",
    "addresses": [
        {
            "addressLine1": "123 Main St",
            "addressLine2": "Apt 4"
        }
    ]
}'
curl --location 'https://api.signzy.us/api/v3/us-api/contact-enrichment' \
--header 'Content-Type: application/json' \
--header 'Authorization: <----Auth Token---->' \
--data '{
    "firstName": "Alex",
    "middleName": "M.",
    "lastName": "Hernandez",
    "phoneNumber": "(555) 123-4567",
    "dob": "1982-07-15",
    "age": "41",
    "ssn": "123-45-6789",
    "email": "alex.m.hernandez@example.com",
    "county": "Los Angeles",
    "addresses": [
        {
            "addressLine1": "123 Main St",
            "addressLine2": "Apt 4"
        }
    ]
}'
﻿
Request Body Parameters
Input
Data Type
Mandatory/Optional
Description
firstName
String
Mandatory
The first name of the person.
middleName
String
Optional
The middle name of the person.
lastName
String
Mandatory
The last name of the person.
phoneNumber
String
Optional
The phone number associated with the person.
dob
String
Optional
The date of birth of the person.
age
String
Optional
The age of the person.
ssn
String
Optional
The Social Security Number of the person.
email
String
Optional
The email address associated with the person.
county
String
Optional
The county where the person resides.
addresses
Array
Optional
An array containing address information associated with the person.
addressLine1
String
Optional
The first line of the address.
addressLine2
String
Optional
The second line of the address.
Response Body
Successful Response
{{
  "result": {
    "persons": [
      {
        "personId": "G-8219339141256427730",
        "name": {
          "firstName": "Alex",
          "middleName": "",
          "lastName": "Hernandez",
          "suffix": "",
          "rawNames": ["HERNANDEZ,ALEX"],
          "publicFirstSeenDate": "1/1/1970",
          "totalFirstSeenDate": "1/1/1970",
          "sourceSummary": null
        },
        "isPublic": true,
        "isOptedOut": false,
        "sparseFlag": 0,
        "isPremium": false,
        "dob": "",
        "age": 67,
        "dobFirstSeen": "11/1/1989",
        "dobLastSeen": "7/3/2024",
        "akas": [
          {
            "firstName": "Alexander",
            "middleName": "",
            "lastName": "Hernandez",
            "suffix": "",
            "rawNames": ["HERNANDEZ,ALEXANDER"],
            "publicFirstSeenDate": "1/1/1970",
            "totalFirstSeenDate": "1/1/1970",
            "sourceSummary": null
          }
        ],
        "phoneNumbers": [
          {
            "phoneNumber": "(708) 516-0045",
            "company": "Sprint Spectrum LP",
            "location": "CHICAGO, IL",
            "phoneType": "Wireless",
            "isConnected": true,
            "isPublic": true,
            "latitude": "41.78616",
            "longitude": "-87.79604",
            "phoneOrder": 1,
            "firstReportedDate": "10/1/2010",
            "lastReportedDate": "7/1/2024",
            "publicFirstSeenDate": "1/1/1970",
            "totalFirstSeenDate": "1/1/1970",
            "sourceSummary": null
          }
        ],
        "emailAddresses": [
          {
            "emailAddress": "[email protected]",
            "emailOrdinal": 2,
            "isPremium": true,
            "nonBusiness": 1,
            "sourceSummary": null
          }
        ],
        "fullName": "Alex Hernandez",
        "driversLicenseDetail": [],
        "hasAdditionalData": false,
        "propensityToPayScore": {
          "transactionId": "",
          "suffix": "",
          "firstName": "",
          "middleName": "",
          "lastName": "",
          "address": "",
          "city": "",
          "state": "",
          "zip": "",
          "zip4": "",
          "measures": []
        }
      }
    ],
    "counts": {
      "searchResults": 5,
      "searchResultsOverflow": false,
      "names": 67,
      "phoneNumbers": 25,
      "emailAddresses": 25
    },
    "isError": false,
    "error": {
      "inputErrors": [],
      "warnings": []
    }
  }
}
{{
  "result": {
    "persons": [
      {
        "personId": "G-8219339141256427730",
        "name": {
          "firstName": "Alex",
          "middleName": "",
          "lastName": "Hernandez",
          "suffix": "",
          "rawNames": ["HERNANDEZ,ALEX"],
          "publicFirstSeenDate": "1/1/1970",
          "totalFirstSeenDate": "1/1/1970",
          "sourceSummary": null
        },
        "isPublic": true,
        "isOptedOut": false,
        "sparseFlag": 0,
        "isPremium": false,
        "dob": "",
        "age": 67,
        "dobFirstSeen": "11/1/1989",
        "dobLastSeen": "7/3/2024",
        "akas": [
          {
            "firstName": "Alexander",
            "middleName": "",
            "lastName": "Hernandez",
            "suffix": "",
            "rawNames": ["HERNANDEZ,ALEXANDER"],
            "publicFirstSeenDate": "1/1/1970",
            "totalFirstSeenDate": "1/1/1970",
            "sourceSummary": null
          }
        ],
        "phoneNumbers": [
          {
            "phoneNumber": "(708) 516-0045",
            "company": "Sprint Spectrum LP",
            "location": "CHICAGO, IL",
            "phoneType": "Wireless",
            "isConnected": true,
            "isPublic": true,
            "latitude": "41.78616",
            "longitude": "-87.79604",
            "phoneOrder": 1,
            "firstReportedDate": "10/1/2010",
            "lastReportedDate": "7/1/2024",
            "publicFirstSeenDate": "1/1/1970",
            "totalFirstSeenDate": "1/1/1970",
            "sourceSummary": null
          }
        ],
        "emailAddresses": [
          {
            "emailAddress": "flextex17@gmail.com",
            "emailOrdinal": 2,
            "isPremium": true,
            "nonBusiness": 1,
            "sourceSummary": null
          }
        ],
        "fullName": "Alex Hernandez",
        "driversLicenseDetail": [],
        "hasAdditionalData": false,
        "propensityToPayScore": {
          "transactionId": "",
          "suffix": "",
          "firstName": "",
          "middleName": "",
          "lastName": "",
          "address": "",
          "city": "",
          "state": "",
          "zip": "",
          "zip4": "",
          "measures": []
        }
      }
    ],
    "counts": {
      "searchResults": 5,
      "searchResultsOverflow": false,
      "names": 67,
      "phoneNumbers": 25,
      "emailAddresses": 25
    },
    "isError": false,
    "error": {
      "inputErrors": [],
      "warnings": []
    }
  }
}
﻿
Response Body Parameters
﻿
Output
Data Type
Description
personId
String
Unique identifier assigned to the person.
name
Object
Contains details about the person's name, including first, middle, last, suffix, and raw name formats.
isPublic
Boolean
Indicates whether the person's information is publicly accessible.
isOptedOut
Boolean
Shows whether the person has opted out of sharing their data.
sparseFlag
Integer
Indicates the completeness of the data record (0 for complete).
isPremium
Boolean
Indicates whether the data is from a premium source.
dob
String
The date of birth of the person, if available.
age
Integer
The age of the person.
dobFirstSeen
String
The earliest recorded instance of the person’s date of birth in the database.
dobLastSeen
String
The most recent recorded instance of the person's date of birth in the database.
akas
Array
Array of alternate names or aliases associated with the person.
phoneNumbers
Array
List of phone numbers associated with the person, including type and location details.
emailAddresses
Array
List of email addresses associated with the person.
fullName
String
The full name of the person as recorded.
driversLicenseDetail
Array
Details regarding the person's driver's license, if available.
hasAdditionalData
Boolean
Indicates whether there is additional data available for the person.
propensityToPayScore
Object
Contains metrics related to the person’s propensity to pay, such as credit scores.
Counts Object
﻿
﻿
searchResults
Integer
Total number of search results returned.
searchResultsOverflow
Boolean
Indicates whether the search results exceeded the system's maximum output capacity.
names
Integer
Count of names found in the search.
phoneNumbers
Integer
Count of phone numbers found in the search.
emailAddresses
Integer
Count of email addresses found in the search.
Error Object
﻿
﻿
isError
Boolean
Indicates if there was an error during the processing of the request.
inputErrors
Array
List of errors related to input fields if any errors occurred during processing.
warnings
Array
Warnings generated during the processing of the request, typically non-critical.
Error Code Response & Mapping
400(Bad Request)
409(Upstream Down)
404(Data not found)
{
  "error": {
     "name": "error",
     "message": "Upstream Down",
     "status": 409,
     "reason": "ERROR",
     "type": "Bad Request",
     "statusCode": 409
  }
}
{
  "error": {
     "name": "error",
     "message": "Upstream Down",
     "status": 409,
     "reason": "ERROR",
     "type": "Bad Request",
     "statusCode": 409
  }
}
﻿
Field
Type
Description
name
string
Text displayed on the screen explaining error type.
reason
string
Reason for the error.
status
message
type
statusCode
number
string
string
number
HTTP status code.
Error message indicating an upstream error.
Error type.
Status code representing the error scenario.
﻿
Getting help
Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.
You can reach out to us at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.
We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!
﻿

Input	Data Type	Mandatory/Optional	Description
firstName	String	Mandatory	The first name of the person.
middleName	String	Optional	The middle name of the person.
lastName	String	Mandatory	The last name of the person.
phoneNumber	String	Optional	The phone number associated with the person.
dob	String	Optional	The date of birth of the person.
age	String	Optional	The age of the person.
ssn	String	Optional	The Social Security Number of the person.
email	String	Optional	The email address associated with the person.
county	String	Optional	The county where the person resides.
addresses	Array	Optional	An array containing address information associated with the person.
addressLine1	String	Optional	The first line of the address.
addressLine2	String	Optional	The second line of the address.

Output	Data Type	Description
personId	String	Unique identifier assigned to the person.
name	Object	Contains details about the person's name, including first, middle, last, suffix, and raw name formats.
isPublic	Boolean	Indicates whether the person's information is publicly accessible.
isOptedOut	Boolean	Shows whether the person has opted out of sharing their data.
sparseFlag	Integer	Indicates the completeness of the data record (0 for complete).
isPremium	Boolean	Indicates whether the data is from a premium source.
dob	String	The date of birth of the person, if available.
age	Integer	The age of the person.
dobFirstSeen	String	The earliest recorded instance of the person’s date of birth in the database.
dobLastSeen	String	The most recent recorded instance of the person's date of birth in the database.
akas	Array	Array of alternate names or aliases associated with the person.
phoneNumbers	Array	List of phone numbers associated with the person, including type and location details.
emailAddresses	Array	List of email addresses associated with the person.
fullName	String	The full name of the person as recorded.
driversLicenseDetail	Array	Details regarding the person's driver's license, if available.
hasAdditionalData	Boolean	Indicates whether there is additional data available for the person.
propensityToPayScore	Object	Contains metrics related to the person’s propensity to pay, such as credit scores.
Counts Object
searchResults	Integer	Total number of search results returned.
searchResultsOverflow	Boolean	Indicates whether the search results exceeded the system's maximum output capacity.
names	Integer	Count of names found in the search.
phoneNumbers	Integer	Count of phone numbers found in the search.
emailAddresses	Integer	Count of email addresses found in the search.
Error Object
isError	Boolean	Indicates if there was an error during the processing of the request.
inputErrors	Array	List of errors related to input fields if any errors occurred during processing.
warnings	Array	Warnings generated during the processing of the request, typically non-critical.

Field	Type	Description
name	string	Text displayed on the screen explaining error type.
reason	string	Reason for the error.
status message type statusCode	number string string number	HTTP status code. Error message indicating an upstream error. Error type. Status code representing the error scenario.

Did this page help you?

US DL Verification

UK Residential Check