Composite Searching

composite search in ireland enables clients to automate the selection of multiple services, processing verification inputs through successive data sources and returning responses from each selected service example api requests and responses with following services configured ireland citizens ireland credit bureau ireland residential ireland utility ireland voter registration { "name" "ireland composite 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 – n/a\n mandatory input – name\n verifies – name, dob, address, phone and tax id number\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 data '{\n \\"countrycode\\" \\"ie\\",\n \\"service\\" \[\n \\"ireland citizens\\",\n \\"ireland credit bureau\\",\n \\"ireland residential\\",\n \\"ireland utility\\",\n \\"ireland voter registration\\"\n ],\n \\"clientreference\\" \\"test 0001\\",\n \\"firstname\\" \\"clfname\\",\n \\"middlename\\" \\"clmname\\",\n \\"lastname\\" \\"cllname\\",\n \\"gender\\" \\"female\\",\n \\"dateofbirth\\" \\"1985 01 05\\",\n \\"addresselement1\\" \\"claddress 1\\",\n \\"addresselement3\\" \\"clcity\\",\n \\"addresselement4\\" \\"clstate\\",\n \\"identityvariables\\" {\n \t\t\\"phoneno\\" \\"9897456132\\",\n \\"nationalidno\\" \\"12345678\\" \n }\n}'", "customlabel" "" } ], "selectedlanguageid" "f2jmy98siubrop0bgc788" }, "results" { "languages" \[ { "id" " kllvb jxqiuu wuwqaf", "language" "200", "customlabel" "", "code" "curl location 'https //idu test datazoo com/api/v2/verify' \\\\\n data '{\n \\"countrycode\\" \\"ie\\",\n \\"service\\" \[\n \\"ireland citizens\\",\n \\"ireland credit bureau\\",\n \\"ireland residential\\",\n \\"ireland utility\\",\n \\"ireland voter registration\\"\n ],\n \\"clientreference\\" \\"test 0001\\",\n \\"firstname\\" \\"clfname\\",\n \\"middlename\\" \\"clmname\\",\n \\"lastname\\" \\"cllname\\",\n \\"gender\\" \\"female\\",\n \\"dateofbirth\\" \\"1985 01 05\\",\n \\"addresselement1\\" \\"claddress 1\\",\n \\"addresselement3\\" \\"clcity\\",\n \\"addresselement4\\" \\"clstate\\",\n \\"identityvariables\\" {\n \t\t\\"phoneno\\" \\"9897456132\\",\n \\"nationalidno\\" \\"12345678\\" \n }\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" "ie" }, { "name" "service", "kind" "required", "type" "array", "description" "\\"ireland citizens\\", \\"ireland credit bureau\\", \\"ireland residential\\", \\"ireland utility\\", \\"ireland voter registration\\"" }, { "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" "gender", "kind" "optional", "type" "string", "description" "male or female" }, { "name" "dateofbirth", "kind" "optional", "type" "string", "description" "in yyyy mm dd (preferred) or dd mm yyyy format", "children" \[] }, { "name" "addresselement1", "kind" "optional", "type" "string", "description" "the street level address of the identity owner", "children" \[] }, { "name" "addresselement3", "kind" "optional", "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" "optional", "type" "string", "description" "the eircode 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" "nationalidno", "kind" "optional", "type" "string", "description" "identity number of the identity owner" } ] } ], "schema" \[ { "name" "countrycode", "kind" "required", "type" "string", "description" "ie" }, { "name" "service", "kind" "required", "type" "array", "description" "\\"ireland citizens\\", \\"ireland credit bureau\\", \\"ireland residential\\", \\"ireland utility\\", \\"ireland voter registration\\"" }, { "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" "gender", "kind" "optional", "type" "string", "description" "male or female" }, { "name" "dateofbirth", "kind" "optional", "type" "string", "description" "in yyyy mm dd (preferred) or dd mm yyyy format", "children" \[] }, { "name" "addresselement1", "kind" "optional", "type" "string", "description" "the street level address of the identity owner", "children" \[] }, { "name" "addresselement3", "kind" "optional", "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" "optional", "type" "string", "description" "the eircode 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" "nationalidno", "kind" "optional", "type" "string", "description" "identity number of the identity owner" } ] } ] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "hastryitout" false, "response" \[ { "name" "countrycode", "kind" "optional", "type" "string", "description" "ireland", "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" "firstname", "kind" "optional", "type" "boolean", "description" "" }, { "name" "gender", "kind" "optional", "type" "boolean", "description" "" }, { "name" "lastname", "kind" "optional", "type" "boolean", "description" "" }, { "name" "middlename", "kind" "optional", "type" "boolean", "description" "" }, { "name" "nationalidno", "kind" "optional", "type" "boolean", "description" "" }, { "name" "phoneno", "kind" "optional", "type" "boolean", "description" "" } ] }, { "name" "returneddata", "kind" "optional", "type" "object", "description" "null", "children" \[] } ] }, { "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 (if applicable)