New Zealand Utility

4 min

verifies input data against utility and credit header data obtained from the partnered sources from new zealand for authorization get session token from authentication page name new zealand utility method post url https idu test datazoo com api v2 verify description verification outcome returns kyc verification can return single or duel source verification n consumer consent yes n mandatory input name and address n verifies name address and dob 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 eyjhbgcioijsuzi1niisinr5cci6ikpxvcisimtpzci6immtbvzlml9krfhmcnkzaehqwen4tyj9 eyj1awqioiizmdmilcjvawqioii2miisimlzcyi6imh0dhbzoi8vzgf0yxpvby10zxn0lnvzlmf1dggwlmnvbs8ilcjzdwiioijhdxromhwzmdmilcjhdwqioijodhrwczovl2t5yy10zxn0lmrhdgf6b28uy29tiiwiawf0ijoxnzuwmzg1otkylcjlehaioje3nta0mje5otisimd0esi6inbhc3n3b3jkiiwiyxpwijoiswxvdurjntf1qxpuvne2vgvorxayoxbrbehbsjftynkifq c9ici7yfuyve qk750aggwu3y5f4s8v790fzgbf9p12yulbykkitvglgvg9xxgx jx i9rsc8dg yltpc8fdqznybgz33vhv28 uxctwlzwoxtx9dipdu boxtfvaimgj3abgum6tm3fglmu26p3z007ii3wpf0zrn9rppjgjnd3pt0xpgscb97d22zjzpjbw93deoaa7asvcn2wdxotvrdnybdgdwscyr2t2xi7e uybk5us5gwert hzcwj3prv3rxgihdqx7xmvhkof2nk7ihbioj e3b6k5ylvgw flzihxlaouimi6qtp4eatokalltgst9xz4b3op0uq9ig n data n countrycode nz n service n new zealand credit bureau n new zealand utility n n clientreference test 0001 n firstname montgomery n middlename george n lastname mercury n dateofbirth 1980 01 01 n addresselement1 8 dillon bell road n addresselement3 whataupoko n addresselement4 gisborne n addresselement5 4010 n consentobtained n new zealand credit bureau true 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 4af96072 214f 49a0 b591 97e6f3685de6 n matchstatus full match 2 2 verification n searcherrormessage n safeharbour true n searchstatus successful n serviceresponses n new zealand credit bureau 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 addresselement3 true n addresselement4 true n addresselement5 true n dateofbirth true n firstname true n lastname true n n returneddata n n new zealand utility n status 1 n sourcestatus successful n errormessage n identityverified true n safeharbourscore m2 n namematchscore 1 000 n addressmatchscore n a n verifications n addresselement1 false n addresselement3 false n addresselement4 false n addresselement5 false n dateofbirth true n firstname true n lastname 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 nz name service kind required type array description new zealand credit bureau n new zealand utility 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 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 addresselement2 kind optional type string description the extended part of street level address if present 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 children name addresselement5 kind required type string description the postcode of the address of the identity owner n conditional optional see note below children name consentobtained kind required type object description consent given by the identity owner children name new zealand credit bureau kind required type boolean description should be true schema name countrycode kind required type string description nz name service kind required type array description new zealand credit bureau n new zealand utility 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 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 addresselement2 kind optional type string description the extended part of street level address if present 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 children name addresselement5 kind required type string description the postcode of the address of the identity owner n conditional optional see note below children name consentobtained kind required type object description consent given by the identity owner children name new zealand credit bureau kind required type boolean description should be true 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 full match 2 2 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 both new zealand credit bureau and new zealand utility are returned as the service identifiers at the individual service level 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 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 firstname kind optional type boolean description name lastname kind optional type boolean description name returneddata kind optional type object description null children 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