THE AMERICAS
Canada
Canada Residential
3 min
verifies input data against telco data obtained from partnered sources in canada for authorization get session token from authentication page name canada residential method post url https idu test datazoo com api v2 verify description verification outcome returns kyc verification n consumer consent yes n mandatory input name address and phone number n verifies name address dob and phone number n returned data 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 eyj1awqioiizmdmilcjvawqioii2miisimlzcyi6imh0dhbzoi8vzgf0yxpvby10zxn0lnvzlmf1dggwlmnvbs8ilcjzdwiioijhdxromhwzmdmilcjhdwqioijodhrwczovl2t5yy10zxn0lmrhdgf6b28uy29tiiwiawf0ijoxnzq1odg0mjg2lcjlehaioje3ndu5mjayodysimd0esi6inbhc3n3b3jkiiwiyxpwijoiswxvdurjntf1qxpuvne2vgvorxayoxbrbehbsjftynkifq eacawretq7i oioelmh7bcviy1augceuqnnshpqdu2o6dsimjxqedraje9tyghtatb1sbpzswsmcindgv03hfkficlu8ulqaidels5snc6 dj4b3ei1nw0zz2mm4xsh613yyoiq6bpamkrw9e4qmanydgjc9kwapxg8cvzjkl7lyhmdapgydyzgatx27u88spvwjhfbhisxcghkdcit5n55h t b0e6 bckaztxpruv4sf0st1awfr p0mwuuszlef6auk2ptnzc54fonfc6llfygh0nwe 49qnev1vwyojwecugnmihdcdht3imwbv2pns58riysgeaqusz6vqljw 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 1971 09 09 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 ae71ae97 7b90 4bcf 8453 c066871355b1 n matchstatus full match 1 1 verification n searcherrormessage n safeharbour false n searchstatus successful n serviceresponses 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 phonestatus suspended 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 the 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 children name dateofbirth kind optional type string description in yyyy mm dd preferred or dd mm yyyy format children name addresselement1 kind required type string description the street level address of the identity owner name addresselement3 kind required type string description the town city of the address of the identity owner children name addresselement4 kind required type string description the province name of the address of the identity owner children name addresselement5 kind required type string description the postcode of the address of the identity owner 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 consentobtained kind required type object description consent given by the identity owner children name canada residential 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 the 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 children name dateofbirth kind optional type string description in yyyy mm dd preferred or dd mm yyyy format children name addresselement1 kind required type string description the street level address of the identity owner name addresselement3 kind required type string description the town city of the address of the identity owner children name addresselement4 kind required type string description the province name of the address of the identity owner children name addresselement5 kind required type string description the postcode of the address of the identity owner 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 consentobtained kind required type object description consent given by the identity owner children name canada residential 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 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 residential 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 not successful 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 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 firstname kind optional type boolean description name lastname kind optional type boolean description name middlename 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 accountclass kind optional type string description subscriber account class possible values are business personal corporate or unknown name accounttype kind optional type string description subscriber account type possible values are postpaid prepaid or unknown name activationdate kind optional type string description the date the subscriber s mobile account was activated if it is available name brandname kind optional type string description telecommunication company or brand name name carriername kind optional type string description phone carrier name name phonestatus kind optional type string description subscriber account status possible values are active or suspended name subscriberid kind optional type string description unique identifier of a mobile subscriber within mno network name remarks kind optional type array description will return remarks regarding any encountered issues children links