W2 Data EKYC CA 005

Compatible Cases

About the service

W2 Data EKYC CA 005 is an identity verification service for Canada. It uses Credit Reference Data, Telephone Directory, Passports and ID Card. This service will leave a credit lenders footprint.

Product Code: W2-DATA-EKYC-CA-005

Does this service leave a credit search Footprint? Yes

Request

Query Data

The following QueryData elements pertain to this service.

Property Name	Type	Length	Optional/Mandatory	Notes
Forename	String	15	Mandatory
MiddleNames	String	15	Optional
Surname	String	30	Mandatory
Gender	String		Optional	Must be 'M' or 'F' if provided
DayOfBirth	Integer	2	Optional
MonthOfBirth	Integer	2	Optional
YearOfBirth	Integer	4	Optional
HouseName	String	26	Mandatory if no HouseNumber given
HouseNumber	String	10	Mandatory if no HouseName given
Street	String	255	Mandatory
Region	String	2	Mandatory	Must be a Canadian province code in two letter format, e.g. "AB"
City	String	100	Mandatory
Postcode	String	5	Mandatory
Phone Number	String	16	Optional	Please provide the phone number as one contiguous set of numbers with no other characters or spaces.
PersonalId	String	11	Optional	Personal ID is US Social Security Number and can be in either of these formats:'xxx-xxx-xxx' or 'xxxxxxxxx'

After performing the search, the validation result (pass, fail, etc. will be part of the TransactionInformation returned for the service call.

Example Request

The following is an example request:

json

"Data": {
	"City": "Edmonton",
	"DayOfBirth": 12,
	"Forename": "Robert",
	"HouseNumber": "3688",
	"MonthOfBirth": 12,
	"Postcode": "T5J 2R4",
	"Region": "AB",
	"Street": "184th Street",
	"Surname": "Beck",
	"YearOfBirth": 1969
}

Response

Example Response

The following is an example of a typical response:

json

"w2DataEkycCa005Result": {
	"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"
	}
}

Response breakdown

The following tables give more detail about the various response elements:

Property Name	Type	Description
SearchRef	String	Unique identifier for this search
Summary	Summary	Summary of information returned from various data sources
Telephony	TelephonyResult	Results of check from telephone records
DriverLicence	DriverLicenceResult	Results of check from driving licence records
Passport	PassportResult	Results of check from passport records
CreditReference	CreditReferenceResult	Results of credit check

Summary

Property Name	Type	Description
KYCSummary	KYCSummary	Summary of KYC result
ReportSummary	ReportSummary	Summary of individual source checks
DecisionMatrix	DecisionMatrix	Block containing 2 + 2 matching result

KYCSummary

Property Name	Type	Description
FullNameAndAddress	FullNameAndAddressKYCSummary	Count of name+address matches
SurnameAndAddress	SurnameAndAddressKYCSummary	Count of surname+address matches
Address	AddressKYCSummary	Count of address matches found
DateOfBirth	DateOfBirthKYCSummary	Count of date of birth matches
Alerts	AlertsKYCSummary	Count of alert matches found

Report Summary

A report summary contains a few nested items that resemble the follwoing:

json

"reportSummary": {
	"datablocksSummary": {
		"datablockSummaryList": [{
				"decision": "1",
				"name": "CreditReference"
			}, {
				"decision": "1",
				"name": "Telephony"
			}
		]
	}
}

Decision Matrix

Block containing 2 + 2 matching result.

json

"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"
			}
		]
	}
}

Sandbox

Query options for Sandbox:

json

"options": {
	"sandbox": "true"
}

If the Sandbox query option is set to "true" then the following results can be achieved:

PASS

If the following details are set, a single fictitious match is returned in W2DataEkycUs005Result

Property	Value
City:	"Edmonton"
DayOfBirth:	12
Forename:	"Robert"
HouseNumber:	"3688"
MonthOfBirth:	12
Postcode:	"T5J 2R4"
Region:	"AB"
Street:	"184th Street"
Surname:	"Beck"
YearOfBirth:	1969

The corresponding entry in ServiceTransactions will show the following properties:

Property	Value
HaltTriggered:	False
ServiceTransactionResult:	Success
ServiceInterpretResult:	Pass
ServiceTransactionResultMessage:	"This call was generated using sandbox mode"
ValidationResult:	NotApplicable

FAIL

If the following details are set, a single fictitious match is returned in W2DataEkycUs005Result

Property	Value
City:	"Ottawa"
DayOfBirth:	06
Forename:	"Paul"
HouseNumber:	"4414"
MonthOfBirth:	03
Postcode:	"K1P 5J4"
Region:	"ON"
Street:	"Thurston Dr"
Surname:	"Shea"
YearOfBirth:	1993

The corresponding entry in ServiceTransactions will show the following properties:

Property	Value
HaltTriggered:	False
ServiceTransactionResult:	Success
ServiceInterpretResult:	Fail
ServiceTransactionResultMessage:	"This call was generated using sandbox mode"
ValidationResult:	NotApplicable

Otherwise a fictitious no-match is returned.

The corresponding entry in ServiceTransactions will show the following properties:

Property	Value
HaltTriggered:	False
ServiceTransactionResult:	Success
ServiceInterpretResult:	NotApplicable
ServiceTransactionResultMessage:	"This call was generated using sandbox mode"
ValidationResult:	NotApplicable

W2 Data EKYC CA 005 ​

About the service ​

Request ​

Query Data ​

Example Request ​

Response ​

Example Response ​

Response breakdown ​

Summary ​

KYCSummary ​

Report Summary ​

Decision Matrix ​

Sandbox ​

If the Sandbox query option is set to "true" then the following results can be achieved: ​

PASS ​

FAIL ​

Otherwise a fictitious no-match is returned. ​

W2 Data EKYC CA 005

About the service

Request

Query Data

Example Request

Response

Example Response

Response breakdown

Summary

KYCSummary

Report Summary

Decision Matrix

Sandbox

If the Sandbox query option is set to "true" then the following results can be achieved:

PASS

FAIL

Otherwise a fictitious no-match is returned.