UK Residential KYC

overview the uk residential kyc api for great britain provides an automated way to verify the personal and residential details of uk citizens this api is designed to confirm the accuracy of provided information against authoritative databases, aiding in identity verification and compliance with regulatory standards usecase this api is particularly valuable for financial services banks and other financial institutions can use this api to verify identity details during account opening, loan applications, or customer record updates employment background checks companies performing pre employment screening can verify the personal details of potential hires government services government agencies can verify citizen details for program eligibility or document issuance api details request body preproduction curl location 'https //api preproduction signzy app/api/v3/global kyc/verify/gb/residential check' \\ \ header 'content type application/json' \\ \ header 'authorization < auth token >' \\ \ data raw '{ "firstname" "john", "lastname" "doe", "dateofbirth" "1962 01 10", "addressline1" "", "addressline2" "conon bridge", "addressline3" "dingwall", "addressline4" "ross shire", "addressline5" "", "emailaddress" "martin \@xyz com", "landlineno" "4401461600849", "phoneno" "4401461600549", "consent" true }' production curl location 'https //api signzy app/api/v3/global kyc/verify/gb/residential check' \\ \ header 'content type application/json' \\ \ header 'authorization < auth token >' \\ \ data raw '{ "firstname" "john", "lastname" "doe", "dateofbirth" "1962 01 10", "addressline1" "", "addressline2" "conon bridge", "addressline3" "dingwall", "addressline4" "ross shire", "addressline5" "", "emailaddress" "martin \@xyz com", "landlineno" "4401461600849", "phoneno" "4401461600549", "consent" true }' request body parameters parameter type description required firstname string first name of the individual yes lastname string last name of the individual yes dateofbirth date date of birth (format yyyy mm dd) dob or anyone of the address lines is mandatory addressline1 string primary residential address line dob or anyone of the address lines is mandatory addressline2 string sub locality, village, hamlet, or a more specific area within the main town/city dob or anyone of the address lines is mandatory addressline3 string city or locality part of the address dob or anyone of the address lines is mandatory addressline4 string county dob or anyone of the address lines is mandatory addressline5 string postal code regex postcodes range from 5 to 7 characters in length and include both letters and numbers dob or anyone of the address lines is mandatory emailaddress string email address of the individual no landlineno string landline number of the individual regex it must be 10 13 digits with the country code (e g , +44 or 44) no phoneno string mobile number of the individual regex it must be 10 13 digits with the country code (e g , +44 or 44) no consent boolean consent from the individual for verification no successful response { "result" { "namematchscore" "1 00", "addressmatchscore" "0 25", "verificationresult" { "firstname" "true", "lastname" "true", "dateofbirth" "true", "addressline1" "", "addressline2" "true", "addressline3" "true", "addressline4" "true", "addressline5" "false", "phoneno" "false", "landlineno" "true", "emailaddress" "false" } }, "reason" "request successful", "code" "s001" } response body parameter parameter type description namematchscore string name match score addressmatchscore string address match score verificationresult object container for detailed results of the verification firstname string result of the first name verification lastname string result of the last name verification dateofbirth string result of the date of birth verification addressline1 string result of the address line1 verification addressline2 string result of the address line2 verification addressline3 string result of the address line3 verification addressline4 string result of the address line4 verification addressline5 string result of the address line5 verification phoneno string result of the phone number verification landlineno string result of the landline number verification emailaddress string result of the email address verification reason string explanation of the verification results code string response code sample error e601 internal server error { "result" {}, "reason" "internal server error", "code" "e601" } e003 invalid regex { "result" {}, "reason" "landline number must be between 10 13 digits, including the country code (e g , +44 or 44)", "code" "e003" } \ { "result" {}, "reason" "phone number must be between 10 13 digits, including the country code (e g , +44 or 44)", "code" "e003" } \ { "result" {}, "reason" "please provide a valid email address ", "code" "e003" } \ { "result" {}, "reason" "invalid date please use a valid date ", "code" "e003" } e003 empty required field { "result" {}, "reason" "dob or address is mandatory", "code" "e003" } e401 upstream failure { "result" {}, "reason" "upstream error", "code" "e401" } 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 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!