Skip to main content

​
Request

[POST]
{{baseUrl}}/api/v1/ca/kyc
HeaderTypeDescription
AppIdstringCreate an app to get your app ID on dashboard here
AuthorizationstringPrivate/secret key. Use <key> not Bearer <key>

​
Body parameter

ParameterTypeDescriptionRequired
first_name *stringFirst Namerequired
last_name *stringLast Namerequired
middle_namestringMiddle Nameoptional
date_of_birthstringDate Of Birthrequired
gender *stringM,Frequired
street_name *stringStreet Namerequired
house_number *stringHouse Numberrequired
city *stringCityrequired
post_code *stringPost Coderequired

​
Sample response

Response

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

​
Response Fields

FieldTypeDescription
entityobjectContains the eKYC verification result
entity.creditReferenceobjectCredit reference verification data
entity.creditReference.creditReferenceRecordsobjectContainer for credit reference records
entity.creditReference.creditReferenceRecords.creditReferenceRecordListarrayList of matched credit reference records
entity.creditReference.creditReferenceRecords.creditReferenceRecordList[].addressesobjectAddress records container
entity.creditReference.creditReferenceRecords.creditReferenceRecordList[].addresses.addressListarrayList of addresses on file
entity.creditReference.creditReferenceRecords.creditReferenceRecordList[].addresses.addressList[].countryCodestringCountry code (e.g., “CAN”)
entity.creditReference.creditReferenceRecords.creditReferenceRecordList[].addresses.addressList[].postTownstringPost town or city name
entity.creditReference.creditReferenceRecords.creditReferenceRecordList[].addresses.addressList[].postcodestringPostal code
entity.creditReference.creditReferenceRecords.creditReferenceRecordList[].addresses.addressList[].premisestringPremise or building number
entity.creditReference.creditReferenceRecords.creditReferenceRecordList[].addresses.addressList[].regionstringProvince or region code
entity.creditReference.creditReferenceRecords.creditReferenceRecordList[].addresses.addressList[].streetstringStreet name
entity.creditReference.creditReferenceRecords.creditReferenceRecordList[].personobjectPerson details from credit reference
entity.creditReference.creditReferenceRecords.creditReferenceRecordList[].person.dateOfBirthstringDate of birth (YYYY-MM-DD)
entity.creditReference.creditReferenceRecords.creditReferenceRecordList[].person.nameobjectPerson’s name details
entity.creditReference.creditReferenceRecords.creditReferenceRecordList[].person.name.forenamestringFirst name
entity.creditReference.creditReferenceRecords.creditReferenceRecordList[].person.name.surnamestringLast name
entity.creditReference.creditReferenceSummaryobjectCredit reference summary
entity.creditReference.creditReferenceSummary.idVerifiedstringID verification status (“1” for verified)
entity.creditReference.summaryobjectCredit reference decision summary
entity.creditReference.summary.decisionstringDecision outcome (“1” for pass)
entity.creditReference.summary.decisionReasonsobjectContainer for decision reasons
entity.creditReference.summary.decisionReasons.decisionReasonListarrayList of individual decision reasons
entity.creditReference.summary.decisionReasons.decisionReasonList[].decisionstringDecision for this element (“1” for match)
entity.creditReference.summary.decisionReasons.decisionReasonList[].elementstringXPath-like reference to the verified data element
entity.searchRefstringUnique reference ID for this search transaction
entity.summaryobjectOverall verification summary
entity.summary.decisionMatrixobjectDecision matrix details
entity.summary.decisionMatrix.codestringDecision matrix code
entity.summary.decisionMatrix.decisionobjectOverall decision result
entity.summary.decisionMatrix.decision.outcomestringDecision outcome (“1” for pass)
entity.summary.decisionMatrix.decision.reasonstringHuman-readable reason for the decision
entity.summary.decisionMatrix.namestringDecision matrix name
entity.summary.decisionMatrix.rulesobjectRules applied during verification
entity.summary.decisionMatrix.rules.ruleListarrayList of applied verification rules
entity.summary.decisionMatrix.rules.ruleList[].idstringRule identifier (data block name)
entity.summary.decisionMatrix.rules.ruleList[].namestringRule name
entity.summary.decisionMatrix.rules.ruleList[].outcomestringRule outcome (“1” for pass)
entity.summary.decisionMatrix.rules.ruleList[].reasonstringHuman-readable reason for the rule outcome
entity.summary.kycSummaryobjectKYC match counts summary
entity.summary.kycSummary.addressobjectAddress match summary
entity.summary.kycSummary.address.countstringNumber of address matches found
entity.summary.kycSummary.alertsobjectAlerts summary
entity.summary.kycSummary.alerts.countstringNumber of alerts triggered
entity.summary.kycSummary.dateOfBirthobjectDate of birth match summary
entity.summary.kycSummary.dateOfBirth.countstringNumber of DOB matches found
entity.summary.kycSummary.fullNameAndAddressobjectFull name and address match summary
entity.summary.kycSummary.fullNameAndAddress.countstringNumber of full name + address matches
entity.summary.kycSummary.surnameAndAddressobjectSurname and address match summary
entity.summary.kycSummary.surnameAndAddress.countstringNumber of surname + address matches
entity.summary.reportSummaryobjectReport summary details
entity.summary.reportSummary.datablocksSummaryobjectData blocks summary container
entity.summary.reportSummary.datablocksSummary.datablockSummaryListarrayList of data block results
entity.summary.reportSummary.datablocksSummary.datablockSummaryList[].decisionstringDecision for this data block (“1” for pass)
entity.summary.reportSummary.datablocksSummary.datablockSummaryList[].namestringData block name (e.g., “CreditReference”, “Telephony”)
entity.telephonyobjectTelephony verification data
entity.telephony.summaryobjectTelephony verification summary
entity.telephony.summary.decisionstringTelephony decision outcome (“1” for pass)
entity.telephony.summary.decisionReasonsobjectContainer for telephony decision reasons
entity.telephony.summary.decisionReasons.decisionReasonListarrayList of telephony decision reasons
entity.telephony.summary.decisionReasons.decisionReasonList[].decisionstringDecision for this element (“1” for match)
entity.telephony.summary.decisionReasons.decisionReasonList[].elementstringXPath-like reference to the verified data element
entity.telephony.telephonyRecordobjectTelephony record details
entity.telephony.telephonyRecord.addressobjectAddress from telephony records
entity.telephony.telephonyRecord.address.countryCodestringCountry code
entity.telephony.telephonyRecord.address.currentstringWhether address is current (“1” for yes)
entity.telephony.telephonyRecord.address.postTownstringPost town or city name
entity.telephony.telephonyRecord.address.postcodestringPostal code
entity.telephony.telephonyRecord.address.premisestringPremise or building number
entity.telephony.telephonyRecord.address.regionstringProvince or region code
entity.telephony.telephonyRecord.address.streetstringStreet name
entity.telephony.telephonyRecord.personobjectPerson from telephony records
entity.telephony.telephonyRecord.person.nameobjectPerson’s name
entity.telephony.telephonyRecord.person.name.forenamestringFirst name
entity.telephony.telephonyRecord.person.name.surnamestringLast name
entity.telephony.telephonyRecord.telephonesobjectTelephone records container
entity.telephony.telephonyRecord.telephones.telephoneListarrayList of telephone numbers
entity.telephony.telephonyRecord.telephones.telephoneList[].customerTypestringCustomer type code (e.g., “R” for residential)
entity.telephony.telephonyRecord.telephones.telephoneList[].listingTypestringDirectory listing type code
entity.telephony.telephonyRecord.telephones.telephoneList[].numberstringPhone number
entity.telephony.telephonyRecord.telephones.telephoneList[].typestringPhone type code
entity.telephony.typestringTelephony result type (e.g., “Result”)