New Zealand Residential

4 min

data zoo’s proprietary opt in permission based marketing database for authorization get session token from authentication page name new zealand 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 address n verifies name address dob mobile and landline phone number n returned data n a tab examples examples languages id f2jmy98siubrop0bgc788 language curl code curl location https idu test datazoo com api v2 verify n header content type application json n header authorization bearer eyjhbgcioijiuzuxmiisinr5cci6ikpxvcj9 eyjpc3mioij0zxn0iiwiawf0ijoxnzqymzq4nda1lcjpcgeioiiznc4xnteumte3lji0osisinvpzci6mzazlcjvawqiojyylcjsawqioju1odizotgsimv4cci6mtc0mjm3nziwnswiyxvkijoiahr0chm6ly9pzhuuzgf0yxpvby5jb20ifq 48l8e5qw1mluyfu3y8lyq6yvxdpsj eqg3vkbvp9x q8b5xv1mohy8awm7qxij1adpqhfqclgw6qhubcwu6pga n data n countrycode nz n service n new zealand residential n n clientreference test 0001 n firstname elliot n middlename n lastname bish n dateofbirth 2001 01 01 n addresselement1 24 asquith avenue n addresselement3 mount albert n addresselement4 auckland n addresselement5 1025 n identityvariables n phoneno 0211544103 n landlineno 098150611 n n customlabel selectedlanguageid f2jmy98siubrop0bgc788 results languages id kllvb jxqiuu wuwqaf language 200 customlabel code n countrycode new zealand n clientreference test 0001 n reportingreference dz da812e36 9119 4dd2 920b 1705e35bd87e n matchstatus full match 1 1 verification n searcherrormessage n safeharbour false n searchstatus successful n serviceresponses n new zealand residential n status 0 n sourcestatus successful n errormessage n identityverified true n safeharbourscore n1 n namematchscore 1 000 n addressmatchscore 1 000 n verifications n addresselement1 true n addresselement3 true n addresselement4 true n addresselement5 true n firstname true n landlineno true n lastname true n phoneno true n n returneddata n dpid 578086 n 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 nz name service kind required type array description new zealand 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 middlename kind optional type string description the middle name s of the identity owner name lastname kind required type string description the last name of the identity owner name dateofbirth kind optional type string description in yyyy mm dd preferred or dd mm yyyy format name addresselement1 kind required type string description the street level address of the identity owner name addresselement3 kind required type string description the suburb address of the identity owner n conditional optional see note below name addresselement4 kind required type string description the state address of the identity owner n conditional optional see note below name addresselement5 kind required type string description the postcode of the address of the identity owner n conditional optional see note below children name identityvariables kind optional type object description other elements for verification children name phoneno kind optional type string description mobile phone number name landlineno kind optional type string description landline phone number schema name countrycode kind required type string description nz name service kind required type array description new zealand 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 middlename kind optional type string description the middle name s of the identity owner name lastname kind required type string description the last name of the identity owner name dateofbirth kind optional type string description in yyyy mm dd preferred or dd mm yyyy format name addresselement1 kind required type string description the street level address of the identity owner name addresselement3 kind required type string description the suburb address of the identity owner n conditional optional see note below name addresselement4 kind required type string description the state address of the identity owner n conditional optional see note below name addresselement5 kind required type string description the postcode of the address of the identity owner n conditional optional see note below children name identityvariables kind optional type object description other elements for verification children name phoneno kind optional type string description mobile phone number name landlineno kind optional type string description landline phone number formdataparameters currentnewparameter label body parameter value bodydataparameters hastryitout false response name countrycode kind optional type string description new zealand 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 new zealand 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 unsuccessful 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 or n1 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 n n a 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 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 firstname kind optional type boolean description name landlineno kind optional type boolean description name lastname kind optional type boolean description name middlename kind optional type boolean description name phoneno kind optional type boolean description name returneddata kind optional type object description returns additional data from the data source children name dpid kind optional type string description delivery point identifier of the address name remarks kind optional type array description null children mandatory input for address for address input addresselement1 is required along with either addresselement3 or addresselement4 or addresselement5 must be provided as input links