Sequenced Searching

sequenced searching in canada can be configured for clients upon request when making sequenced calls for canada , the api input for the service must be set to " canada residential " example api requests and responses with following services configured canada consumer canada credit bureau 2 canada phone canada residential { "name" "canada 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 – for \\"canada residential\\" and \\"canada credit bureau 2\\"\n mandatory input – name, dob and address\n verifies – name, dob, address, phone and national id number\n returned data type of data source and service identifier for \\"canada residential\\", phone number related data ", "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 eyj1awqioiizmdmilcjvawqioii2miisimlzcyi6imh0dhbzoi8vzgf0yxpvby10zxn0lnvzlmf1dggwlmnvbs8ilcjzdwiioijhdxromhwzmdmilcjhdwqioijodhrwczovl2t5yy10zxn0lmrhdgf6b28uy29tiiwiawf0ijoxnzq2mdu1ndexlcjlehaioje3ndywote0mtesimd0esi6inbhc3n3b3jkiiwiyxpwijoiswxvdurjntf1qxpuvne2vgvorxayoxbrbehbsjftynkifq se81pp6tvnlpo0tpv8xgax3bn8km7gnlj4rep7pzata7j 8nwcjgccdp7s7yfgmknrkg9 ggaxmnum0u6vxklvntfmey0xrtrxa9s7wkdtwsynvilluoyfmz9zlvhe9m03wde5hm6k7ue00hxrvkjqcml0exsktzzaucdf8kbzdxgg3gh2prigurnsknuptkohi4jszfa72tmbs9qgi71880bqvdzhxamf4bbnlnb0hm i33dvqvipfadn1ro2sx2qz70znk2blvn 0vlqmdpmhrjck3ulpzwvdvqlzpcf1x gdzhrv37e5hirvwdd cuvly wbcpi4muiizpodxda' \\\\\n data '{\n \\"countrycode\\" \\"ca\\",\n \\"service\\" \[\n \\"canada residential\\"\n ],\n \\"clientreference\\" \\"test 0001\\",\n \\"firstname\\" \\"latanya\\",\n \\"middlename\\" \\"\\",\n \\"lastname\\" \\"mamudoski\\",\n \\"dateofbirth\\" \\"09 09 1971\\",\n \\"addresselement1\\" \\"2799 fort campbell blvd\\",\n \\"addresselement3\\" \\"portage la prairie\\",\n \\"addresselement4\\" \\"mb\\",\n \\"addresselement5\\" \\"r1n3t4\\",\n \\"identityvariables\\" {\n \\"phoneno\\" \\"+12040000252\\"\n },\n \\"consentobtained\\" {\n \\"canada residential\\" true\n }\n}'", "customlabel" "" } ], "selectedlanguageid" "f2jmy98siubrop0bgc788" }, "results" { "languages" \[ { "id" " kllvb jxqiuu wuwqaf", "language" "200", "customlabel" "", "code" "{\n \\"countrycode\\" \\"canada\\",\n \\"clientreference\\" \\"test 0001\\",\n \\"reportingreference\\" \\"dz ea2cd3cf b351 4530 8d62 ab70ca34b345\\",\n \\"matchstatus\\" \\"full match 2+2 verification\\",\n \\"searcherrormessage\\" \\"\\",\n \\"safeharbour\\" true,\n \\"searchstatus\\" \\"successful\\",\n \\"serviceresponses\\" {\n \\"canada consumer\\" {\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 \\"addresselement4\\" true,\n \\"addresselement5\\" true,\n \\"dateofbirth\\" true,\n \\"firstname\\" true,\n \\"lastname\\" true,\n \\"phoneno\\" true\n },\n \\"returneddata\\" {\n \\"category\\" \\"consumer\\",\n \\"source\\" \\"dz3\\"\n }\n },\n \\"canada 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 \\"dateofbirth\\" false,\n \\"firstname\\" true,\n \\"lastname\\" true,\n \\"phoneno\\" true\n },\n \\"returneddata\\" {\n \\"accountclass\\" \\"corporate\\",\n \\"accounttype\\" \\"prepaid\\",\n \\"activationdate\\" \\"\\",\n \\"brandname\\" \\"fido\\",\n \\"carriername\\" \\"rogers\\",\n \\"category\\" \\"telco\\",\n \\"phonestatus\\" \\"suspended\\",\n \\"source\\" \\"dz1\\",\n \\"subscriberid\\" \\"d0ec3b250f47ed5d6fea9e347de56b3a35ced563\\"\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" "ca" }, { "name" "service", "kind" "required", "type" "array", "description" "canada 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", "children" \[] }, { "name" "addresselement1", "kind" "required", "type" "string", "description" "the street name of the address of the identity owner", "children" \[] }, { "name" "addresselement2", "kind" "optional", "type" "string", "description" "the neighbourhood name of the address", "children" \[] }, { "name" "addresselement3", "kind" "required", "type" "string", "description" "the city/town/locality of the address of the identity owner", "children" \[] }, { "name" "addresselement4", "kind" "required", "type" "string", "description" "the province of the address of the identity owner" }, { "name" "addresselement5", "kind" "required", "type" "string", "description" "the post code of the 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" "consentobtained", "kind" "required", "type" "object", "description" "consent given by the identity owner", "children" \[ { "name" "canada residential", "kind" "required", "type" "boolean", "description" "should be true" }, { "name" "canada credit bureau 2", "kind" "required", "type" "boolean", "description" "should be true" } ] } ], "schema" \[ { "name" "countrycode", "kind" "required", "type" "string", "description" "ca" }, { "name" "service", "kind" "required", "type" "array", "description" "canada 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", "children" \[] }, { "name" "addresselement1", "kind" "required", "type" "string", "description" "the street name of the address of the identity owner", "children" \[] }, { "name" "addresselement2", "kind" "optional", "type" "string", "description" "the neighbourhood name of the address", "children" \[] }, { "name" "addresselement3", "kind" "required", "type" "string", "description" "the city/town/locality of the address of the identity owner", "children" \[] }, { "name" "addresselement4", "kind" "required", "type" "string", "description" "the province of the address of the identity owner" }, { "name" "addresselement5", "kind" "required", "type" "string", "description" "the post code of the 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" "consentobtained", "kind" "required", "type" "object", "description" "consent given by the identity owner", "children" \[ { "name" "canada residential", "kind" "required", "type" "boolean", "description" "should be true" }, { "name" "canada credit bureau 2", "kind" "required", "type" "boolean", "description" "should be true" } ] } ] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "hastryitout" false, "response" \[ { "name" "countrycode", "kind" "optional", "type" "string", "description" "canada", "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" "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" "cpf", "kind" "optional", "type" "boolean", "description" "" }, { "name" "dateofbirth", "kind" "optional", "type" "boolean", "description" "" }, { "name" "firstname", "kind" "optional", "type" "boolean", "description" "" }, { "name" "fullname", "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" " 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" "accountclass", "kind" "optional", "type" "string", "description" " for canada residential " }, { "name" "accounttype", "kind" "optional", "type" "string", "description" " for canada residential " }, { "name" "activationdate", "kind" "optional", "type" "string", "description" " for canada residential " }, { "name" "brandname", "kind" "optional", "type" "string", "description" " for canada residential " }, { "name" "carriername", "kind" "optional", "type" "string", "description" " for canada residential " }, { "name" "phonestatus", "kind" "optional", "type" "string", "description" " for canada residential " }, { "name" "subscriberid", "kind" "optional", "type" "string", "description" " for canada residential " } ] } ] }, { "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