New Zealand DIA Passport

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 passport method post url https idu test datazoo com api v2 verify description verification outcome returns kyc verification n consumer consent yes n mandatory input name dob passport number and passport expiry date n verifies name dob and passport 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 eyjpc3mioij0zxn0iiwiawf0ijoxnzqyndizndm4lcjpcgeioiiznc4xnteumte3lji0osisinvpzci6mzazlcjvawqiojyylcjsawqioju1odcynjasimv4cci6mtc0mjq1mjizocwiyxvkijoiahr0chm6ly9pzhuuzgf0yxpvby5jb20ifq vgw6tl6bi4jztyyea11xv6z4rye nibm7uruaz7itavwxynekkpqpk4fcdfyoz ktwwy 5aitrx5ilzyju0gag n data n countrycode nz n service n new zealand dia passport n n clientreference test 0001 n firstname southland n middlename n lastname stags n dateofbirth 1980 12 12 n identityvariables n passportno lz115041 n t t passportexpiry 2017 10 10 n n t consentobtained n new zealand dia passport 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 38c0520a d02a 40c5 920e 87b965f8db98 n matchstatus full match 1 1 verification n searcherrormessage n safeharbour false n searchstatus successful n serviceresponses n new zealand dia passport n status 0 n sourcestatus successful n errormessage n identityverified true n safeharbourscore l2 n namematchscore 1 000 n addressmatchscore n a n verifications n dateofbirth true n firstname true n lastname true n passportno 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 passport 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 identityvariables kind required type object description other elements for verification children name passportno kind required type string description passport number name passportexpiry kind required type string description passport expiry date nin yyyy mm dd format name consentobtained kind required type object description consent given by the identity owner children name new zealand dia passport 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 passport 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 identityvariables kind required type object description other elements for verification children name passportno kind required type string description passport number name passportexpiry kind required type string description passport expiry date nin yyyy mm dd format name consentobtained kind required type object description consent given by the identity owner children name new zealand dia passport 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 passport 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 m2 l2 l5 or none n for more information refer to safe harbour scores page name namematchscore kind optional type string description 1 000 matched n 0 500 partial match 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 passportno 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