Canada eKYC

Verify a Canadian Identity across multiple sources

This is an Identity verification service for the Canada, It uses Credit Reference Data, Telephone Directory, Passports and ID Card.

Parameters

{{baseUrl}}/api/v1/ca/kyc

Header

HeaderTypeDescription
AppIdstringyou would need to create an app to get your app ID
Authorizationstringpublic secret key e.g prod_sk_1T1eSavlZxy02OT3OWlvbxK4G

Body

Parameter Type Description
first_name * string required
last_name * string required
middle_name string
date_of_birth string
gender * string M,F required
street_name * string required
house_number * string required
city * string required
post_code * string Required

Response Sample

{
  "entity": {
	"creditReference": {
		"creditReferenceRecords": {
			"creditReferenceRecordList": [{
					"addresses": {
						"addressList": [{
								"countryCode": "CAN",
								"postTown": "Edmonton",
								"postcode": "T5J 2R4",
								"premise": "3688",
								"region": "AB",
								"street": "184th Street"
							}
						]
					},
					"person": {
						"dateOfBirth": "1969-12-12",
						"name": {
							"forename": "Robert",
							"surname": "Beck"
						}
					}
				}
			]
		},
		"creditReferenceSummary": {
			"idVerified": "1"
		},
		"summary": {
			"decision": "1",
			"decisionReasons": {
				"decisionReasonList": [{
						"decision": "1",
						"element": "CreditReferenceSummary/IDVerified"
					}, {
						"decision": "1",
						"element": "CreditReferenceRecord/Person/Name/Forename"
					}, {
						"decision": "1",
						"element": "CreditReferenceRecord/Person/Name/Surname"
					}, {
						"decision": "1",
						"element": "CreditReferenceRecord/Person/DateOfBirth"
					}, {
						"decision": "1",
						"element": "CreditReferenceRecord/Addresses/Address/@Current"
					}, {
						"decision": "1",
						"element": "CreditReferenceRecord/Addresses/Address/Premise"
					}, {
						"decision": "1",
						"element": "CreditReferenceRecord/Addresses/Address/Street"
					}, {
						"decision": "1",
						"element": "CreditReferenceRecord/Addresses/Address/PostTown"
					}, {
						"decision": "1",
						"element": "CreditReferenceRecord/Addresses/Address/Postcode"
					}
				]
			}
		}
	},
	"searchRef": "37873fcc-6281-4913-b6df-5f26497abfab",
	"summary": {
		"decisionMatrix": {
			"code": "******",
			"decision": {
				"outcome": "1",
				"reason": "Individual has a full match to forename surname premise postcode with ID verified and DOB"
			},
			"name": "****************",
			"rules": {
				"ruleList": [{
						"id": "CreditReference Datablock",
						"name": "BSO/CAN/Bespoke/Nam/NameDOB",
						"outcome": "1",
						"reason": "Individual has a full match to forename surname and DOB"
					}, {
						"id": "Telephony Datablock",
						"name": "BSO/CAN/Bespoke/NamPremPC/ID/90/NameAddress",
						"outcome": "1",
						"reason": "Individual has a full match to forename surname premise postcode"
					}
				]
			}
		},
		"kycSummary": {
			"address": {
				"count": "4"
			},
			"alerts": {
				"count": "0"
			},
			"dateOfBirth": {
				"count": "3"
			},
			"fullNameAndAddress": {
				"count": "1"
			},
			"surnameAndAddress": {
				"count": "0"
			}
		},
		"reportSummary": {
			"datablocksSummary": {
				"datablockSummaryList": [{
						"decision": "1",
						"name": "CreditReference"
					}, {
						"decision": "1",
						"name": "Telephony"
					}
				]
			}
		}
	},
	"telephony": {
		"summary": {
			"decision": "1",
			"decisionReasons": {
				"decisionReasonList": [{
						"decision": "1",
						"element": "TelephonyRecord/Person/Name/Forename"
					}, {
						"decision": "1",
						"element": "TelephonyRecord/Person/Name/Surname"
					}, {
						"decision": "1",
						"element": "TelephonyRecord/Address/Premise"
					}, {
						"decision": "1",
						"element": "TelephonyRecord/Address/Postcode"
					}
				]
			}
		},
		"telephonyRecord": {
			"address": {
				"countryCode": "CAN",
				"current": "1",
				"postTown": "Edmonton",
				"postcode": "T5J 2R4",
				"premise": "3688",
				"region": "AB",
				"street": "184th Street"
			},
			"person": {
				"name": {
					"forename": "Robert",
					"surname": "Beck"
				}
			},
			"telephones": {
				"telephoneList": [{
						"customerType": "R",
						"listingType": "DQ",
						"number": "780-916-3124",
						"type": "U"
					}
				]
			}
		},
		"type": "Result"
	}
}