Canada

Canada eKYC verification matches submitted individual data against Canadian sources of truth. See the eKYC API Reference for common response semantics that apply across all sources.

Available sources

CA RES CREDIT

Request parameters

Response fields

CA RES CREDIT anchors verification on the source-of-truth register. See the eKYC API Reference for common match field definitions and status values.

overallLevel calculation

overallLevel is calculated based on the risk associated with the submitted full name, postal code, and date of birth:

• low when fullNameMatch, postalCodeMatch, and dobMatch are all exact.
• high when fullNameMatch, postalCodeMatch, and dobMatch are all nomatch.
• medium for all other combinations.

Contact your Incode representative to customize the overallLevel calculation for your use case.

Sample response

{
    "kyc": [
        { "key": "firstNameMatch", "status": "exact" },
        { "key": "middleNameMatch", "status": "exact" },
        { "key": "lastNameMatch", "status": "nomatch" },
        { "key": "fullNameMatch", "status": "nomatch" },
        { "key": "dobMatch", "status": "exact" },
        { "key": "streetMatch", "status": "exact" },
        { "key": "cityMatch", "status": "exact" },
        { "key": "stateMatch", "status": "exact" },
        { "key": "postalCodeMatch", "status": "exact" },
        { "key": "fullAddressMatch", "status": "fuzzy" },
        { "key": "phoneMatch", "status": "nomatch" },
        { "key": "overallLevel", "status": "medium" }
    ]
}

CA Credit Bureau FINTRAC

Canada eKYC non-doc verification leverages Canada's source of truth to validate individuals. It is essential in eKYC processes for ensuring identity authenticity, regulatory compliance, and enhanced security. It helps prevent fraud, boosts user trust, and streamlines operations through automated and efficient verification methods.

eKYC module configuration gives various options to specify different search criteria with various sources of truth for each country (eg. US has multiple via Telco, Credit Bureau, and Driver's License). User data can be collected via a user input flow by using pre-selected fields where users can type in their name or date of birth, etc. See an example below:

Module Configuration

The module configuration can be leveraged to select the applicable fields for the input data you would like to collect from the end user.

Direct API Approach

All module configurations and user data can be forwarded directly in the request for performing an eKYC search. This will override existing configuration and data collected about the user.

All endpoints require authentication headers to be specified as stated in Incode API Documentation

eKYC request

POST /omni/externalVerification/ekyc

This endpoint performs an eKYC check for the individual specified. Note: Endpoint can have empty body {} and in that case information will be pulled from module configuration and session details.

• country: (mandatory) String. Two letter Alpha-2 country code. Must be CA.
• source: (mandatory) String. Must be CA_RES_CREDIT or CA_CREDIT_FINTRAC.
• firstName:: (mandatory) String. First name of the individual.
• surName: (mandatory) String. Last name of the individual.
• middleName:: (optional) String.
• street: (mandatory) String. (Address = street + houseNo in CA)
• city: (mandatory) String. City of the individual's address. (eg. Toronto).
• state: (mandatory) String.
• postalCode: (mandatory) String. postalCode formatted based on per-country postalCode basis.
• dateOfBirth: (mandatory) String. Format: YYYY-MM-DD (eg. 1980-06-21)
• phone: (mandatory) String.

Example Incode requests:

{
    "plugins": ["kyc"],
      "source": "CA_RES_CREDIT", //mandatory
    "firstName": "Daniel", //mandatory
    "middleName": "", //optional
    "surName": "Whitmore ", //mandatory
    "street": "2799 Maplewood Crescent", //mandatory - houseNo + street
    "city" : "Ottawa", //mandatory
    "state": "ON", // mandatory
    "postalCode": "K1R7X5", //mandatory
    "country": "CA", //mandatory
    "dateOfBirth" : "1991-08-02", //mandatory
    "phone": "+12048900252", //mandatory
}

{
    "plugins": ["kyc"],
      "source": "CA_CREDIT_FINTRAC", 
    "firstName": "John",
    "middleName": "", 
    "surName": "Doe",
    "street": "97 Main St",
    "city" : "Ottawa",
    "state": "ON",
    "postalCode": "K1M1N8",
    "country": "CA", 
    "dateOfBirth" : "1990-12-12", 
}

Direct API Response

All endpoints require authentication headers to be specified as stated in Incode API Documentation

Example Incode responses:

{
    "kyc": [
        {
            "key": "firstNameMatch",
            "status": "Exact"; 
        },
        {
            "key": "middleNameMatch",
            "status": "Exact"
        },
        {
            "key": "lastNameMatch",
            "status": "Approximate Match"
        },
        {
            "key": "fullNameMatch",
            "status": "Fuzzy"
        },
        {
            "key": "dobMatch",
            "status": "Exact"
        },
        {
            "key": "streetMatch",
            "status": "Exact"
        },
        {
            "key": "cityMatch",
            "status": "Exact"
        },
        {
            "key": "stateMatch",
            "status": "Exact"
        },
        {
            "key": "postalCodeMatch",
            "status": "Exact"
        },
        {
            "key": "fullAddressMatch",
            "status": "Fuzzy"
        },
        {
            "key": "phoneMatch",
            "status": "Match"
        },
        {
            "key": "overallLevel",
            "status": "Low"
        }
    ]
}

{
    "kyc": [
        {
            "key": "firstNameMatch",
            "status": "Exact"; 
        },
        {
            "key": "middleNameMatch",
            "status": "No Match"
        },
        {
            "key": "lastNameMatch",
            "status": "Exact"
        },
        {
            "key": "fullNameMatch",
            "status": "Exact"
        },
        {
            "key": "dobMatch",
            "status": "Exact"
        },
        {
            "key": "streetMatch",
            "status": "Exact"
        },
        {
            "key": "cityMatch",
            "status": "Exact"
        },
        {
            "key": "stateMatch",
            "status": "Exact"
        },
        {
            "key": "postalCodeMatch",
            "status": "Exact"
        },
        {
            "key": "fullAddressMatch",
            "status": "Exact"
        },
        {
            "key": "overallLevel",
            "status": "Low"
        },
        {
                "key": "creditFileNumber", 
                "status": "123456789"
                
        },
        {
                "key": "creditFileCreationDate", 
          "status": "01-14-2000"
        }
    ]
}

eKYC error responses

Please refer to error response to see conventional HTTP response codes to indicate the success or failure of an API request. For Canada, custom 400 error messages if taxId, or country is “ “ or null:

overallLevel

Overall Level is the API response key for the submitted name. The fields low, medium, and high are mapped to a proprietary fuzzy matching algorithm that is mapped to a score from 0 to 100.

As a default, overallLevel will return:

low: when fullNameMatch & postalCodeMatch & dobMatch are exact;

high: when fullNameMatch & postalCodeMatch & dobMatch are nomatch;

medium: for all otherwise combination.

Single Session Dashboard Result