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 curl location 'https //api preproduction 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" } ] }' 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" "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" "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) { "error" { "name" "error", "message" "bad input and description ", "status" 400, "reason" "validation error", "type" "bad request", "statuscode" 400 } } 409(upstream down) { "error" { "name" "error", "message" "upstream down", "status" 409, "reason" "error", "type" "bad request", "statuscode" 409 } } 404(data not found) { "error" { "name" "error", "message" "data not found", "status" 400, "reason" "erro", "type" "not found", "statuscode" 400 } } 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 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!