United Kingdom Residential

4 min

data zoo’s proprietary opt in permission based marketing database for authorization get session token from authentication page name united kingdom residential method post url https idu test datazoo com api v2 verify description verification outcome returns kyc verification n consumer consent n a n mandatory input name and dob or address n verifies name address dob landline number mobile number and email address n returned data n a tab examples examples languages id f2jmy98siubrop0bgc788 language curl code curl location https idu staging datazoo com api v2 verify n header content type application json n header authorization bearer eyjhbgcioijsuzi1niisinr5cci6ikpxvcisimtpzci6immtbvzlml9krfhmcnkzaehqwen4tyj9 eyj1awqioiizmdmilcjvawqioii2miisimlzcyi6imh0dhbzoi8vzgf0yxpvby10zxn0lnvzlmf1dggwlmnvbs8ilcjzdwiioijhdxromhwzmdmilcjhdwqioijodhrwczovl2t5yy10zxn0lmrhdgf6b28uy29tiiwiawf0ijoxnzq0nzyzotkzlcjlehaioje3ndq3otk5otmsimd0esi6inbhc3n3b3jkiiwiyxpwijoiswxvdurjntf1qxpuvne2vgvorxayoxbrbehbsjftynkifq g4ptgs 19a4te7lpxt3siwsnyiqwt0wj59qch4igdzw8b6 4u4qclhdqvmftjcdruhocvw r7kocpne64iymmjnbutieihglsrwglhujirj 7orka7uji5w9qgmiodq5sljxcm9aemilcyilublui5f91mwhi7i8k1t6in4ovtf0zc fbe0fwdllrymcizn qxfa4klgpqtsritlcapkskfabifitffs od0hw kitpa wmfikhco1uijozy654 3weptw7vrd2c9l mqpqhvshlexjzglxljcstr8i9mlyocvgamhtp4hoat913r6tucdhdf6haxvovzywivqmwgw n data raw n countrycode gb n service n united kingdom residential n n clientreference test 0001 n firstname martin n lastname skidmore n dateofbirth 1962 04 24 n addresselement1 29 riverford crescent n addresselement2 conon bridge n addresselement3 dingwall n addresselement4 ross shire n addresselement5 iv7 8hl n identityvariables n landlineno 01461600548 n phoneno 07753640917 n email martin skidmore btconnect com n n customlabel selectedlanguageid f2jmy98siubrop0bgc788 results languages id kllvb jxqiuu wuwqaf language 200 customlabel code n countrycode united kingdom n clientreference test 0001 n reportingreference dz e00b7733 783d 4c71 a8ff a676b291afb8 n matchstatus full match 1 1 verification n searcherrormessage n safeharbour false n searchstatus successful n serviceresponses n united kingdom residential n status 0 n sourcestatus successful n errormessage n identityverified true n safeharbourscore m1 n namematchscore 1 000 n addressmatchscore 1 000 n verifications n addresselement1 true n addresselement2 true n addresselement3 true n addresselement4 true n addresselement5 true n dateofbirth true n email true n firstname true n landlineno true n lastname true n phoneno true n n returneddata n n n remarks n id as5tj4glqvhlg7b69q21j language 404 customlabel code n message ain t no cake like that n selectedlanguageid kllvb jxqiuu wuwqaf request pathparameters queryparameters headerparameters name authorization kind required type string description sessiontoken obtained via the authentication call sessiontoken obtained via the authentication call bodydataparameters name data kind required type object description request body sent to the api object children name countrycode kind required type string description gb name service kind required type array description united kingdom residential name clientreference kind optional type string description a client reference field name firstname kind required type string description the first name of the identity owner name lastname kind required type string description the last name of the identity owner name dateofbirth kind required type string description in yyyy mm dd preferred or dd mm yyyy format n conditional optional see note below children name addresselement1 kind required type string description the street level address of the identity owner n conditional optional see note below children name addresselement2 kind required type string description the village name of the address of the identity owner n conditional optional see note below name addresselement3 kind required type string description the town of the address of the identity owner n conditional optional see note below children name addresselement4 kind required type string description the county of the address of the identity owner n conditional optional see note below children name addresselement5 kind required type string description the postcode of the address of the identity owner n conditional optional see note below name identityvariables kind required type object description other elements for verification children name landlineno kind required type string description landline phone number of the identity owner n conditional optional see note below name phoneno kind required type string description mobile phone number of the identity owner n conditional optional see note below name email kind required type string description email address of the identity owner n conditional optional see note below schema name countrycode kind required type string description gb name service kind required type array description united kingdom residential name clientreference kind optional type string description a client reference field name firstname kind required type string description the first name of the identity owner name lastname kind required type string description the last name of the identity owner name dateofbirth kind required type string description in yyyy mm dd preferred or dd mm yyyy format n conditional optional see note below children name addresselement1 kind required type string description the street level address of the identity owner n conditional optional see note below children name addresselement2 kind required type string description the village name of the address of the identity owner n conditional optional see note below name addresselement3 kind required type string description the town of the address of the identity owner n conditional optional see note below children name addresselement4 kind required type string description the county of the address of the identity owner n conditional optional see note below children name addresselement5 kind required type string description the postcode of the address of the identity owner n conditional optional see note below name identityvariables kind required type object description other elements for verification children name landlineno kind required type string description landline phone number of the identity owner n conditional optional see note below name phoneno kind required type string description mobile phone number of the identity owner n conditional optional see note below name email kind required type string description email address of the identity owner n conditional optional see note below formdataparameters currentnewparameter label body parameter value bodydataparameters hastryitout false response name countrycode kind optional type string description united kingdom children name clientreference kind optional type string description the client reference if given as input children name reportingreference kind optional type string description a reference number generated which is unique to each transaction children name validationerrors kind optional type string description returned with http status code 400 when the request contains invalid or improperly formatted input data children name matchstatus kind optional type string description full match 1 1 verification n no match name searcherrormessage kind optional type string description error message returned querying the data source children name safeharbour kind optional type boolean description true or false children name searchstatus kind optional type string description successful n not successful children name serviceresponses kind optional type object description verification details with united kingdom residential returned as the service identifier children name status kind optional type integer description 0 identityverified true element verifications all true n1 identityverified true element verifications not all true n2 identityverified false sourcestatus successful n3 identityverified false sourcestatus not successful name sourcestatus kind optional type string description successful n not successful name errormessage kind optional type string description error message s from the data source example error querying data source name identityverified kind optional type boolean description true or false name safeharbourscore kind optional type string description m1 m2 n1 or none n for more information refer to safe harbour scores page name namematchscore kind optional type string description a string that acts as a value between 0 000 and 1 000 name addressmatchscore kind optional type string description a string that acts as a value between 0 000 and 1 000 name verifications kind optional type object description element level verification returned as true or false n only applicable elements will be included and not all elements may be present children name addresselement1 kind optional type boolean description name addresselement2 kind optional type boolean description name addresselement3 kind optional type boolean description name addresselement4 kind optional type boolean description name addresselement5 kind optional type boolean description name dateofbirth kind optional type boolean description name email kind optional type boolean description name firstname kind optional type boolean description name landlineno kind optional type boolean description name lastname kind optional type boolean description name phoneno kind optional type boolean description name returneddata kind optional type object description null children name remarks kind optional type array description will return remarks regarding any encountered issues or pre validation errors children mandatory input in addition to name t he request must contain firstname and lastname plus one other field at a minimum example firstname , lastname and dateofbirth or firstname , lastname and phoneno links