Australia Residential

data zoo’s proprietary opt in permission based marketing database for authorization get session token from authentication page { "name" "australia residential", "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 or address)\n verifies – name, dob, address, email, landline and mobile phone number\n returned data metrix used for address matching logic, identity of the data source", "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 ••••••' \\\\\n data raw '{\n \\"countrycode\\" \\"au\\",\n \\"service\\" \[\n \\"australia residential\\"\n ],\n \\"clientreference\\" \\"test 0001\\",\n \\"firstname\\" \\"aloysius\\",\n \\"middlename\\" \\"jefferson\\",\n \\"lastname\\" \\"pasco\\",\n \\"dateofbirth\\" \\"1946 11 01\\",\n \\"addresselement1\\" \\"30 plane tree green\\",\n \\"addresselement3\\" \\"forrestfield\\",\n \\"addresselement4\\" \\"wa\\",\n \\"addresselement5\\" \\"6058\\",\n \\"identityvariables\\" {\n \\"phoneno\\" \\"0487787402\\",\n \\"landlineno\\" \\"0734086754\\",\n \\"email\\" \\"apasco\@datatest com com\\"\n }\n}\n'", "customlabel" "" } ], "selectedlanguageid" "f2jmy98siubrop0bgc788" }, "results" { "languages" \[ { "id" " kllvb jxqiuu wuwqaf", "language" "200", "customlabel" "", "code" "{\n \\"countrycode\\" \\"australia\\",\n \\"clientreference\\" \\"test 0001\\",\n \\"reportingreference\\" \\"dz 88560fc7 686a 45f5 a29c d1f667580850\\",\n \\"matchstatus\\" \\"full match 1+1 verification\\",\n \\"searcherrormessage\\" \\"\\",\n \\"safeharbour\\" false,\n \\"searchstatus\\" \\"successful\\",\n \\"serviceresponses\\" {\n \\"australia residential\\" {\n \\"status\\" 1,\n \\"sourcestatus\\" \\"successful\\",\n \\"errormessage\\" \\"\\",\n \\"identityverified\\" true,\n \\"safeharbourscore\\" \\"n1\\",\n \\"namematchscore\\" \\"1 000\\",\n \\"addressmatchscore\\" \\"1 000\\",\n \\"verifications\\" {\n \\"addresselement1\\" true,\n \\"addresselement3\\" true,\n \\"addresselement4\\" true,\n \\"addresselement5\\" true,\n \\"email\\" true,\n \\"firstname\\" true,\n \\"landlineno\\" false,\n \\"lastname\\" true,\n \\"phoneno\\" true\n },\n \\"returneddata\\" {\n \\"altaddressmatchscore\\" \\"0\\",\n \\"altnamematchscore\\" \\"a1\\",\n \\"dpid\\" \\"63233056\\",\n \\"source\\" \\"dz1\\"\n }\n }\n },\n \\"remarks\\" \[]\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" "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\n \[conditional optional see note below]" }, { "name" "addresselement1", "kind" "required", "type" "string", "description" "the street level address of the identity owner\n \[conditional optional see note below]" }, { "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\n \[conditional optional see note below]", "children" \[] }, { "name" "identityvariables", "kind" "optional", "type" "object", "description" "other elements for verification", "children" \[ { "name" "phoneno", "kind" "optional", "type" "string", "description" "mobile phone number of the identity owner" }, { "name" "landlineno", "kind" "optional", "type" "string", "description" "landline phone number of the identity owner" }, { "name" "email", "kind" "optional", "type" "string", "description" "email address of the identity owner" } ] } ], "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\n \[conditional optional see note below]" }, { "name" "addresselement1", "kind" "required", "type" "string", "description" "the street level address of the identity owner\n \[conditional optional see note below]" }, { "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\n \[conditional optional see note below]", "children" \[] }, { "name" "identityvariables", "kind" "optional", "type" "object", "description" "other elements for verification", "children" \[ { "name" "phoneno", "kind" "optional", "type" "string", "description" "mobile phone number of the identity owner" }, { "name" "landlineno", "kind" "optional", "type" "string", "description" "landline phone number of the identity owner" }, { "name" "email", "kind" "optional", "type" "string", "description" "email address of the identity owner" } ] } ] } ], "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\\"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\\"not successful\\"", "children" \[] }, { "name" "serviceresponses", "kind" "optional", "type" "object", "description" "verification details with \\"australia residential\\" 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" "\\"\\"\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" "m1, m2 or n1\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" }, { "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" "dateofbirth", "kind" "optional", "type" "boolean", "description" "" }, { "name" "email", "kind" "optional", "type" "boolean", "description" "" }, { "name" "firstname", "kind" "optional", "type" "boolean", "description" "" }, { "name" "gender", "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" "returns additional data from the data source ", "children" \[ { "name" "altaddressmatchscore", "kind" "optional", "type" "string", "description" "metrix used for address matching logic" }, { "name" "altnamematchscore", "kind" "optional", "type" "string", "description" "metrix used for name matching logic" }, { "name" "dpid", "kind" "optional", "type" "string", "description" "delivery point identifier of the address" }, { "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" \[] } ] } mandatory input for date of birth and address date of birth and address input are required based on criteria either dateofbirth or street address with postcode must be provided ( addresselement1 and addresselement5 ) as input links