Sequenced Searching

3 min

sequenced searching in united kingdom can be configured for clients upon request when making sequenced calls for the united kingdom , the api input for the service must be set to " united kingdom residential " example api requests and responses with following services configured united kingdom citizens united kingdom consumer united kingdom credit bureau united kingdom financial services united kingdom phone united kingdom phone 2 united kingdom residential { "name" "united kingdom sequenced search", "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 united kingdom residential and united kingdom credit bureau)\n mandatory input – name, dob, address and phone number\n verifies – name, dob, address, mobile number, landline number and email address\n returned data type of data source and service identifier ", "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 eyj1awqioiizmdmilcjvawqioii2miisimlzcyi6imh0dhbzoi8vzgf0yxpvby10zxn0lnvzlmf1dggwlmnvbs8ilcjzdwiioijhdxromhwzmdmilcjhdwqioijodhrwczovl2t5yy10zxn0lmrhdgf6b28uy29tiiwiawf0ijoxnzq4mzaxotu3lcjlehaioje3ndgzmzc5ntcsimd0esi6inbhc3n3b3jkiiwiyxpwijoiswxvdurjntf1qxpuvne2vgvorxayoxbrbehbsjftynkifq xsla pluzrhesav0lqiztnz9rl c5axcuuepq05mddbega3rcfwr6eqhmcgchpxquz34gvx68zezhkuinub6qmrtpm vdxn dw6uk2c7speh2qgrbnhglg pq9cq36uruhjl 2zhthto4p8xhayveh8fn6r589hnedl53os5wzqcvc9uaoj4h0vplfe kg3sfrfusrtuyij8x6ozpxpszkjilrhg9a3sqqt1qqqytalb1ajdz00huknqfxboszc qnpexr7j4ym6fwq6ukmjguawwlraqqgm jauoowm2m zvlccqlttrvxvrkrsfkbjf4ennp8ydvnoeu6dch1wua' \\\\\n data raw '{\n \\"countrycode\\" \\"gb\\",\n \\"service\\" \[ \n \\"united kingdom residential\\"\n ],\n \\"clientreference\\" \\"test 0001\\",\n \\"firstname\\" \\"winston\\", \n \\"lastname\\" \\"churchill\\", \n \\"dateofbirth\\" \\"1977 01 01\\", \n \\"addresselement1\\" \\"4 barrow rise\\", \n \\"addresselement3\\" \\"weymouth\\", \n \\"addresselement4\\" \\"dorset\\", \n \\"addresselement5\\" \\"dt4 9hj\\", \n \\"identityvariables\\" {\n \\"email\\" \\"wchurchilltest\@datazoo com\\",\n \\"phoneno\\" \\"07983554111\\",\n \\"landlineno\\" \\"01912960111\\"\n },\n \\"consentobtained\\" {\n \\"united kingdom residential\\" true,\n \\"united kingdom credit bureau\\" true\n }\n}'", "customlabel" "" } ], "selectedlanguageid" "f2jmy98siubrop0bgc788" }, "results" { "languages" \[ { "id" " kllvb jxqiuu wuwqaf", "language" "200", "customlabel" "", "code" "{\n \\"countrycode\\" \\"united kingdom\\",\n \\"clientreference\\" \\"test 0001\\",\n \\"reportingreference\\" \\"dz f6d3bae5 946c 4a8a bd59 024442958340\\",\n \\"matchstatus\\" \\"full match 1+1 verification\\",\n \\"searcherrormessage\\" \\"\\",\n \\"safeharbour\\" false,\n \\"searchstatus\\" \\"successful\\",\n \\"serviceresponses\\" {\n \\"united kingdom residential\\" {\n \\"status\\" 1,\n \\"sourcestatus\\" \\"successful\\",\n \\"errormessage\\" \\"\\",\n \\"identityverified\\" true,\n \\"safeharbourscore\\" \\"m1\\",\n \\"namematchscore\\" \\"1 000\\",\n \\"addressmatchscore\\" \\"0 750\\",\n \\"verifications\\" {\n \\"addresselement1\\" true,\n \\"addresselement3\\" false,\n \\"addresselement5\\" true,\n \\"dateofbirth\\" true,\n \\"email\\" true,\n \\"firstname\\" true,\n \\"landlineno\\" true,\n \\"lastname\\" true,\n \\"phoneno\\" true\n },\n \\"returneddata\\" {\n \\"category\\" \\"semi government\\",\n \\"source\\" \\"dz1\\"\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" "gb" }, { "name" "service", "kind" "required", "type" "array", "description" "united kingdom residential" }, { "name" "clientreference", "kind" "optional", "type" "string", "description" "a client reference field" }, { "name" "firstname", "kind" "required", "type" "string", "description" "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 name of the address of the identity owner", "children" \[] }, { "name" "addresselement3", "kind" "required", "type" "string", "description" "the suburb address of the identity owner", "children" \[] }, { "name" "addresselement4", "kind" "optional", "type" "string", "description" "the state address of the identity owner", "children" \[] }, { "name" "addresselement5", "kind" "required", "type" "string", "description" "the eircode address of the identity owner", "children" \[] }, { "name" "identityvariables", "kind" "required", "type" "object", "description" "other elements for verification", "children" \[ { "name" "phoneno", "kind" "required", "type" "string", "description" "mobile phone number of the identity owner" }, { "name" "landlineno", "kind" "optional", "type" "string", "description" "landline number of the identity owner" }, { "name" "email", "kind" "optional", "type" "string", "description" "email address of the identity owner" } ] }, { "name" "consentobtained", "kind" "optional", "type" "object", "description" "consent given by the identity owner", "children" \[ { "name" "united kingdom residential", "kind" "optional", "type" "boolean", "description" "should be true" }, { "name" "united kingdom credit bureau", "kind" "optional", "type" "boolean", "description" "should be true" } ] } ], "schema" \[ { "name" "countrycode", "kind" "required", "type" "string", "description" "gb" }, { "name" "service", "kind" "required", "type" "array", "description" "united kingdom residential" }, { "name" "clientreference", "kind" "optional", "type" "string", "description" "a client reference field" }, { "name" "firstname", "kind" "required", "type" "string", "description" "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 name of the address of the identity owner", "children" \[] }, { "name" "addresselement3", "kind" "required", "type" "string", "description" "the suburb address of the identity owner", "children" \[] }, { "name" "addresselement4", "kind" "optional", "type" "string", "description" "the state address of the identity owner", "children" \[] }, { "name" "addresselement5", "kind" "required", "type" "string", "description" "the eircode address of the identity owner", "children" \[] }, { "name" "identityvariables", "kind" "required", "type" "object", "description" "other elements for verification", "children" \[ { "name" "phoneno", "kind" "required", "type" "string", "description" "mobile phone number of the identity owner" }, { "name" "landlineno", "kind" "optional", "type" "string", "description" "landline number of the identity owner" }, { "name" "email", "kind" "optional", "type" "string", "description" "email address of the identity owner" } ] }, { "name" "consentobtained", "kind" "optional", "type" "object", "description" "consent given by the identity owner", "children" \[ { "name" "united kingdom residential", "kind" "optional", "type" "boolean", "description" "should be true" }, { "name" "united kingdom credit bureau", "kind" "optional", "type" "boolean", "description" "should be true" } ] } ] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "hastryitout" false, "response" \[ { "name" "countrycode", "kind" "optional", "type" "string", "description" "united kingdom", "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" "lastname", "kind" "optional", "type" "boolean", "description" "" }, { "name" "phoneno", "kind" "optional", "type" "boolean", "description" "" }, { "name" "landlineno", "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" "null", "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 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