> ## Documentation Index > Fetch the complete documentation index at: https://docs.dojah.io/llms.txt > Use this file to discover all available pages before exploring further. # Canada eKYC > This is an Identity verification service for the Canada, It uses Credit Reference Data, Telephone Directory, Passports and ID Card. ### Request ```http [POST] theme={null} {{baseUrl}}/api/v1/ca/kyc ``` ### Header | Header | Type | Description | | ------------- | ------ | --------------------------------------------------------------------------------------------------- | | AppId | string | Create an app to get your app ID on dashboard [here](https://app.dojah.io/developers/configuration) | | Authorization | string | Private/secret key. Use `` not `Bearer ` | ### Body parameter | Parameter | Type | Description | Required | | ---------------- | ------ | ------------- | -------- | | first\_name \* | string | First Name | required | | last\_name \* | string | Last Name | required | | middle\_name | string | Middle Name | optional | | date\_of\_birth | string | Date Of Birth | required | | gender \* | string | M,F | required | | street\_name \* | string | Street Name | required | | house\_number \* | string | House Number | required | | city \* | string | City | required | | post\_code \* | string | Post Code | required | ### Sample response ```json Response theme={null} { "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": "John", "surname": "Musa" } } } ] }, "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": "John", "surname": "Musa" } }, "telephones": { "telephoneList": [{ "customerType": "R", "listingType": "DQ", "number": "780-916-3124", "type": "U" } ] } }, "type": "Result" } } } ``` ### Response Fields | Field | Type | Description | | --------------------------------------------------------------------------------------------------------------- | ------ | ------------------------------------------------------ | | entity | object | Contains the eKYC verification result | | entity.creditReference | object | Credit reference verification data | | entity.creditReference.creditReferenceRecords | object | Container for credit reference records | | entity.creditReference.creditReferenceRecords.creditReferenceRecordList | array | List of matched credit reference records | | entity.creditReference.creditReferenceRecords.creditReferenceRecordList\[].addresses | object | Address records container | | entity.creditReference.creditReferenceRecords.creditReferenceRecordList\[].addresses.addressList | array | List of addresses on file | | entity.creditReference.creditReferenceRecords.creditReferenceRecordList\[].addresses.addressList\[].countryCode | string | Country code (e.g., "CAN") | | entity.creditReference.creditReferenceRecords.creditReferenceRecordList\[].addresses.addressList\[].postTown | string | Post town or city name | | entity.creditReference.creditReferenceRecords.creditReferenceRecordList\[].addresses.addressList\[].postcode | string | Postal code | | entity.creditReference.creditReferenceRecords.creditReferenceRecordList\[].addresses.addressList\[].premise | string | Premise or building number | | entity.creditReference.creditReferenceRecords.creditReferenceRecordList\[].addresses.addressList\[].region | string | Province or region code | | entity.creditReference.creditReferenceRecords.creditReferenceRecordList\[].addresses.addressList\[].street | string | Street name | | entity.creditReference.creditReferenceRecords.creditReferenceRecordList\[].person | object | Person details from credit reference | | entity.creditReference.creditReferenceRecords.creditReferenceRecordList\[].person.dateOfBirth | string | Date of birth (YYYY-MM-DD) | | entity.creditReference.creditReferenceRecords.creditReferenceRecordList\[].person.name | object | Person's name details | | entity.creditReference.creditReferenceRecords.creditReferenceRecordList\[].person.name.forename | string | First name | | entity.creditReference.creditReferenceRecords.creditReferenceRecordList\[].person.name.surname | string | Last name | | entity.creditReference.creditReferenceSummary | object | Credit reference summary | | entity.creditReference.creditReferenceSummary.idVerified | string | ID verification status ("1" for verified) | | entity.creditReference.summary | object | Credit reference decision summary | | entity.creditReference.summary.decision | string | Decision outcome ("1" for pass) | | entity.creditReference.summary.decisionReasons | object | Container for decision reasons | | entity.creditReference.summary.decisionReasons.decisionReasonList | array | List of individual decision reasons | | entity.creditReference.summary.decisionReasons.decisionReasonList\[].decision | string | Decision for this element ("1" for match) | | entity.creditReference.summary.decisionReasons.decisionReasonList\[].element | string | XPath-like reference to the verified data element | | entity.searchRef | string | Unique reference ID for this search transaction | | entity.summary | object | Overall verification summary | | entity.summary.decisionMatrix | object | Decision matrix details | | entity.summary.decisionMatrix.code | string | Decision matrix code | | entity.summary.decisionMatrix.decision | object | Overall decision result | | entity.summary.decisionMatrix.decision.outcome | string | Decision outcome ("1" for pass) | | entity.summary.decisionMatrix.decision.reason | string | Human-readable reason for the decision | | entity.summary.decisionMatrix.name | string | Decision matrix name | | entity.summary.decisionMatrix.rules | object | Rules applied during verification | | entity.summary.decisionMatrix.rules.ruleList | array | List of applied verification rules | | entity.summary.decisionMatrix.rules.ruleList\[].id | string | Rule identifier (data block name) | | entity.summary.decisionMatrix.rules.ruleList\[].name | string | Rule name | | entity.summary.decisionMatrix.rules.ruleList\[].outcome | string | Rule outcome ("1" for pass) | | entity.summary.decisionMatrix.rules.ruleList\[].reason | string | Human-readable reason for the rule outcome | | entity.summary.kycSummary | object | KYC match counts summary | | entity.summary.kycSummary.address | object | Address match summary | | entity.summary.kycSummary.address.count | string | Number of address matches found | | entity.summary.kycSummary.alerts | object | Alerts summary | | entity.summary.kycSummary.alerts.count | string | Number of alerts triggered | | entity.summary.kycSummary.dateOfBirth | object | Date of birth match summary | | entity.summary.kycSummary.dateOfBirth.count | string | Number of DOB matches found | | entity.summary.kycSummary.fullNameAndAddress | object | Full name and address match summary | | entity.summary.kycSummary.fullNameAndAddress.count | string | Number of full name + address matches | | entity.summary.kycSummary.surnameAndAddress | object | Surname and address match summary | | entity.summary.kycSummary.surnameAndAddress.count | string | Number of surname + address matches | | entity.summary.reportSummary | object | Report summary details | | entity.summary.reportSummary.datablocksSummary | object | Data blocks summary container | | entity.summary.reportSummary.datablocksSummary.datablockSummaryList | array | List of data block results | | entity.summary.reportSummary.datablocksSummary.datablockSummaryList\[].decision | string | Decision for this data block ("1" for pass) | | entity.summary.reportSummary.datablocksSummary.datablockSummaryList\[].name | string | Data block name (e.g., "CreditReference", "Telephony") | | entity.telephony | object | Telephony verification data | | entity.telephony.summary | object | Telephony verification summary | | entity.telephony.summary.decision | string | Telephony decision outcome ("1" for pass) | | entity.telephony.summary.decisionReasons | object | Container for telephony decision reasons | | entity.telephony.summary.decisionReasons.decisionReasonList | array | List of telephony decision reasons | | entity.telephony.summary.decisionReasons.decisionReasonList\[].decision | string | Decision for this element ("1" for match) | | entity.telephony.summary.decisionReasons.decisionReasonList\[].element | string | XPath-like reference to the verified data element | | entity.telephony.telephonyRecord | object | Telephony record details | | entity.telephony.telephonyRecord.address | object | Address from telephony records | | entity.telephony.telephonyRecord.address.countryCode | string | Country code | | entity.telephony.telephonyRecord.address.current | string | Whether address is current ("1" for yes) | | entity.telephony.telephonyRecord.address.postTown | string | Post town or city name | | entity.telephony.telephonyRecord.address.postcode | string | Postal code | | entity.telephony.telephonyRecord.address.premise | string | Premise or building number | | entity.telephony.telephonyRecord.address.region | string | Province or region code | | entity.telephony.telephonyRecord.address.street | string | Street name | | entity.telephony.telephonyRecord.person | object | Person from telephony records | | entity.telephony.telephonyRecord.person.name | object | Person's name | | entity.telephony.telephonyRecord.person.name.forename | string | First name | | entity.telephony.telephonyRecord.person.name.surname | string | Last name | | entity.telephony.telephonyRecord.telephones | object | Telephone records container | | entity.telephony.telephonyRecord.telephones.telephoneList | array | List of telephone numbers | | entity.telephony.telephonyRecord.telephones.telephoneList\[].customerType | string | Customer type code (e.g., "R" for residential) | | entity.telephony.telephonyRecord.telephones.telephoneList\[].listingType | string | Directory listing type code | | entity.telephony.telephonyRecord.telephones.telephoneList\[].number | string | Phone number | | entity.telephony.telephonyRecord.telephones.telephoneList\[].type | string | Phone type code | | entity.telephony.type | string | Telephony result type (e.g., "Result") |