Composite Searching

composite search in germany 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 germany credit bureau germany residential germany phone germany consumer germany phone 2 germany utility { "name" "germany 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 – yes (for germany credit bureau)\n mandatory input – name and dob\n verifies – name, dob, address, phone number and email address\n returned data the match score for each name and/or address element (if configured)", "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 eyjpc3mioij0zxn0iiwiawf0ijoxnzqzmzgxntg4lcjpcgeioiiznc4xnteumte3lji0osisinvpzci6mzazlcjvawqiojyylcjsawqioju2ntc5mdqsimv4cci6mtc0mzqxmdm4ocwiyxvkijoiahr0chm6ly9pzhuuzgf0yxpvby5jb20ifq 5ed7hledbmdxwwincxqpycu3suxg7bkhljlruwipylnxwz3873kjbmc2dwy5vkgotc9qasp6hymapxfmcmo2ka' \\\\\n data raw '{\n \\"countrycode\\" \\"de\\",\n \\"service\\" \[\n \\"germany credit bureau\\",\n \\"germany residential\\",\n \\"germany phone\\",\n \\"germany consumer\\",\n \\"germany phone 2\\",\n \\"germany utility\\"\n ],\n \\"clientreference\\" \\"test 0001\\",\n \\"firstname\\" \\"anke\\", \n \\"middlename\\" \\"dennis wolfgang\\",\n \\"lastname\\" \\"gaußmann\\", \n \\"dateofbirth\\" \\"1963 07 23\\", \n \\"addresselement1\\" \\"23 kellerberg\\", \n \\"addresselement3\\" \\"nidderau\\", \n \\"addresselement5\\" \\"61130\\", \n \\"identityvariables\\" {\n \\"phoneno\\" \\"012345678901\\", \n \\"emailaddress\\" \\"dztest\@datazoo com\\"\n },\n \\"consentobtained\\" {\n \\"germany credit bureau\\" true\n }\n}'", "customlabel" "" } ], "selectedlanguageid" "f2jmy98siubrop0bgc788" }, "results" { "languages" \[ { "id" " kllvb jxqiuu wuwqaf", "language" "200", "customlabel" "", "code" "{\n \\"countrycode\\" \\"germany\\",\n \\"clientreference\\" \\"test 0001\\",\n \\"reportingreference\\" \\"dz 06146d63 249f 40a5 b404 9572e28ca914\\",\n \\"matchstatus\\" \\"full match 2+2 verification\\",\n \\"searcherrormessage\\" \\"\\",\n \\"safeharbour\\" true,\n \\"searchstatus\\" \\"successful\\",\n \\"serviceresponses\\" {\n \\"germany consumer\\" {\n \\"status\\" 1,\n \\"sourcestatus\\" \\"successful\\",\n \\"errormessage\\" \\"\\",\n \\"identityverified\\" true,\n \\"safeharbourscore\\" \\"m1\\",\n \\"namematchscore\\" \\"1 000\\",\n \\"addressmatchscore\\" \\"0 900\\",\n \\"verifications\\" {\n \\"addresselement1\\" true,\n \\"addresselement3\\" true,\n \\"addresselement5\\" true,\n \\"dateofbirth\\" true,\n \\"emailaddress\\" true,\n \\"firstname\\" true,\n \\"lastname\\" true,\n \\"phoneno\\" false\n },\n \\"returneddata\\" {}\n },\n \\"germany credit bureau\\" {\n \\"status\\" 2,\n \\"sourcestatus\\" \\"successful\\",\n \\"errormessage\\" \\"\\",\n \\"identityverified\\" false,\n \\"safeharbourscore\\" \\"none\\",\n \\"namematchscore\\" \\"0 000\\",\n \\"addressmatchscore\\" \\"0 000\\",\n \\"verifications\\" {\n \\"addresselement1\\" false,\n \\"addresselement3\\" false,\n \\"addresselement5\\" false,\n \\"dateofbirth\\" false,\n \\"firstname\\" false,\n \\"lastname\\" false\n },\n \\"returneddata\\" {}\n },\n \\"germany phone\\" {\n \\"status\\" 2,\n \\"sourcestatus\\" \\"successful\\",\n \\"errormessage\\" \\"\\",\n \\"identityverified\\" false,\n \\"safeharbourscore\\" \\"none\\",\n \\"namematchscore\\" \\"0 000\\",\n \\"addressmatchscore\\" \\"0 000\\",\n \\"verifications\\" {\n \\"addresselement1\\" false,\n \\"addresselement3\\" false,\n \\"addresselement5\\" false,\n \\"emailaddress\\" false,\n \\"firstname\\" false,\n \\"lastname\\" false,\n \\"phoneno\\" false\n },\n \\"returneddata\\" {}\n },\n \\"germany phone 2\\" {\n \\"status\\" 2,\n \\"sourcestatus\\" \\"successful\\",\n \\"errormessage\\" \\"no relevant entries found\\",\n \\"identityverified\\" false,\n \\"safeharbourscore\\" \\"none\\",\n \\"namematchscore\\" \\"n/a\\",\n \\"addressmatchscore\\" \\"n/a\\",\n \\"verifications\\" {},\n \\"returneddata\\" {}\n },\n \\"germany residential\\" {\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 \\"addresselement5\\" true,\n \\"dateofbirth\\" true,\n \\"firstname\\" true,\n \\"lastname\\" true\n },\n \\"returneddata\\" {}\n },\n \\"germany utility\\" {\n \\"status\\" 1,\n \\"sourcestatus\\" \\"successful\\",\n \\"errormessage\\" \\"\\",\n \\"identityverified\\" true,\n \\"safeharbourscore\\" \\"m2\\",\n \\"namematchscore\\" \\"1 000\\",\n \\"addressmatchscore\\" \\"0 400\\",\n \\"verifications\\" {\n \\"addresselement1\\" false,\n \\"addresselement3\\" true,\n \\"addresselement5\\" true,\n \\"dateofbirth\\" true,\n \\"firstname\\" true,\n \\"lastname\\" true\n },\n \\"returneddata\\" {}\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" "de" }, { "name" "service", "kind" "required", "type" "array", "description" "\\"germany credit bureau\\", \\"germany residential\\", \\"germany phone\\", \\"germany consumer\\", \\"germany phone 2\\", \\"germany utility\\"" }, { "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" "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" "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", "children" \[] }, { "name" "addresselement4", "kind" "optional", "type" "string", "description" "the state address of the identity owner", "children" \[] }, { "name" "addresselement5", "kind" "optional", "type" "string", "description" "the postcode of the address of the identity owner", "children" \[ { "name" "", "kind" "required", "type" "string", "description" "" } ] }, { "name" "identityvariables", "kind" "required", "type" "object", "description" "other elements for verification", "children" \[ { "name" "phoneno", "kind" "required", "type" "string", "description" "phone number of the identity owner" }, { "name" "emailaddress", "kind" "optional", "type" "string", "description" "email address of the identity owner" } ] } ], "schema" \[ { "name" "countrycode", "kind" "required", "type" "string", "description" "de" }, { "name" "service", "kind" "required", "type" "array", "description" "\\"germany credit bureau\\", \\"germany residential\\", \\"germany phone\\", \\"germany consumer\\", \\"germany phone 2\\", \\"germany utility\\"" }, { "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" "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" "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", "children" \[] }, { "name" "addresselement4", "kind" "optional", "type" "string", "description" "the state address of the identity owner", "children" \[] }, { "name" "addresselement5", "kind" "optional", "type" "string", "description" "the postcode of the address of the identity owner", "children" \[ { "name" "", "kind" "required", "type" "string", "description" "" } ] }, { "name" "identityvariables", "kind" "required", "type" "object", "description" "other elements for verification", "children" \[ { "name" "phoneno", "kind" "required", "type" "string", "description" "phone number of the identity owner" }, { "name" "emailaddress", "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" "germany", "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" "emailaddress", "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" "returneddata", "kind" "optional", "type" "object", "description" "returns additional data from the data source ", "children" \[ { "name" "altaddressmatchscore", "kind" "optional", "type" "object", "description" " the match score for each address element (if configured)", "children" \[ { "name" "addresselement1", "kind" "optional", "type" "string", "description" "" }, { "name" "addresselement3", "kind" "optional", "type" "string", "description" "" }, { "name" "addresselement5", "kind" "optional", "type" "string", "description" "" } ] }, { "name" "altnamematchscore", "kind" "optional", "type" "object", "description" " the match score for each name element (if configured)", "children" \[ { "name" "firstname", "kind" "optional", "type" "string", "description" "" }, { "name" "lastname", "kind" "optional", "type" "string", "description" "" } ] } ] } ] }, { "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)