US Residential Verification

overview the us residential verification api enables businesses to verify an individual's name, date of birth, and address in the usa without requiring the social security number (ssn) or phone number this api offers a seamless and secure verification process, ensuring accurate identity validation for various applications key features no ssn required provides flexibility by not mandating ssn for verification optional phone number phone number is not a mandatory field comprehensive verification ensures all critical personal details are verified use cases banking and financial services streamline customer onboarding by verifying identity and address without needing ssn reduce fraud by ensuring accurate information during account creation e commerce verify customer information to prevent fraudulent transactions and ensure secure deliveries simplify account creation and checkout processes with easy verification telecommunications verify customer details for new account activations without the need for ssn ensure accurate billing and communication by verifying address information healthcare verify patient information to ensure accurate medical records simplify digital onboarding for new patients without requiring ssn api details to use this api, include an authorization token in your request header for secure access the endpoint is post https //api example com/us residential verification the api expects a json request body with personal details including name, date of birth, address, and optional phone number and ssn sample curl preproduction curl s l x post 'https //api preproduction signzy us/api/v3/global kyc verify/us/ssn' h 'authorization \<auth token>' h 'content type application/json' data raw '{ "firstname" "barbaraa", "lastname" "miller", "dateofbirth" "1974 08 21", "addressline1" "123 main st", "addressline3" "stratfordd", "addressline4" "ct", "addressline5" "06614", "emailaddress" "", "phonenumber" "", "identityinformation" { "nationalidnumber" "854125698" }, "consent" true }' production curl s l x post 'https //api signzy us/api/v3/global kyc verify/us/ssn' h 'authorization \<auth token>' h 'content type application/json' data raw '{ "firstname" "barbaraa", "lastname" "miller", "dateofbirth" "1974 08 21", "addressline1" "123 main st", "addressline3" "stratfordd", "addressline4" "ct", "addressline5" "06614", "emailaddress" "", "phonenumber" "", "identityinformation" { "nationalidnumber" "854125698" }, "consent" true }' api request body curl { "firstname" "barbaraa", "lastname" "miller", "dateofbirth" "1974 08 21", "addressline1" "123 main st", "addressline3" "stratfordd", "addressline4" "ct", "addressline5" "06614", "emailaddress" "", "phonenumber" "", "identityinformation" { "nationalidnumber" "854125698" }, "consent" true } request body parameters paramter name data type description mandatory / optional firstname string first name of individual mandatory middlename string middle name of individual optional lastname string last name of individual mandatory dateofbirth string date of birth of individual in yyyy mm dd format mandatory addressline1 string street level address of individual mandatory addressline3 string city of residence mandatory addressline4 string state of residence mandatory addressline5 string postal code associated with address mandatory nationalidnumber string social security number of individual, must be 9 digits looks optional emailaddress string email address optional phonenumber string 10 digit phone number of individual without country code optional consent boolean consent field mandatory response 200 { "result" { "verificationresult" { "firstname" true, "lastname" true, "dateofbirth" true, "addressline1" true, "addressline3" true, "addressline4" true, "addressline5" true, "phonenumber" "na", "emailaddress" "na", "nationalidnumber" true } } } response body parameters paramter name data type description firstname string the api returns a boolean value ("true" for a match found and "false" for no match found) based on the verification of the provided input data against authorized sources middlename string the api returns a boolean value ("true" for a match found and "false" for no match found) based on the verification of the provided input data against authorized sources lastname string the api returns a boolean value ("true" for a match found and "false" for no match found) based on the verification of the provided input data against authorized sources dateofbirth string the api returns a boolean value ("true" for a match found and "false" for no match found) based on the verification of the provided input data against authorized sources addressline1 string the api returns a boolean value ("true" for a match found and "false" for no match found) based on the verification of the provided input data against authorized sources addressline3 string the api returns a boolean value ("true" for a match found and "false" for no match found) based on the verification of the provided input data against authorized sources addressline4 string the api returns a boolean value ("true" for a match found and "false" for no match found) based on the verification of the provided input data against authorized sources addressline5 string the api returns a boolean value ("true" for a match found and "false" for no match found) based on the verification of the provided input data against authorized sources nationalidnumber string the api returns a boolean value ("true" for a match found and "false" for no match found) based on the verification of the provided input data against authorized sources emailaddress string the api returns a boolean value ("true" for a match found and "false" for no match found) based on the verification of the provided input data against authorized sources phonenumber string the api returns a boolean value ("true" for a match found and "false" for no match found) based on the verification of the provided input data against authorized sources error code mapping 400 (bad request) { "error" { "name" "error", "message" "bad input and description ", "status" 400, "reason" "validation error", "type" "bad request", "statuscode" 400 } } 401(unauthorized) { "error" { "name" "error", "message" "invalid authentication credentials", "status" 401, "reason" "authentication error", "type" "bad request", "statuscode" 401 } } 403 (forbidden) { "error" { "name" "error", "message" "forbidden", "reason" "error", "type" "bad request", "statuscode" "403" } } 500 (internal server error) { "error" { "name" "error", "message" "internal server error", "status" 500, "reason" "error", "type" "bad request", "statuscode" 500 } } 409(upstream down { "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 number http status code message string error message indicating an upstream error type string error type statuscode number 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!