Hong Kong Utility

3 min

verifies the provided details from the utility records in hong kong using utility data sources for authorization https //app archbee com/public/preview hnaypwtsaembvpear1r0a/preview xqss5k2lv8fjt 0pv5dbk from authentication page { "name" "hong kong 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 address\n verifies – name address and phone\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 ••••••' \\\\\n data '{\n \\"countrycode\\" \\"hk\\",\n \\"service\\" \[\n \\"hong kong utility\\"\n ],\n \\"clientreference\\" \\"hongkongtest 001\\",\n \\"fullname\\" \\"choi siu ping\\",\n \\"firstname\\" \\"siu\\",\n \\"middlename\\" \\"ping\\",\n \\"lastname\\" \\"choi\\",\n \\"addresselement1\\" \\"flat 1714 17/f hong wing house, cheung hong estate, tsing yi, nt\\",\n \\"addresselement3\\" \\"tsing yi\\",\n \\"addresselement4\\" \\"nt\\",\n \\"identityvariables\\" {\n \\"phoneno\\" \\"24973445\\"\n } \n}'", "customlabel" "" } ], "selectedlanguageid" "f2jmy98siubrop0bgc788" }, "results" { "languages" \[ { "id" " kllvb jxqiuu wuwqaf", "language" "200", "code" "{\n \\"countrycode\\" \\"hong kong (special administrative region of china)\\",\n \\"clientreference\\" \\"test 0001\\",\n \\"reportingreference\\" \\"dz e9db5edd a958 4b16 80b3 3c23cb5f8d42\\",\n \\"matchstatus\\" \\"full match 1+1 verification\\",\n \\"searcherrormessage\\" \\"\\",\n \\"safeharbour\\" false,\n \\"searchstatus\\" \\"successful\\",\n \\"serviceresponses\\" {\n \\"hong kong utility\\" {\n \\"status\\" 0,\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 \\"firstname\\" true,\n \\"lastname\\" true,\n \\"phoneno\\" true\n \n },\n \\"returneddata\\" {}\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" "hk" }, { "name" "service", "kind" "required", "type" "array", "description" "hong kong utility" }, { "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" "addresselement1", "kind" "required", "type" "string", "description" "building details (unit, floor etc) of the identity owner" }, { "name" "addresselement3", "kind" "optional", "type" "string", "description" "the district of the identity owner" }, { "name" "addresselement4", "kind" "optional", "type" "string", "description" "the state address (hong kong, kowloon, new territories) of the identity owner" }, { "name" "fullname", "kind" "required", "type" "string", "description" "" }, { "name" "identityvariables", "kind" "optional", "type" "object", "description" "", "children" \[ { "name" "phoneno", "kind" "optional", "type" "boolean", "description" "phone number of the identity owner" } ] } ], "schema" \[ { "name" "countrycode", "kind" "required", "type" "string", "description" "hk" }, { "name" "service", "kind" "required", "type" "array", "description" "hong kong utility" }, { "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" "addresselement1", "kind" "required", "type" "string", "description" "building details (unit, floor etc) of the identity owner" }, { "name" "addresselement3", "kind" "optional", "type" "string", "description" "the district of the identity owner" }, { "name" "addresselement4", "kind" "optional", "type" "string", "description" "the state address (hong kong, kowloon, new territories) of the identity owner" }, { "name" "fullname", "kind" "required", "type" "string", "description" "" }, { "name" "identityvariables", "kind" "optional", "type" "object", "description" "", "children" \[ { "name" "phoneno", "kind" "optional", "type" "boolean", "description" "phone number of the identity owner" } ] } ] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "hastryitout" false, "response" \[ { "name" "countrycode", "kind" "optional", "type" "string", "description" "hong kong (special administrative region of china)", "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 \\"hong kong 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" "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" "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 " }, { "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" "addresselement2", "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" "middlename", "kind" "optional", "type" "boolean", "description" "" } ] }, { "name" "returneddata", "kind" "optional", "type" "object", "description" "null", "children" \[] } ] }, { "name" "remarks", "kind" "optional", "type" "array", "description" "null", "children" \[] } ] } links