UK Residential Check

overview the global kyc citizen check 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/citizen check' \\ \ header 'authorization < auth token >' \\ \ header 'content type application/json' \\ \ data raw '{ "firstname" "john", "lastname" "doe", "dateofbirth" "1967 06 15", "addressline1" "7 cromhall close", "addressline3" "fareham", "addressline5" "aa1 xx0", "emailaddress" "dz3\@email com", "consent" true }' production curl location 'https //api signzy app/api/v3/global kyc/verify/gb/citizen check' \\ \ header 'authorization < auth token >' \\ \ header 'content type application/json' \\ \ data raw '{ "firstname" "john", "lastname" "doe", "dateofbirth" "1967 06 15", "addressline1" "7 cromhall close", "addressline3" "fareham", "addressline5" "aa1 xx0", "emailaddress" "dz3\@email com", "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) yes addressline1 string primary residential address line yes addressline3 string city or locality part of the address yes addressline5 string postal code yes emailaddress string email address of the individual yes consent boolean consent from the individual for verification yes successful response { "result" { "verificationresult" { "firstname" true, "lastname" true, "dateofbirth" true, "address" true, "addressscore" 0 63 }, "verificationstatus" "verified/not verified/partially verified", "reason" "reason" "all elements verified/dob not verified/nid not verified/address not verified" } } response body parameter parameter type description verificationresult object container for detailed results of the verification firstname boolean result of the first name verification lastname boolean result of the last name verification dateofbirth boolean result of the date of birth verification address boolean result of the address verification addressscore float numerical score (0 1) representing the address match quality verificationstatus string overall status of the verification ("verified" or "not verified") reason string explanation of the verification results error code and response 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 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!