Composite Searching

composite search in new zealand enables clients to automate the selection of multiple services, processing verification inputs through successive data sources and returning responses from each selected service example 1 api requests and responses with following four services configured new zealand companies office new zealand credit bureau new zealand linz property new zealand residential { "name" "new zealand composite search (example 1)", "method" "post", "url" "https //idu test datazoo com/api/v2/verify", "description" " verification outcome – kyc verification from composite searching and returns single or duel source matches\n consumer consent – yes (for new zealand credit bureau)\n mandatory input – name, dob and address\n verifies – name, address, dob and other input elements given for verification\n returned data type of data source, service identifier and other service related data (if applicable) \n", "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 eyjpc3mioij0zxn0iiwiawf0ijoxnzqynzgymdqylcjpcgeioiiznc4xnteumte3lji0osisinvpzci6mzazlcjvawqiojyylcjsawqioju2mta0otesimv4cci6mtc0mjgxmdg0miwiyxvkijoiahr0chm6ly9pzhuuzgf0yxpvby5jb20ifq piwacfhrsl0cv7ch5lymxkhv01cr7rswb9wjbgthgvgr ikb0q2hwfmy64mwekhf ou1dpzqtsug4ivr yihgq' \\\\\n data '{\n \\"countrycode\\" \\"nz\\",\n \\"service\\" \[ \n \\"new zealand companies office\\",\n \\"new zealand credit bureau\\",\n \\"new zealand linz property\\",\n \\"new zealand residential\\"\n ],\n \\"clientreference\\" \\"testcomposite 0001\\",\n \\"firstname\\" \\"southland\\",\n \\"middlename\\" \\"\\",\n \\"lastname\\" \\"stags\\",\n \\"dateofbirth\\" \\"1980 12 12\\",\n \\"addresselement1\\" \\"1 mercury street\\", \n \\"addresselement3\\" \\"milson\\", \n \\"addresselement4\\" \\"manawatu\\", \n \\"addresselement5\\" \\"4414\\", \n \\"identityvariables\\" {\n \\"passportno\\" \\"lz115041\\",\n \\"passportexpiry\\" \\"2017 10 10\\",\n \\"driverslicenceno\\" \\"db512036\\", \n \\"driverslicenceversion\\" \\"001\\" \n },\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\\" \\"testcomposite 0001\\",\n \\"reportingreference\\" \\"dz 16813d47 1363 4c2f a7a2 6c410a56731d\\",\n \\"matchstatus\\" \\"full match 1+1 verification\\",\n \\"searcherrormessage\\" \\"\\",\n \\"safeharbour\\" false,\n \\"searchstatus\\" \\"successful\\",\n \\"serviceresponses\\" {\n \\"new zealand companies office\\" {\n \\"status\\" 2,\n \\"sourcestatus\\" \\"successful\\",\n \\"errormessage\\" \\"\\",\n \\"identityverified\\" false,\n \\"safeharbourscore\\" \\"none\\",\n \\"namematchscore\\" \\"n/a\\",\n \\"addressmatchscore\\" \\"n/a\\",\n \\"verifications\\" {},\n \\"returneddata\\" {}\n },\n \\"new zealand credit bureau\\" {\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 \\"new zealand linz property\\" {\n \\"status\\" 2,\n \\"sourcestatus\\" \\"successful\\",\n \\"errormessage\\" \\"\\",\n \\"identityverified\\" false,\n \\"safeharbourscore\\" \\"none\\",\n \\"namematchscore\\" \\"n/a\\",\n \\"addressmatchscore\\" \\"n/a\\",\n \\"verifications\\" {\n \\"addresselement1\\" false,\n \\"addresselement3\\" false,\n \\"addresselement4\\" false,\n \\"addresselement5\\" false,\n \\"dateofbirth\\" false,\n \\"firstname\\" false,\n \\"lastname\\" false\n },\n \\"returneddata\\" {}\n },\n \\"new zealand residential\\" {\n \\"status\\" 2,\n \\"sourcestatus\\" \\"successful\\",\n \\"errormessage\\" \\"\\",\n \\"identityverified\\" false,\n \\"safeharbourscore\\" \\"none\\",\n \\"namematchscore\\" \\"n/a\\",\n \\"addressmatchscore\\" \\"n/a\\",\n \\"verifications\\" {},\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 companies office\\", \\"new zealand credit bureau\\", \\"new zealand linz property\\", \\"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" "required", "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" "optional", "type" "string", "description" "the suburb address of the identity owner" }, { "name" "addresselement4", "kind" "optional", "type" "string", "description" "the state address of the identity owner" }, { "name" "addresselement5", "kind" "required", "type" "string", "description" "the postcode of the address of the identity owner", "children" \[] }, { "name" "identityvariables", "kind" "optional", "type" "object", "description" "other elements for verification", "children" \[ { "name" "phoneno", "kind" "optional", "type" "string", "description" "phone number of the identity owner" }, { "name" "email", "kind" "optional", "type" "string", "description" "email address of the identity owner" } ] }, { "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 companies office\\", \\"new zealand credit bureau\\", \\"new zealand linz property\\", \\"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" "required", "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" "optional", "type" "string", "description" "the suburb address of the identity owner" }, { "name" "addresselement4", "kind" "optional", "type" "string", "description" "the state address of the identity owner" }, { "name" "addresselement5", "kind" "required", "type" "string", "description" "the postcode of the address of the identity owner", "children" \[] }, { "name" "identityvariables", "kind" "optional", "type" "object", "description" "other elements for verification", "children" \[ { "name" "phoneno", "kind" "optional", "type" "string", "description" "phone number of the identity owner" }, { "name" "email", "kind" "optional", "type" "string", "description" "email address of the identity owner" } ] }, { "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" "returened with http status code 400 when there is input validation error", "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" " refer to the section at the bottom of the page titled \\"service responses overview\\"", "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" " refer to the section at the bottom of the page titled \\"service responses overview\\"\n for more information, refer to safe harbour scores page" }, { "name" "namematchscore", "kind" "optional", "type" "string", "description" " refer to the section at the bottom of the page titled \\"service responses overview\\"" }, { "name" "addressmatchscore", "kind" "optional", "type" "string", "description" " refer to the section at the bottom of the page titled \\"service responses overview\\"" }, { "name" "verifications", "kind" "optional", "type" "object", "description" " refer to the section at the bottom of the page titled \\"service responses overview\\"", "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" "email", "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" " refer to the section at the bottom of the page titled \\"service responses overview\\"", "children" \[ { "name" "category", "kind" "optional", "type" "string", "description" "data source type or category (example, telco, consumer etc)" }, { "name" "source", "kind" "optional", "type" "string", "description" "identifies the data source used " } ] } ] }, { "name" "remarks", "kind" "optional", "type" "array", "description" "will return remarks regarding any encountered issues or pre validation errors ", "children" \[] } ] } example 2 api requests and responses with following four services configured new zealand dia passport new zealand driver licence new zealand consumer new zealand credit bureau { "name" "new zealand composite search (example 2)", "method" "post", "url" "https //idu test datazoo com/api/v2/verify", "description" " verification outcome – kyc verification from sequenced searching and returns single or duel (where possible) source matches\n consumer consent – yes (passport, credit bureau and driver licence)\n mandatory input – name and address\n verifies – name, address, dob and other input elements given for verification\n returned data type of data source, service identifier and other service related data (if applicable) ", "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 eyjpc3mioij0zxn0iiwiawf0ijoxnzqynzgymdqylcjpcgeioiiznc4xnteumte3lji0osisinvpzci6mzazlcjvawqiojyylcjsawqioju2mta0otesimv4cci6mtc0mjgxmdg0miwiyxvkijoiahr0chm6ly9pzhuuzgf0yxpvby5jb20ifq piwacfhrsl0cv7ch5lymxkhv01cr7rswb9wjbgthgvgr ikb0q2hwfmy64mwekhf ou1dpzqtsug4ivr yihgq' \\\\\n data raw '{\n \\"countrycode\\" \\"nz\\",\n \\"service\\" \[\n \\"new zealand dia passport\\",\n \\"new zealand driver licence\\",\n \\"new zealand consumer\\",\n \\"new zealand credit bureau\\"\n ],\n \\"clientreference\\" \\"testcomposite 0002\\",\n \\"firstname\\" \\"dana\\", \n \\"middlename\\" null, \n \\"lastname\\" \\"mitchell\\", \n \\"dateofbirth\\" \\"1965 09 13\\", \n \\"addresselement1\\" \\"101 deep creek road\\",\n \\"addresselement3\\" \\"waiake\\",\n \\"addresselement4\\" \\"auckland\\",\n \\"addresselement5\\" \\"0630\\",\n \\"identityvariables\\" {\n \\"passportno\\" \\"lz115041\\",\n \\"passportexpiry\\" \\"2017 10 10\\",\n \\"driverslicenceno\\" \\"db512036\\", \n \\"driverslicenceversion\\" \\"001\\", \n \\"phoneno\\" \\"204004506\\",\n \\"email\\" \\"consumer2nz\@datatest com\\"\n },\n \\"consentobtained\\" {\n \\"new zealand credit bureau\\" true,\n \\"new zealand dia passport\\" true,\n \\"new zealand driver licence\\" true\n }\n}'", "customlabel" "" } ], "selectedlanguageid" "f2jmy98siubrop0bgc788" }, "results" { "languages" \[ { "id" " kllvb jxqiuu wuwqaf", "language" "200", "customlabel" "", "code" "{\n \\"countrycode\\" \\"new zealand\\",\n \\"clientreference\\" \\"testcomposite 0002\\",\n \\"reportingreference\\" \\"dz d64ee741 b52f 4d12 bf79 c49e37eeab68\\",\n \\"matchstatus\\" \\"full match 2+2 verification\\",\n \\"searcherrormessage\\" \\"\\",\n \\"safeharbour\\" true,\n \\"searchstatus\\" \\"successful\\",\n \\"serviceresponses\\" {\n \\"new zealand consumer\\" {\n \\"status\\" 2,\n \\"sourcestatus\\" \\"successful\\",\n \\"errormessage\\" \\"\\",\n \\"identityverified\\" false,\n \\"safeharbourscore\\" \\"none\\",\n \\"namematchscore\\" \\"1 000\\",\n \\"addressmatchscore\\" \\"0 000\\",\n \\"verifications\\" {\n \\"addresselement3\\" false,\n \\"addresselement4\\" false,\n \\"addresselement5\\" false,\n \\"dateofbirth\\" false,\n \\"email\\" false,\n \\"firstname\\" true,\n \\"lastname\\" true,\n \\"phoneno\\" false\n },\n \\"returneddata\\" {}\n },\n \\"new zealand credit bureau\\" {\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 \\"new zealand dia passport\\" {\n \\"status\\" 2,\n \\"sourcestatus\\" \\"successful\\",\n \\"errormessage\\" \\"\\",\n \\"identityverified\\" false,\n \\"safeharbourscore\\" \\"l5\\",\n \\"namematchscore\\" \\"0 000\\",\n \\"addressmatchscore\\" \\"n/a\\",\n \\"verifications\\" {\n \\"dateofbirth\\" false,\n \\"firstname\\" false,\n \\"lastname\\" false,\n \\"passportno\\" true\n },\n \\"returneddata\\" {}\n },\n \\"new zealand driver licence\\" {\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 \\"driverslicenceno\\" true,\n \\"driverslicenceversion\\" 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 dia passport\\", \\"new zealand driver licence\\", \\"new zealand consumer\\", \\"new zealand credit bureau\\"" }, { "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" "required", "type" "string", "description" "in yyyy mm dd (preferred) or dd mm yyyy format" }, { "name" "addresselement1", "kind" "optional", "type" "string", "description" "the street level address of the identity owner" }, { "name" "addresselement3", "kind" "optional", "type" "string", "description" "the suburb address of the identity owner" }, { "name" "addresselement4", "kind" "optional", "type" "string", "description" "the state address of the identity owner" }, { "name" "addresselement5", "kind" "optional", "type" "string", "description" "the postcode of the address of the identity owner\n", "children" \[] }, { "name" "identityvariables", "kind" "required", "type" "object", "description" "other elements for verification", "children" \[ { "name" "passportno", "kind" "required", "type" "string", "description" "" }, { "name" "passportexpiry", "kind" "required", "type" "string", "description" "" }, { "name" "driverslicenceno", "kind" "required", "type" "string", "description" "" }, { "name" "driverslicenceversion", "kind" "required", "type" "string", "description" "" }, { "name" "phoneno", "kind" "optional", "type" "string", "description" "" }, { "name" "email", "kind" "optional", "type" "string", "description" "" } ] }, { "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" }, { "name" "new zealand dia passport", "kind" "required", "type" "boolean", "description" "should be true" }, { "name" "new zealand driver licence", "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\\", \\"new zealand driver licence\\", \\"new zealand consumer\\", \\"new zealand credit bureau\\"" }, { "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" "required", "type" "string", "description" "in yyyy mm dd (preferred) or dd mm yyyy format" }, { "name" "addresselement1", "kind" "optional", "type" "string", "description" "the street level address of the identity owner" }, { "name" "addresselement3", "kind" "optional", "type" "string", "description" "the suburb address of the identity owner" }, { "name" "addresselement4", "kind" "optional", "type" "string", "description" "the state address of the identity owner" }, { "name" "addresselement5", "kind" "optional", "type" "string", "description" "the postcode of the address of the identity owner\n", "children" \[] }, { "name" "identityvariables", "kind" "required", "type" "object", "description" "other elements for verification", "children" \[ { "name" "passportno", "kind" "required", "type" "string", "description" "" }, { "name" "passportexpiry", "kind" "required", "type" "string", "description" "" }, { "name" "driverslicenceno", "kind" "required", "type" "string", "description" "" }, { "name" "driverslicenceversion", "kind" "required", "type" "string", "description" "" }, { "name" "phoneno", "kind" "optional", "type" "string", "description" "" }, { "name" "email", "kind" "optional", "type" "string", "description" "" } ] }, { "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" }, { "name" "new zealand dia passport", "kind" "required", "type" "boolean", "description" "should be true" }, { "name" "new zealand driver licence", "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" "returened with http status code 400 when there is input validation error", "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" "\\"\\"\nerror 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\\"unsuccessful\\"", "children" \[] }, { "name" "serviceresponses", "kind" "optional", "type" "object", "description" " refer to the section at the bottom of the page titled \\"service responses overview\\"", "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" "\\"\\"\nerror 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" " refer to the section at the bottom of the page titled \\"service responses overview\\"\n for more information, refer to safe harbour scores page" }, { "name" "namematchscore", "kind" "optional", "type" "string", "description" " refer to the section at the bottom of the page titled \\"service responses overview\\"" }, { "name" "addressmatchscore", "kind" "optional", "type" "string", "description" " refer to the section at the bottom of the page titled \\"service responses overview\\"" }, { "name" "verifications", "kind" "optional", "type" "object", "description" " refer to the section at the bottom of the page titled \\"service responses overview\\"", "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" "driverslicenceno", "kind" "optional", "type" "boolean", "description" "" }, { "name" "driverslicenceversion", "kind" "optional", "type" "boolean", "description" "" }, { "name" "email", "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" "phoneno", "kind" "optional", "type" "boolean", "description" "" } ] }, { "name" "returneddata", "kind" "optional", "type" "object", "description" "null\n refer to the section at the bottom of the page titled \\"service responses overview\\"", "children" \[] } ] }, { "name" "remarks", "kind" "optional", "type" "array", "description" "will return remarks regarding any encountered issues or pre validation errors ", "children" \[] } ] } service responses overview each service returns its own self contained response block, ensuring modular and source specific verification results consumers of this api should handle varying response structures dynamically based on the requested services service responses element the serviceresponses object in the api response contains verification results from one or more data sources, structured under their respective service names each service (e g , "new zealand residential" , "new zealand credit bureau" from example 1) returns a distinct response block with service specific data structure and behavior each key within serviceresponses corresponds to a service name , representing an individual verification source services may return data from a single source or multiple sources in a sequenced api call the structure of each service response varies, with fields such as status , identityverified , and safeharbourscore differing between services the verifications block contains service specific boolean indicators for individual verification checks (e g , addresselement1 , dateofbirth , firstname ) the returneddata block provides metadata (if applicable)