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.
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
RegAuthparameter 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
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), theRegAuth 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)
RegAuth parameter from the search response registrationAuthorityCodeField
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 onlyregistrationTypeField: Type of registration (e.g., “Extra Provincial”, or not present)registrationTypeDetailsField: Details about registration type if presentnormalizedCodeField: Standardized home jurisdiction code (e.g., “CA-BC”)normalizedDescriptionField: Human-readable home jurisdiction (e.g., “British Columbia (CA)”)originalCodeField: Original jurisdiction code from sourceoriginalDescriptionField: Original jurisdiction description
Example: British Columbia corporation
This example shows improved search data structure for a British Columbia corporation.Before
After
Example: Ontario corporation with improved search data
This example shows an Ontario corporation with improved data structureBefore
After
Example: Quebec corporation
This example is a Quebec extra-provincial corporation, with the legal entity incorporated in Ontario.Before
After
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 companyfoundationDateField: Foundation or registration datenormalizedLegalStatusField: Standardized legal status (e.g., “Active”, “Inactive”)previousNamesField[]: Array of historical namesregistrationNumberField: Standardized registration numberregistrationTypeField: Registration type (e.g., “Extra Provincial”)registrationTypeDetailsField: Home jurisdiction for extra-provincial registrationsnormalizedCodeField: Standardized code (e.g., “CA-BC”)normalizedDescriptionField: Human-readable jurisdictionoriginalCodeField: Source jurisdiction codeoriginalDescriptionField: Source jurisdiction description
addressesField[]: Improved structure with separate city, region, and address line fieldsaddressLine1Field: Primary address linecityTownField: City nameregionStateField: Province/territory
codeField: More consistent registration number formattinglegalFormField: More detailed and accurate legal form descriptionslegalStatusField: Jurisdiction-specific status valuesregistrationAuthorityField: Full corporate registry name
API call examples
Given this search response:registrationAuthorityCodeFieldas the ISO code, OR- CA-ALL with
registrationAuthorityCodeFieldas theRegAuthparameter
Example: Quebec corporation with previous names and aliases
This example demonstrates the previous names and aliases tracking for a Quebec extra-provincial corporation.Before
After
Example: Federal corporation with alias
This example shows a federal corporation registered under the Canada Business Corporations Act with a French alias.Before
After
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:- Filing Search: Search for available documents for a company
- Order Document: Place an order for the Company Profile document
- Download Document: Retrieve the PDF once ready (usually within 15 minutes)
Example: Filing search response
Migration guide
Required updates
-
Update API call construction: After CA-ALL searches, use either the specific jurisdiction code or CA-ALL with the
RegAuthparameter (both methods work identically) -
Update field mappings: Adjust your code to handle new field names and structures
- Use
registrationAuthorityCodeFieldfor jurisdiction codes (CA-AB, CA-BC, etc.) - Access city and province data from new structured address fields
- Use
foundationDateFieldfor company founding/registration dates - Use
registrationNumberFieldfor standardized registration numbers
- Use
-
Handle extra-provincial registrations:
- Check
registrationTypeFieldto identify extra-provincial registrations - Use
registrationTypeDetailsFieldto determine the home jurisdiction - Example: A BC company registered in NS will show registrationType=“Extra Provincial” with normalizedCode=“CA-BC”
- Check
-
Process previous names and aliases:
- Use
previousNamesField[]array to access historical company names - Use
aliasesField[]for alternative names - Check
isPreviousNameFieldto determine if the current result represents a previous name - name search only
- Use
-
Update legal status handling:
- Use
normalizedLegalStatusField(lite profile) for consistent Active/Inactive values - Original jurisdiction-specific status values remain in
legalStatusField
- Use
-
Enhanced address parsing:
- Leverage new
addressLine1Field,cityTownField, andregionStateFieldfor better address handling - Addresses now include proper province/territory names instead of generic descriptors
- Leverage new
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
- 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
- Extra-provincial scenarios: Test companies with extra-provincial registrations to ensure proper home jurisdiction identification
- Previous names: Validate proper handling of companies with name changes
- Date formatting: Ensure foundation and incorporation dates are parsed correctly (YYYY-MM-DD format)
- Address parsing: Test address structure handling, especially for entries with city and province data