Canada Consumer

3 min

data zoo’s proprietary opt in permission based marketing database for authorization get session token from authentication page { "name" "canada consumer", "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\n verifies – name, dob, address, phone number and email address\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 bearer eyjhbgcioijsuzi1niisinr5cci6ikpxvcisimtpzci6immtbvzlml9krfhmcnkzaehqwen4tyj9 eyj1awqioiizmdmilcjvawqioii2miisimlzcyi6imh0dhbzoi8vzgf0yxpvby10zxn0lnvzlmf1dggwlmnvbs8ilcjzdwiioijhdxromhwzmdmilcjhdwqioijodhrwczovl2t5yy10zxn0lmrhdgf6b28uy29tiiwiawf0ijoxnzq2mdu1ndexlcjlehaioje3ndywote0mtesimd0esi6inbhc3n3b3jkiiwiyxpwijoiswxvdurjntf1qxpuvne2vgvorxayoxbrbehbsjftynkifq se81pp6tvnlpo0tpv8xgax3bn8km7gnlj4rep7pzata7j 8nwcjgccdp7s7yfgmknrkg9 ggaxmnum0u6vxklvntfmey0xrtrxa9s7wkdtwsynvilluoyfmz9zlvhe9m03wde5hm6k7ue00hxrvkjqcml0exsktzzaucdf8kbzdxgg3gh2prigurnsknuptkohi4jszfa72tmbs9qgi71880bqvdzhxamf4bbnlnb0hm i33dvqvipfadn1ro2sx2qz70znk2blvn 0vlqmdpmhrjck3ulpzwvdvqlzpcf1x gdzhrv37e5hirvwdd cuvly wbcpi4muiizpodxda' \\\\\n data raw '{\n \\"countrycode\\" \\"ca\\",\n \\"service\\" \[\n \\"canada consumer\\"\n ],\n \\"clientreference\\" \\"test 0001\\",\n \\"firstname\\" \\"raymond\\", \n \\"lastname\\" \\"gingold\\", \n \\"dateofbirth\\" \\"1995 07 03\\", \n \\"addresselement1\\" \\"10 first ln\\", \n \\"addresselement3\\" \\"montreal\\", \n \\"addresselement4\\" \\"qc\\", \n \\"addresselement5\\" \\"h3a1g1\\", \n \\"identityvariables\\" {\n \\"phoneno\\" \\"+12012890199\\", \n \\"emailaddress\\" \\"dztest\@datazoo com\\" \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 174d1ec8 ea3a 4988 981f b556451cffe1\\",\n \\"matchstatus\\" \\"full match 1+1 verification\\",\n \\"searcherrormessage\\" \\"\\",\n \\"safeharbour\\" false,\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 \\"emailaddress\\" true,\n \\"firstname\\" true,\n \\"lastname\\" true,\n \\"phoneno\\" 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" "ca" }, { "name" "service", "kind" "required", "type" "array", "description" "canada consumer" }, { "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" "lastname", "kind" "required", "type" "string", "description" "the last name of the identity owner" }, { "name" "dateofbirth", "kind" "optional", "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" }, { "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" "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" "emailaddress", "kind" "optional", "type" "string", "description" "email address of the identity owner" } ] } ], "schema" \[ { "name" "countrycode", "kind" "required", "type" "string", "description" "ca" }, { "name" "service", "kind" "required", "type" "array", "description" "canada consumer" }, { "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" "lastname", "kind" "required", "type" "string", "description" "the last name of the identity owner" }, { "name" "dateofbirth", "kind" "optional", "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" }, { "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" "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" "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" "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\\"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 \\"canada consumer\\" 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" "m1, m2, n1, p1, p2, p3, p4 or \\"none\\"\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" "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" "null", "children" \[] } ] }, { "name" "remarks", "kind" "optional", "type" "array", "description" "will return remarks regarding any encountered issues ", "children" \[] } ] } links