Canada Credit Bureau (FINTRAC)

verifies input data against credit header data obtained from the partnered sources from canada must have approved access with customer number and security code to use this credit bureau service for more information about this service with single and dual source identification methods, refer to this page for authorization get session token from authentication page { "name" "canada credit bureau", "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, dob and address\n verifies – name, dob and address\n returned data credit related returned data the returned data differs between a single source decision and a dual source decision refer to the curl examples for each decision type ", "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 data '{\n \\"countrycode\\" \\"ca\\",\n \\"service\\" \[\n \\"canada credit bureau\\"\n ],\n \\"clientreference\\" \\"test 0001\\",\n \\"firstname\\" \\"domemic\\",\n \\"middlename\\" \\"\\",\n \\"lastname\\" \\"testpotkidis\\",\n \\"dateofbirth\\" \\"1970 12 12\\",\n \\"addresselement1\\" \\"97 stanley st\\",\n \\"addresselement3\\" \\"ottawa\\",\n \\"addresselement4\\" \\"on\\",\n \\"addresselement5\\" \\"k1m1n8\\",\n \\"consentobtained\\" {\n \\"canada credit bureau\\" 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 a65eabec d754 42f9 8b4a 778984867a44\\",\n \\"matchstatus\\" \\"full match 2+2 verification\\",\n \\"searcherrormessage\\" \\"\\",\n \\"safeharbour\\" true,\n \\"searchstatus\\" \\"successful\\",\n \\"serviceresponses\\" {\n \\"canada credit bureau\\" {\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 },\n \\"returneddata\\" {\n \\"addressasreported\\" \\"97,stanley,ottawa,on,k1m1n8\\",\n \\"category\\" \\"credit – single source\\",\n \\"cid\\" \\"0053559639\\",\n \\"creditfile3years\\" true,\n \\"creditfilecreated\\" \\"2018 09 25\\",\n \\"dateofbirthasreported\\" \\"1970 12 12\\",\n \\"morethanonedistinctsource\\" true,\n \\"nameasreported\\" \\"testpotkidis,domemic,,\\",\n \\"numberoftrades\\" \\"011\\",\n \\"originofcreditfile\\" \\"canada\\",\n \\"source\\" \\"dz5\\"\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 credit bureau" }, { "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" "required", "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" }, { "name" "addresselement5", "kind" "required", "type" "string", "description" "the postcode of the address of the identity owner", "children" \[] }, { "name" "consentobtained", "kind" "required", "type" "object", "description" "consent given by the identity owner", "children" \[ { "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 credit bureau" }, { "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" "required", "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" }, { "name" "addresselement5", "kind" "required", "type" "string", "description" "the postcode of the address of the identity owner", "children" \[] }, { "name" "consentobtained", "kind" "required", "type" "object", "description" "consent given by the identity owner", "children" \[ { "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" "verification details with \\"canada credit bureau\\" 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" "\\"1 000\\" matched \n\\"0 000\\" no match" }, { "name" "addressmatchscore", "kind" "optional", "type" "string", "description" "\\"1 000\\" matched \n\\"0 000\\" no match" }, { "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" "returneddata", "kind" "optional", "type" "object", "description" "returns additional data from the data source when premium configuration is enabled \n see details of element level breakdown of returneddata in curl examples below ", "children" \[] } ] }, { "name" "remarks", "kind" "optional", "type" "array", "description" "will return remarks regarding any encountered issues ", "children" \[] } ] } links curl location 'https //idu test datazoo com/api/v2/verify' \\ \ header 'content type application/json' \\ \ data '{ "countrycode" "ca", "service" \[ "canada credit bureau" ], "clientreference" "test 0001", "firstname" "domemic", "middlename" "", "lastname" "testpotkidis", "dateofbirth" "1970 12 12", "addresselement1" "97 stanley st", "addresselement3" "ottawa", "addresselement4" "on", "addresselement5" "k1m1n8", "consentobtained" { "canada credit bureau" true } }'{ "countrycode" "canada", "clientreference" "test 0001", "reportingreference" "dz a65eabec d754 42f9 8b4a 778984867a44", "matchstatus" "full match 2+2 verification", "searcherrormessage" "", "safeharbour" true, "searchstatus" "successful", "serviceresponses" { "canada credit bureau" { "status" 0, "sourcestatus" "successful", "errormessage" "", "identityverified" true, "safeharbourscore" "m1", "namematchscore" "1 000", "addressmatchscore" "1 000", "verifications" { "addresselement1" true, "addresselement3" true, "addresselement4" true, "addresselement5" true, "dateofbirth" true, "firstname" true, "lastname" true }, "returneddata" { "addressasreported" "97,stanley,ottawa,on,k1m1n8", "category" "credit – single source", "cid" "0053559639", "creditfile3years" true, "creditfilecreated" "2018 09 25", "dateofbirthasreported" "1970 12 12", "morethanonedistinctsource" true, "nameasreported" "testpotkidis,domemic,,", "numberoftrades" "011", "originofcreditfile" "canada", "source" "dz5" } } }, "remarks" \[] } curl location 'https //idu test datazoo com/api/v2/verify' \\ \ header 'content type application/json' \\ \ data '{ "countrycode" "ca", "service" \[ "canada credit bureau" ], "clientreference" "test 0001", "firstname" "felix", "middlename" "", "lastname" "jackson", "dateofbirth" "1985 03 05", "addresselement1" "18894 advent road", "addresselement3" "pitt meadows", "addresselement4" "bc", "addresselement5" "v3y1s1", "consentobtained" { "canada credit bureau" true } }'{ "countrycode" "canada", "clientreference" "cacredittest 001", "reportingreference" "dz e140f309 9820 40d1 9bd6 dfd6a051b8e1", "matchstatus" "full match 1+1 verification", "searcherrormessage" "", "safeharbour" false, "searchstatus" "successful", "serviceresponses" { "canada credit bureau" { "status" 0, "sourcestatus" "successful", "errormessage" "", "identityverified" true, "safeharbourscore" "m1", "namematchscore" "1 000", "addressmatchscore" "1 000", "verifications" { "addresselement1" true, "addresselement3" true, "addresselement4" true, "addresselement5" true, "dateofbirth" true, "firstname" true, "lastname" true }, "returneddata" { "ageofcreditfile>6months" true, "ageoftwotrades>6months" true, "category" "credit – dual source", "cid" "0051219954", "creditfilecreated" "20230201", "numberoftrades" "002", "originofcreditfile" "canada", "source" "dz5", "trades" { "tradenumber1" { "accountnumber" "789022239", "addressasreported" "18894 advent rd,pitt meadows,bc,v3y1s1", "dateofbirthasreported" "1985 03 05", "dateopened" "2023 09 01", "institutionname" "cibc", "nameasreported" "jackson,felix,," }, "tradenumber2" { "accountnumber" "789011139", "addressasreported" "18894 advent rd,pitt meadows,bc,v3y1s1", "dateofbirthasreported" "1985 03 05", "dateopened" "2022 08 30", "institutionname" "tdct tr0522", "nameasreported" "jackson,felix,," } } } } }, "remarks" \[] }