> ## Documentation Index
> Fetch the complete documentation index at: https://developer.kyckr.com/llms.txt
> Use this file to discover all available pages before exploring further.

# New Canada integration for search, lite profile and company profile documents

> Comprehensive Canada integration across all 14 jurisdictions with improved data quality, extra-provincial registration tracking, and Company Profile PDF documents.

## Overview

This update introduces comprehensive Canada integration across all 14 Canadian jurisdictions, bringing significant enhancements to search and lite profile responses. The new integration provides improved data quality with additional fields, clearer identification of extra-provincial registrations, and enhanced historical name tracking. Additionally, Company Profile PDF documents are also available for ordering via filing search across all Canadian jurisdictions. These changes deliver more complete and accurate Canadian corporate data, making it easier to distinguish between home jurisdiction registrations and extra-provincial registrations across federal, provincial, and territorial entities.

## Key changes

* **Registration Authority Code**: Changed from province name (e.g., "British Columbia") to ISO code format (e.g., "CA-BC"), enabling consistent use in the `RegAuth` parameter for subsequent API calls
* **Registration Authority Field**: Now contains the specific registry name (e.g., "British Columbia Corporate Registry", "Ontario Business Registry")
* **Search Response**: Enhanced registration type details for extra-provincial entities
* **Lite Profile**: Expanded to include foundation dates, normalized legal status, previous names, and extra-provincial registration details
* **Company Profile Documents**: PDF registry extracts available for ordering via filing search, containing comprehensive company information
* **\[Future] Enhanced Profile**:  A new fully fielded version of the Company Profile will soon be available.
* **Registration Types**: Clear distinction between home jurisdiction and extra-provincial registrations with normalized jurisdiction codes

## Canadian jurisdictions supported

| Jurisdiction              | Code  | Registration Authority                       |
| ------------------------- | ----- | -------------------------------------------- |
| Alberta                   | CA-AB | Alberta Corporate Registry                   |
| British Columbia          | CA-BC | British Columbia Corporate Registry          |
| Federal                   | CA-FE | Federal Corporate Registry                   |
| Manitoba                  | CA-MB | Manitoba Corporate Registry                  |
| New Brunswick             | CA-NB | New Brunswick Corporate Registry             |
| Newfoundland and Labrador | CA-NL | Newfoundland and Labrador Corporate Registry |
| Nova Scotia               | CA-NS | Nova Scotia Corporate Registry               |
| Northwest Territories     | CA-NT | Northwest Territories Corporate Registry     |
| Nunavut                   | CA-NU | Nunavut Corporate Registry                   |
| Ontario                   | CA-ON | Ontario Business Registry                    |
| Prince Edward Island      | CA-PE | Prince Edward Island Corporate Registry      |
| Quebec                    | CA-QC | Quebec Enterprise Registry                   |
| Saskatchewan              | CA-SK | Saskatchewan Corporate Registry              |
| Yukon                     | CA-YU | Yukon Corporate Registry                     |

### CA-ALL: Cross-jurisdiction search

In addition to the individual jurisdiction codes above, a special **CA-ALL** jurisdiction code is available for search operations. This enables searching across all 14 Canadian jurisdictions sequentially.

#### Use case for CA-ALL

The CA-ALL jurisdiction is particularly useful for name searches, as it helps identify companies with the same or similar names registered in multiple jurisdictions. This is important because:

* A company may be registered federally and also have extra-provincial registrations in several provinces
* Similar or identical company names may exist across different jurisdictions
* Multi-jurisdiction presence is common for Canadian businesses

#### Example: CA-ALL name search

```bash theme={null}
# Search for a company name across all Canadian jurisdictions
curl -X GET "https://rest.kyckr.com/core/company/search/CA-ALL/ACME%20Corporation" \
  -H "Authorization: YOUR_API_KEY" \
  -H "Accept: application/json"
```

The response will include all matches across federal, provincial, and territorial registries, with each result showing its specific jurisdiction code (CA-AB, CA-BC, CA-FE, CA-ON, etc.).

#### Ordering after CA-ALL search

V1 supports two ordering methods because jurisdictions can be searched individually or collectively. When searching a specific jurisdiction (e.g., CA-BC), the `RegAuth` parameter is unnecessary since the jurisdiction is explicit. When using CA-ALL for whole-of-country searches across multiple jurisdictions, the `RegAuth` parameter disambiguates which jurisdiction's data to retrieve.

After a CA-ALL search, use either method for subsequent lite profile, enhanced profile, or filing search requests:

**Method 1**: Use the specific jurisdiction code from search results (e.g., `CA-BC`)

```
GET /lite/profile/CA-BC/FM0258579
```

**Method 2**: Use CA-ALL with the `RegAuth` parameter from the search response `registrationAuthorityCodeField`

```
GET /lite/profile/CA-ALL/FM0258579?RegAuth=CA-BC
```

Both methods are functionally equivalent.

## Technical details

### Search response field changes

The search response has been enhanced with the following new or improved fields:

* `isPreviousNameField`: Boolean indicating if the returned name is a previous name - name search only
* `registrationTypeField`: Type of registration (e.g., "Extra Provincial", or not present)
* `registrationTypeDetailsField`: Details about registration type if present
  * `normalizedCodeField`: Standardized home jurisdiction code (e.g., "CA-BC")
  * `normalizedDescriptionField`: Human-readable home jurisdiction (e.g., "British Columbia (CA)")
  * `originalCodeField`: Original jurisdiction code from source
  * `originalDescriptionField`: Original jurisdiction description

### Example: British Columbia corporation

This example shows improved search data structure for a British Columbia corporation.

#### Before

```json theme={null}
{
  "companiesField": [
    {
      "addressesField": [
        {
          "countryField": "Canada",
          "lineField": [
            {
              "lineField": "British Columbia"
            }
          ],
          "typeField": "",
          "typeCodeField": "",
          "addressInOneLineField": "Canada"
        }
      ],
      "codeField": "FM0258579",
      "companyIDField": "FM0258579",
      "legalFormField": "Business Name",
      "legalStatusField": "Active",
      "nameField": "TAPLIN GROUP HOLDINGS",
      "officialField": false,
      "registrationAuthorityField": "Ministry of Government Services, Canada",
      "registrationAuthorityCodeField": "British Columbia"
    }
  ]
}
```

#### After

```json theme={null}
{
  "companiesField": [
    {
        "addressesField": [
          {
            "countryField": "Canada",
            "addressInOneLineField": "British Columbia, Canada",
            "addressLine1Field": "British Columbia",
            "regionStateField": "British Columbia"
          }
        ],
        "codeField": "FM0258579",
        "companyIDField": "FM0258579",
        "legalFormField": "Sole Proprietorship",
        "legalStatusField": "Active",
        "nameField": "TAPLIN GROUP HOLDINGS",
        "officialField": false,
        "registrationAuthorityField": "British Columbia Corporate Registry",
        "registrationAuthorityCodeField": "CA-BC",
        "registrationNumberField": "FM0258579"
    }
  ]
}
```

### Example: Ontario corporation with improved search data

This example shows an Ontario corporation with improved data structure

#### Before

```json theme={null}
{
  "companiesField": [
    {
      "addressesField": [
        {
          "countryField": "Canada",
          "lineField": [
            {
              "lineField": "ONTARIO"
            }
          ],
          "typeField": "",
          "typeCodeField": "",
          "addressInOneLineField": "Canada"
        }
      ],
      "codeField": "594448",
      "companyIDField": "594448",
      "dateField": "08/08/1984",
      "legalFormField": "ONTARIO BUSINESS CORP.",
      "legalStatusField": "CANCELLEDCB",
      "nameField": "CONNEXIONS GROUP TRAVEL MARKETING LIMITED",
      "officialField": false,
      "registrationAuthorityField": "Ministry of Government Services, Canada",
      "registrationAuthorityCodeField": "ONTARIO"
    }
  ]
}
```

#### After

```json theme={null}
{
  "companiesField": [
    {
      "addressesField": [
        {
          "countryField": "Canada",
          "addressInOneLineField": "OAKVILLE, Ontario, Canada",
          "addressLine1Field": "OAKVILLE",
          "cityTownField": "OAKVILLE",
          "regionStateField": "Ontario"
        }
      ],
      "codeField": "594448",
      "companyIDField": "594448",
      "legalFormField": "Ontario Business Corporation",
      "legalStatusField": "Inactive",
      "nameField": "CONNEXIONS GROUP TRAVEL MARKETING LIMITED",
      "officialField": false,
      "registrationAuthorityField": "Ontario Business Registry",
      "registrationAuthorityCodeField": "CA-ON",
      "registrationNumberField": "594448",
      "isPreviousNameField": false
    }
  ]
}
```

### Example: Quebec corporation

This example is a Quebec extra-provincial corporation, with the legal entity incorporated in Ontario.

#### Before

```json theme={null}
{
   "companiesField": [
      {
        "addressesField": [
          {
            "countryField": "Canada",
            "lineField": [
              {
                "lineField": "Quebec (EP)"
              }
            ],
            "typeField": "",
            "typeCodeField": "",
            "addressInOneLineField": "Canada"
          }
        ],
        "codeField": "1163703896",
        "companyIDField": "1163703896",
        "legalFormField": "Corporation",
        "legalStatusField": "Active",
        "nameField": "CAPITAL INTERNATIONAL ASSET MANAGEMENT (CANADA), INC.",
        "officialField": false,
        "registrationAuthorityField": "Ministry of Government Services, Canada",
        "registrationAuthorityCodeField": "Quebec"
      }
    ]
}
```

#### After

```json theme={null}
{
 "companiesField": [
      {
        "addressesField": [
          {
            "countryField": "Canada",
            "addressInOneLineField": "Quebec, Canada",
            "addressLine1Field": "Quebec",
            "regionStateField": "Quebec"
          }
        ],
        "codeField": "1163703896",
        "companyIDField": "1163703896",
        "legalFormField": "Corporation",
        "legalStatusField": "Registerd",
        "nameField": "CAPITAL INTERNATIONAL ASSET MANAGEMENT (CANADA), INC.",
        "officialField": false,
        "registrationAuthorityField": "Quebec Enterprise Registry",
        "registrationAuthorityCodeField": "CA-QC",
        "registrationNumberField": "1163703896",
        "registrationTypeField": "Extra Provincial",
        "registrationTypeDetailsField": {
          "originalCodeField": "ON",
          "originalDescriptionField": "Ontario",
          "normalizedCodeField": "CA-ON",
          "normalizedDescriptionField": "Ontario (CA)"
        }
      }
    ]
}
```

### Lite profile field changes

The lite profile response has been significantly enhanced with new fields for better data quality and completeness.

* `aliasesField[]`: Alternative names used by the company
* `foundationDateField`: Foundation or registration date
* `normalizedLegalStatusField`: Standardized legal status (e.g., "Active", "Inactive")
* `previousNamesField[]`: Array of historical names
* `registrationNumberField`: Standardized registration number
* `registrationTypeField`: Registration type (e.g., "Extra Provincial")
* `registrationTypeDetailsField`: Home jurisdiction for extra-provincial registrations
  * `normalizedCodeField`: Standardized code (e.g., "CA-BC")
  * `normalizedDescriptionField`: Human-readable jurisdiction
  * `originalCodeField`: Source jurisdiction code
  * `originalDescriptionField`: Source jurisdiction description
* `addressesField[]`: Improved structure with separate city, region, and address line fields
  * `addressLine1Field`: Primary address line
  * `cityTownField`: City name
  * `regionStateField`: Province/territory
* `codeField`: More consistent registration number formatting
* `legalFormField`: More detailed and accurate legal form descriptions
* `legalStatusField`: Jurisdiction-specific status values
* `registrationAuthorityField`: Full corporate registry name

### API call examples

Given this search response:

```json theme={null}
{
  "companiesField": [{
    "codeField": "FM0258579",
    "registrationAuthorityCodeField": "CA-BC"
  }]
}
```

Construct subsequent calls using either:

* `registrationAuthorityCodeField` as the ISO code, OR
* CA-ALL with `registrationAuthorityCodeField` as the `RegAuth` parameter

**Lite Profile:**

```
/lite/profile/CA-BC/FM0258579
/lite/profile/CA-ALL/FM0258579?RegAuth=CA-BC
```

**Enhanced Profile:**

```
/core/company/profile/CA-BC/FM0258579
/core/company/profile/CA-ALL/FM0258579?RegAuth=CA-BC
```

**Filing Search:**

```
/core/filing/search/CA-BC/FM0258579
/core/filing/search/CA-ALL/FM0258579?RegAuth=CA-BC
```

### Example: Quebec corporation with previous names and aliases

This example demonstrates the previous names and aliases tracking for a Quebec extra-provincial corporation.

#### Before

```json theme={null}
{
  "companyProfileField": {
    "activityField": [
      {
        "codeField": "",
        "descriptionField": ""
      }
    ],
    "addressesField": [
      {
        "countryField": "Canada",
        "lineField": [
          {
            "lineField": "",
            "typeField": "",
            "typeCodeField": ""
          }
        ],
        "addressInOneLineField": "Quebec (EP) Canada, Quebec (EP), Canada",
        "addressLine1Field": "Quebec (EP) Canada",
        "addressLine2Field": "",
        "addressLine3Field": "",
        "addressLine4Field": "",
        "cityTownField": "",
        "regionStateField": "Quebec (EP)",
        "postcodeField": ""
      }
    ],
    "codeField": "1163703896",
    "dateField": "2025-10-22T00:15:32.6673008Z",
    "foundationDateField": "",
    "legalFormField": "Corporation",
    "legalStatusField": "Active",
    "nameField": "CAPITAL INTERNATIONAL ASSET MANAGEMENT (CANADA), INC.",
    "officialField": false,
    "registrationAuthorityField": "Ministry of Government Services, Canada"
  }
}
```

#### After

```json theme={null}
{
  "companyProfileField": {
    "addressesField": [
      {
        "countryField": "Canada",
        "addressInOneLineField": "Quebec, Canada",
        "addressLine1Field": "Quebec",
        "regionStateField": "Quebec"
      }
    ],
    "aliasesField": [
      "CAPITAL GROUP",
      "Capital Group (Canada)",
      "Capital Group | Canada",
      "GESTION D'ACTIFS CAPITAL INTERNATIONAL (CANADA)",
      "GROUPE CAPITAL",
      "Groupe Capital (Canada)",
      "Groupe Capital | Canada"
    ],
    "codeField": "1163703896",
    "dateField": "Wed, 22 Oct 2025 00:15:42 GMT",
    "foundationDateField": "2000-10-05",
    "legalFormField": "Corporation",
    "legalStatusField": "Registerd",
    "normalizedLegalStatusField": "Active",
    "nameField": "CAPITAL INTERNATIONAL ASSET MANAGEMENT (CANADA), INC.",
    "officialField": false,
    "registrationAuthorityField": "Quebec Enterprise Registry",
    "registrationNumberField": "1163703896",
    "previousNamesField": [
        "GESTION D'ACTIFS CAPITAL INTERNATIONAL (CANADA)",
        "CAPITAL INTERNATIONAL ASSET MANAGEMENT (CANADA), INC."
    ],
    "registrationTypeField": "Extra Provincial",
    "registrationTypeDetailsField": {
      "originalCodeField": "ON",
      "originalDescriptionField": "Ontario",
      "normalizedCodeField": "CA-ON",
      "normalizedDescriptionField": "Ontario (CA)"
    }
  }
}
```

### Example: Federal corporation with alias

This example shows a federal corporation registered under the Canada Business Corporations Act with a French alias.

#### Before

```json theme={null}
{
  "companyProfileField": {
    "activityField": [
      {
        "codeField": "",
        "descriptionField": ""
      }
    ],
    "addressesField": [
      {
        "countryField": "Canada",
        "lineField": [
          {
            "lineField": "",
            "typeField": "",
            "typeCodeField": ""
          }
        ],
        "addressInOneLineField": "Federal Canada, Federal, Canada",
        "addressLine1Field": "Federal Canada",
        "addressLine2Field": "",
        "addressLine3Field": "",
        "addressLine4Field": "",
        "cityTownField": "",
        "regionStateField": "Federal",
        "postcodeField": ""
      }
    ],
    "codeField": "3572706",
    "dateField": "2025-10-22T00:11:55.1815840Z",
    "foundationDateField": "",
    "legalFormField": "Corporation",
    "legalStatusField": "Inactive",
    "nameField": "CT INVESTMENT MANAGEMENT GROUP INC.",
    "officialField": false,
    "registrationAuthorityField": "Ministry of Government Services, Canada"
  }
}
```

#### After

```json theme={null}
{
  "companyProfileField": {
    "addressesField": [
      {
        "countryField": "Canada",
        "addressInOneLineField": "TORONTO, Canada",
        "addressLine1Field": "TORONTO",
        "cityTownField": "TORONTO"
      }
    ],
    "aliasesField": [
      "GROUPE DE GESTION DE PLACEMENT CT INC."
    ],
    "codeField": "3572706",
    "dateField": "Wed, 22 Oct 2025 00:12:11 GMT",
    "foundationDateField": "1998-12-31",
    "legalFormField": "Canada Business Corporations Act",
    "legalStatusField": "Dscntd",
    "normalizedLegalStatusField": "Inactive",
    "nameField": "CT INVESTMENT MANAGEMENT GROUP INC.",
    "officialField": false,
    "registrationAuthorityField": "Federal Corporate Registry",
    "registrationNumberField": "3572706",
    "previousNamesField": []
  }
}
```

## Ordering Company Profile documents

In addition to search and lite profile data, Company Profile PDF documents are available for all Canadian jurisdictions. These comprehensive registry extracts contain detailed company information including profile data and associated persons.

### Filing search workflow

The complete workflow for ordering Company Profile documents involves three steps:

1. **Filing Search**: Search for available documents for a company
2. **Order Document**: Place an order for the Company Profile document
3. **Download Document**: Retrieve the PDF once ready (usually within 15 minutes)

### Example: Filing search response

```json theme={null}
{
  "productsField": [
      {
        "companyCodeField": "1163136410",
        "countryISOField": "CA-QC",
        "currencyField": "€",
        "deliveryTimeMinutesField": "5",
        "displayDateField": "0001-01-01",
        "idField": "REGHUBOFF_Q29t.............................................xMA==_Q0FfUUNfUkVHSFVCX0NQ_Q0FfUUNfUkVHSFVCX0NQ",
        "priceField": "0",
        "priceTagField": "CA_QC_REGHUB_CP",
        "productFormatField": "PDF",
        "productTitleField": "Company Profile",
        "tierCodeField": "E",
        "tierValueField": "8.00",
        "typeField": "REGHUBOFF",
        "vatChargeField": "0"
      }
    ]
}
```

For more details on filing search and document ordering, see the [Filing Search documentation](/documentation/features/retrieve-a-document-v1).

## Migration guide

### Required updates

1. **Update API call construction**: After CA-ALL searches, use either the specific jurisdiction code or CA-ALL with the `RegAuth` parameter (both methods work identically)

2. **Update field mappings**: Adjust your code to handle new field names and structures
   * Use `registrationAuthorityCodeField` for jurisdiction codes (CA-AB, CA-BC, etc.)
   * Access city and province data from new structured address fields
   * Use `foundationDateField` for company founding/registration dates
   * Use `registrationNumberField` for standardized registration numbers

3. **Handle extra-provincial registrations**:
   * Check `registrationTypeField` to identify extra-provincial registrations
   * Use `registrationTypeDetailsField` to determine the home jurisdiction
   * Example: A BC company registered in NS will show registrationType="Extra Provincial" with normalizedCode="CA-BC"

4. **Process previous names and aliases**:
   * Use `previousNamesField[]` array to access historical company names
   * Use `aliasesField[]` for alternative names
   * Check `isPreviousNameField` to determine if the current result represents a previous name - name search only

5. **Update legal status handling**:
   * Use `normalizedLegalStatusField` (lite profile) for consistent Active/Inactive values
   * Original jurisdiction-specific status values remain in `legalStatusField`

6. **Enhanced address parsing**:
   * Leverage new `addressLine1Field`, `cityTownField`, and `regionStateField` for better address handling
   * Addresses now include proper province/territory names instead of generic descriptors

### Impact assessment

This change affects systems that:

* **Store Canadian company data**: Update database schemas to accommodate new fields
* **Display company information**: Take advantage of richer data for better user experience
* **Track company history**: Leverage previous names and foundation dates for better historical tracking
* **Distinguish registration types**: Identify extra-provincial vs. home jurisdiction registrations
* **Parse addresses**: Benefit from structured city and province/territory fields

### Testing recommendations

1. **Test across jurisdictions**: Verify handling of all 14 Canadian jurisdictions (CA-AB, CA-BC, CA-FE, CA-MB, CA-NB, CA-NL, CA-NS, CA-NT, CA-NU, CA-ON, CA-PE, CA-QC, CA-SK, CA-YU) and also the country search CA-ALL
2. **Extra-provincial scenarios**: Test companies with extra-provincial registrations to ensure proper home jurisdiction identification
3. **Previous names**: Validate proper handling of companies with name changes
4. **Date formatting**: Ensure foundation and incorporation dates are parsed correctly (YYYY-MM-DD format)
5. **Address parsing**: Test address structure handling, especially for entries with city and province data

## Additional resources

* [Search API Documentation](/documentation/features/search-for-a-company-v1)
* [Lite Profile Documentation](/documentation/features/verify-basic-details-v1)
* [Enhanced Profile Documentation](/documentation/features/perform-a-kyb-check-v1)