Identity Fill

introduction the identity fill api (us) enables the retrieval of verified customer information using minimal input—such as a phone number, dob, or ssn etc it is designed to streamline digital onboarding processes by auto filling application forms with accurate personal data, thereby reducing friction, minimizing manual errors, and significantly enhancing the overall user experience this api is especially useful in scenarios where rapid, secure identity verification is needed with minimal effort from the end user key benefits faster form completion with minimal input improved conversion rates by reducing drop offs during onboarding accurate data prefill, minimizing typos or misinformation reduced fraud risk by verifying identity from trusted sources common use cases digital onboarding for financial services prefill bank account opening, credit card, or loan applications using just phone number and ssn accelerate kyc (know your customer) checks for regulatory compliance e commerce & checkout optimization autofill shipping and billing information to reduce cart abandonment insurance application prefill populate insured's personal data (name, dob, address) to reduce form fatigue and improve submission rates telecom or utility service enrollment streamline sign up for phone, internet, or energy services using limited user input identity verification for gig or rental platforms prefill background check and id verification forms for faster user onboarding healthcare patient registration populate intake forms securely with verified identity data using ssn & phone, reducing administrative overhead sample curl curl location 'https //api signzy us/api/v3/us kyc/identity fill' \\ \ header 'authorization ' \\ \ header 'content type application/json' \\ \ data '{ "consentstatus" "optedin", "phonenumber" "2245074373", "dob" "1990 02 21", "ssn" "796619531", "last4" "9531" }' // production is not live as of now\ curl location 'https //api preproduction signzy us/api/v3/us kyc/identity fill' \\ \ header 'authorization ' \\ \ header 'content type application/json' \\ \ data '{ "consentstatus" "optedin", "phonenumber" "2245074373", "dob" "1990 02 21", "ssn" "796619531", "last4" "9531" }' request body parameters parameter data type required description consentstatus string required the consent status of the phone number possible values are optedin the end user has provided consent for the collection of their personal data optedout the end user has refused to allow collection of their personal data notcollected no attempt has been made to obtain consent from the end user unknown the status of consent collection is unknown phonenumber string required the phone number being queried (without leading plus sign & country code) dob string optional (any one out of dob/ssn/last4 is required) date of birth associated with the phone number accepts different formats iso 8601 (yyyy mm dd), month and year (mm/yyyy), or month and day (mm/dd) ssn string optional (any one out of dob/ssn/last4 is required) full 9 digits ssn number of the us citizen last4 string optional (any one out of dob/ssn/last4 is required) last 4 digit of ssn sample response { "result" { "requestid" "686298439d153a6c45f6e725", "description" "success ", "response" { "phonenumber" "12001001686", "countrycode" "us", "individual" { "firstname" "tod", "middlename" "", "lastname" "weedall", "addresses" \[ { "address" "39 south trail", "extendedaddress" "", "city" "san antonio", "region" "tx", "postalcode" "78285" } ], "ssn" "565228370", "dob" "1984 12 10" } } }, "status" "success", "reason" "request successful", "code" "s001" } response body parameters parameter data type description requestid string the requestid from the request, reflected back for tracking purposes description string a text string that defines the cause of the status code response object an object containing the phone number and associated details phonenumber string the phone number(s) associated with the individual countrycode string the country code it will always be "us" individual object the name object containing name details firstname string the first name of the individual associated with the phone number middlename string the middle name of the individual associated with the phone number lastname string the last name of the individual associated with the phone number addresses array of objects the address array containing address details it can contain multiple addresses objects address string the primary address line usually populated extendedaddress string the secondary address line populated for suites, apartments, boxes, departments, etc city string the city where the address is located region string the region or state where the address is located postalcode string the postal/zip code of the address dob string the date of birth associated with the phone number in yyyy mm dd format ssn string the social security number associated with the phone number sample error e601 internal server error { "result" {}, "reason" "internal server error", "status" "failure", "code" "e601" } e001 invalid regex { "result" {}, "status" "failure", "reason" "bad request \\"consentstatus\\" must be one of \[optedin, optedout, notcollected, unknown]", "code" "e001" } \ { "result" {}, "status" "failure", "reason" "bad request \\"dob\\" must be in yyyy mm dd format", "code" "e001" } \ { "result" {}, "status" "failure", "reason" "bad request \\"phonenumber\\" with value \\"\<value>\\" fails to match the required pattern /^(? \\\\+?\\\d{1,3}\\\s?)?\\\\(?\\\d{3}\\\\)?\[\\\s ]?\\\d{3}\[\\\s ]?\\\d{4}$/", "code" "e001" } \ { "result" {}, "status" "failure", "reason" "bad request \\"ssn\\" with value \\"\<value>\\" fails to match the required pattern /^(?!666|000|9\\\d{2})\\\d{3}(?!00)\\\d{2}(?!0{4})\\\d{4}$/", "code" "e001" } \ { "result" {}, "status" "failure", "reason" "bad request \\"last4\\" with value \\"\<value>\\" fails to match the required pattern /^\\\d{4}$/", "code" "e001" } e001 empty required field { "result" {}, "status" "failure", "reason" "bad request \\"phonenumber\\" is not allowed to be empty", "code" "e001" } \ { "result" {}, "status" "failure", "reason" "bad request at least one of dob, ssn, or last4 is required", "code" "e001" } e401 upstream failure { "result" {}, "reason" "upstream error", "status" "failure", "code" "e401" } e001 bad request { "result" {}, "status" "failure", "reason" "bad request", "code" "e001" } error response parameters parameter description result empty result object reason reason for error status s tatus of the api c ode error code from signzy error codes http status code error code description 400 e001 bad request 401 e1001 unauthorized access 403 e201 forbidden 404 e301 data not found 409 e401 upstream error 429 e501 rate limit exceeded 500 e601 internal server error 503 e701 service unavailable 504 e801 timeout success codes http status code success code description 200 s001 request successful 200 s003 data not found on source 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 help\@signzy com 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!