New Zealand DIA Citizenship

4 min

verifies input data against new zealand government agency (department of internal affairs) for authorization get session token from authentication page name new zealand dia citizenship 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 n verifies name 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 eyj1awqioiizmdmilcjvawqioii2miisimlzcyi6imh0dhbzoi8vzgf0yxpvby10zxn0lnvzlmf1dggwlmnvbs8ilcjzdwiioijhdxromhwzmdmilcjhdwqioijodhrwczovl2t5yy10zxn0lmrhdgf6b28uy29tiiwiawf0ijoxnzq3mtgxnta1lcjlehaioje3ndcymtc1mdusimd0esi6inbhc3n3b3jkiiwiyxpwijoiswxvdurjntf1qxpuvne2vgvorxayoxbrbehbsjftynkifq hta 3 cb2osod0lu3zidnfpmockzoeqwlk5r6ypgaypfejtfmpoo zwqd1p srpwahxyfksvtmcyflrdl4n1jwzrk9wajprb6evp8wxstidtqollm8ju5pvaerlq4bzjjhqhueywdpjvruskxotwn8htevdg0at6 ln xznz mk7qim lgtvyy4adom4tenkw2pcdrmqb0gsqdkn8imyiqh7t3t2cqtrw trctbsr57cgnt5k6grrkpxdtytabcyvzdyfcoiors ciicyxmtqns4 cw7r7coralgjrhnfj1tbbw29tma49wnqkhseviuwkheewsp3orwf9n a fw0q n data n countrycode nz n service n new zealand dia citizenship n n clientreference test 0001 n firstname sarah n middlename jennifer n lastname fields n dateofbirth 1980 03 29 n consentobtained n new zealand dia citizenship 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 1886eff7 05e6 4630 9e96 d53fecc4e69d n matchstatus full match 1 1 verification n searcherrormessage n safeharbour false n searchstatus successful n serviceresponses n new zealand dia citizenship n status 0 n sourcestatus successful n errormessage n identityverified true n safeharbourscore m2 n namematchscore 1 000 n addressmatchscore n a n verifications n dateofbirth true n firstname true n lastname true n middlename 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 dia citizenship 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 required type string description the middle name s of the identity owner n conditional optional see note below 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 name consentobtained kind required type object description consent given by the identity owner children name new zealand dia citizenship 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 dia citizenship 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 required type string description the middle name s of the identity owner n conditional optional see note below 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 name consentobtained kind required type object description consent given by the identity owner children name new zealand dia citizenship 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 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 dia citizenship returned as the service identifier children name status kind optional type integer description 0 identityverified true element verifications 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 m2 or none n for more information refer to safe harbour scores page name namematchscore kind optional type string description 1 000 matched n 0 000 no match name addressmatchscore kind optional type string description n a name verifications kind optional type object description element level verification returned as true or false children name dateofbirth kind optional type boolean description name firstname kind optional type boolean description name lastname kind optional type boolean description name middlename kind optional type boolean description name returneddata kind optional type object description null children name remarks kind optional type array description null children mandatory and conditional optional input for name last name ( lastname ) and first name ( lastname ) input are required middle name(s) ( middlename ) must be given if present on the birth document links