APAC
New Zealand
New Zealand Death Check
4 min
data zoo’s proprietary opt in permission based new zealand deceased records data source for authorization get session token from authentication page name new zealand death check method post url https idu test datazoo com api v2 verify description verification outcome flags if the individual is deceased n consumer consent n a n mandatory input name and address n verifies name and address n returned data elements providing specific information regarding the status and details of the deceased record 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 death check n n clientreference test 0001 n firstname testfirstname n lastname testlastname n addresselement1 101 deep creek road n addresselement3 waiake n addresselement4 auckland n addresselement5 0630 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 c0a2e38e 0b5e 44b4 8344 74a4381104b3 n matchstatus full match 1 1 verification n searcherrormessage n safeharbour false n searchstatus successful n serviceresponses n new zealand death check n status 0 n sourcestatus successful n errormessage n identityverified true n safeharbourscore none 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 lastname true n n returneddata n dateofdeath 2023 06 19 n possibledeceasedrecord true n possibledeceasedrecordaddress 101 deep creek road waiake auckland 0630 n possibledeceasedrecordname testfirstname testlastname 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 death check 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 addresselement1 kind required type string description the street level address of the identity owner n conditional optional see note below 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 schema name countrycode kind required type string description nz name service kind required type array description new zealand death check 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 addresselement1 kind required type string description the street level address of the identity owner n conditional optional see note below 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 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 death check 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 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 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 firstname kind optional type boolean description name lastname kind optional type boolean description name returneddata kind optional type object description returns additional data from the data source children name dateofdeath kind optional type string description the recorded date of death for the individual name possibledeceasedrecord kind optional type boolean description a boolean true false indicating whether there is a potential deceased record for the individual name possibledeceasedrecordaddress kind optional type string description the address associated with the possible deceased record name possibledeceasedrecordname kind optional type string description the full name associated with the possible deceased record name remarks kind optional type array description will return remarks regarding any encountered issues 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