APAC
Australia
Sequenced Searching
4 min
sequenced searching in australia can be configured for clients upon request when making sequenced calls for australia, the api input for the service must be set to "australia residential" example 1 api requests and responses with following four services configured australia citizens australia consumer australia credit bureau australia residential { "name" "australia sequenced search (example 1)", "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 (for australia 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 raw '{\n \\"countrycode\\" \\"au\\",\n \\"service\\" \[\n \\"australia residential\\"\n ],\n \\"clientreference\\" \\"testsequencing 0001\\",\n \\"firstname\\" \\"grant\\",\n \\"middlename\\" \\"eric\\",\n \\"lastname\\" \\"brook\\",\n \\"dateofbirth\\" \\"1973 10 24\\",\n \\"addresselement1\\" \\"52 happyvally rd\\",\n \\"addresselement3\\" \\"ironbark\\",\n \\"addresselement4\\" \\"vic\\",\n \\"addresselement5\\" \\"3551\\",\n \\"consentobtained\\" {\n \\"australia credit bureau\\" true\n },\n \\"identityvariables\\" {\n \\"phoneno\\" \\"0411111111\\",\n \\"email\\" \\"testemail\@datazoo com\\"\n }\n}\n'", "customlabel" "curl" } ], "selectedlanguageid" "f2jmy98siubrop0bgc788" }, "results" { "languages" \[ { "id" " kllvb jxqiuu wuwqaf", "language" "200", "customlabel" "", "code" "{\n \\"countrycode\\" \\"australia\\",\n \\"clientreference\\" \\"testsequencing 0001\\",\n \\"reportingreference\\" \\"dz bfc3d6d1 7c90 4e14 83d9 f7a42b786132\\",\n \\"matchstatus\\" \\"full match 1+1 verification\\",\n \\"searcherrormessage\\" \\"\\",\n \\"safeharbour\\" false,\n \\"searchstatus\\" \\"successful\\",\n \\"serviceresponses\\" {\n \\"australia 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 \\"middlename\\" true\n },\n \\"returneddata\\" {\n \\"category\\" \\"credit\\",\n \\"source\\" \\"dz2\\"\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" "au" }, { "name" "service", "kind" "required", "type" "array", "description" "australia 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" "required", "type" "string", "description" "the suburb address of the identity owner" }, { "name" "addresselement4", "kind" "required", "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\n", "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" "australia credit bureau", "kind" "required", "type" "boolean", "description" "should be true" } ] } ], "schema" \[ { "name" "countrycode", "kind" "required", "type" "string", "description" "au" }, { "name" "service", "kind" "required", "type" "array", "description" "australia 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" "required", "type" "string", "description" "the suburb address of the identity owner" }, { "name" "addresselement4", "kind" "required", "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\n", "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" "australia 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" "australia", "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" " 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 australia passport australia medicare card australia citizens australia consumer { "name" "australia sequenced 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 (for australia passport, australia driver licence and australia medicare card)\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 eyjhbgcioijsuzi1niisinr5cci6ikpxvcisimtpzci6immtbvzlml9krfhmcnkzaehqwen4tyj9 eyj1awqioiizmdmilcjvawqioii2miisimlzcyi6imh0dhbzoi8vzgf0yxpvby10zxn0lnvzlmf1dggwlmnvbs8ilcjzdwiioijhdxromhwzmdmilcjhdwqioijodhrwczovl2t5yy10zxn0lmrhdgf6b28uy29tiiwiawf0ijoxnzq4odiwmtm2lcjlehaioje3ndg4ntyxmzysimd0esi6inbhc3n3b3jkiiwiyxpwijoiswxvdurjntf1qxpuvne2vgvorxayoxbrbehbsjftynkifq osfi7e0icd3sdqxgnzkjraxhpcifuwednoahfmqpjpkrjyeqoaowjxkw2izzt6t1cj5vrkikojne8vbphborvfta73fqgnk egimpzusgko oogmfoqtsbsnphum2mllagxk0x78 ygtsovzciycdldnm8wmosvg vfxwbe2 oov9icncsd6vrdx21fp2k5bvpdlhlfhzexjmeb7robnrj7gro0thtfqpbr gf77nktxhpdlolyo9l0vdtkagql6pcwc 5sg64 jk2tpxg85 p7qmy4zcyibqhzmn1ot4xcrkdq4xkcdjj nhloysnto bq1gorwskcagdpoxaw2la' \\\\\n data raw '{\n \\"countrycode\\" \\"au\\",\n \\"service\\" \[\n \\"australia residential\\"\n ],\n \\"clientreference\\" \\"testsandboxsequencing 0001\\",\n \\"firstname\\" \\"jane\\",\n \\"middlename\\" \\"\\",\n \\"lastname\\" \\"citizen\\",\n \\"dateofbirth\\" \\"1984 07 06\\",\n \\"addresselement1\\" \\"52 happyvally rd\\",\n \\"addresselement3\\" \\"ironbark\\",\n \\"addresselement4\\" \\"vic\\",\n \\"addresselement5\\" \\"3551\\",\n \\"consentobtained\\" {\n \\"australia passport\\" true,\n \\"australia medicare card\\" true \n },\n \\"identityvariables\\" {\n \\"passportno\\" \\"pa0940443\\",\n \\"medicarecardtype\\" \\"g\\", \n \\"medicareexpiry\\" \\"2022 12 01\\", \n \\"medicarecardno\\" \\"3512743581\\", \n \\"medicarereferenceno\\" 1, \n \\"medicarenameline1\\" \\"jane citizen\\", \n \\"phoneno\\" \\"0411111111\\",\n \\"email\\" \\"testemail\@datazoo com\\"\n }\n}\n'", "customlabel" "" } ], "selectedlanguageid" "f2jmy98siubrop0bgc788" }, "results" { "languages" \[ { "id" " kllvb jxqiuu wuwqaf", "language" "200", "code" "{\n \\"countrycode\\" \\"australia\\",\n \\"clientreference\\" \\"testsandboxsequencing 0001\\",\n \\"reportingreference\\" \\"dz df105596 93a1 454c a83b f8d36bbe5c66\\",\n \\"matchstatus\\" \\"full match 2+2 verification\\",\n \\"searcherrormessage\\" \\"\\",\n \\"safeharbour\\" true,\n \\"searchstatus\\" \\"successful\\",\n \\"serviceresponses\\" {\n \\"australia government identity documents 2\\" {\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 \\"documentno\\" true,\n \\"firstname\\" true,\n \\"lastname\\" true\n },\n \\"returneddata\\" {\n \\"category\\" \\"government\\",\n \\"source\\" \\"dz8\\"\n }\n },\n \\"australia government identity documents 3\\" {\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 \\"documentno\\" true,\n \\"fullname\\" true\n },\n \\"returneddata\\" {\n \\"category\\" \\"government\\",\n \\"source\\" \\"dz9\\"\n }\n }\n },\n \\"remarks\\" \[]\n}", "customlabel" "" }, { "id" "as5tj4glqvhlg7b69q21j", "language" "404", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n}", "customlabel" "" } ], "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" "au" }, { "name" "service", "kind" "required", "type" "array", "description" "australia 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" "gender", "kind" "optional", "type" "string", "description" "male or female" }, { "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" "optional", "type" "string", "description" "phone number of the identity owner" }, { "name" "medicarecardtype", "kind" "required", "type" "string", "description" "" }, { "name" "medicareexpiry", "kind" "required", "type" "string", "description" "" }, { "name" "medicarecardno", "kind" "required", "type" "string", "description" "" }, { "name" "medicarereferenceno", "kind" "required", "type" "integer", "description" "" }, { "name" "phoneno", "kind" "optional", "type" "string", "description" "" }, { "name" "email", "kind" "optional", "type" "string", "description" "" }, { "name" "medicarenameline1", "kind" "optional", "type" "string", "description" "" }, { "name" "medicarenameline2", "kind" "optional", "type" "string", "description" "" }, { "name" "medicarenameline3", "kind" "optional", "type" "string", "description" "" }, { "name" "medicarenameline4", "kind" "optional", "type" "string", "description" "" } ] }, { "name" "consentobtained", "kind" "required", "type" "object", "description" "consent given by the identity owner", "children" \[ { "name" "australia passport", "kind" "required", "type" "boolean", "description" "should be true" }, { "name" "australia medicare card", "kind" "required", "type" "boolean", "description" "" } ] } ], "schema" \[ { "name" "countrycode", "kind" "required", "type" "string", "description" "au" }, { "name" "service", "kind" "required", "type" "array", "description" "australia 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" "gender", "kind" "optional", "type" "string", "description" "male or female" }, { "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" "optional", "type" "string", "description" "phone number of the identity owner" }, { "name" "medicarecardtype", "kind" "required", "type" "string", "description" "" }, { "name" "medicareexpiry", "kind" "required", "type" "string", "description" "" }, { "name" "medicarecardno", "kind" "required", "type" "string", "description" "" }, { "name" "medicarereferenceno", "kind" "required", "type" "integer", "description" "" }, { "name" "phoneno", "kind" "optional", "type" "string", "description" "" }, { "name" "email", "kind" "optional", "type" "string", "description" "" }, { "name" "medicarenameline1", "kind" "optional", "type" "string", "description" "" }, { "name" "medicarenameline2", "kind" "optional", "type" "string", "description" "" }, { "name" "medicarenameline3", "kind" "optional", "type" "string", "description" "" }, { "name" "medicarenameline4", "kind" "optional", "type" "string", "description" "" } ] }, { "name" "consentobtained", "kind" "required", "type" "object", "description" "consent given by the identity owner", "children" \[ { "name" "australia passport", "kind" "required", "type" "boolean", "description" "should be true" }, { "name" "australia medicare card", "kind" "required", "type" "boolean", "description" "" } ] } ] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "hastryitout" false, "response" \[ { "name" "countrycode", "kind" "optional", "type" "string", "description" "australia", "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" "\\"\\"\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" "documentno", "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" \[] } ] } 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 , "australia consumer" , "australia 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, including category and source , indicating the data provider used for verification