From 2a2d7201aa438a32ed725f48ef642605e06855f2 Mon Sep 17 00:00:00 2001 From: Argus Chiu Date: Tue, 20 Aug 2024 11:54:58 -0700 Subject: [PATCH] Api spec updates (#2933) * 22301-update change agm location (#2846) * add AGM_location_change schema * update filing_head schema * update Filing schema * update business schema * add example - agm location change to the filing path * add 3 failed response examples - missing location, reason, year * 22295-update-consent-to-continue-out-spec (#2847) * Update consent continuation out filing doc * 22297-update voluntary dissolution spec (#2852) * Update related schemas for voluntary dissolution * update examples names in agm location change to follow naming convensions, update submiter and payment info to mocks * add request and response examples for voluntary dissolution * update example info for get the certificate of good standing * remove all taxId fields in x-examples under Party and Officer/Person * 22114 - add change of address api specs (#2855) * 22114 - add change of address api specs * 22114 - update request and response * 22114 - revert changes for actions * 22114 - update names and objects * 22114 - update as per naming convention and responses * 22114 - update response name * 22294 update agm extension spec (#2857) * Update Agm extension schema and spec. * 22300-update annual report spec (#2860) * Updated relevant schemas -- Annual_report, office * Added request and response examples for annual report filing * 22211 - add amalgamation spec (#2863) * 22211 - add amalgamation spec * 22211 - update response name * 22211 - updates * 22211 - updates * 22211 - updates * 22211 - updates * 22211 - updates * 22211 - updates * 22211 - updates * 22293 update change of directors spec (#2864) * Update change of directors spec * 22298-update alterations specs (#2866) * update relevant schemas (name_request, name_translation, court_order) * add request and response examples for alterations * add CI workflow for legal api specs (#2874) Add OAS CI workflow to api-spec-updates branch for docs/business.yaml file so any updates to api spec are linted. * update folder structure and oas-ci workflow (#2877) - moved business.yaml under docs/oas/ - updated the file path in oas-ci - Will have a test PR after this PR merged. Try to see if this change can make the lint check work properly. * add permissions section (#2880) add permissions section * incorporation application changes for api spec (#2871) * incorporation application changes for api spec * removed id from request body * replaced date and nrnum * replaced account id with mock val * fixed indent * added 401 unauthorized response * changed date string types and values * update workflow file and folder structure for business.yaml according to the latest oas-ci changes (#2888) * updated the oas ci file based on suggestions from Patrick Wei * moved the business.yaml to ./docs, since the oas ci in SRE repo has now changed * 22212 - add continuation in spec (#2891) * Update API Specs authentication requirements info (#2896) * Update wording for POST /businesses/{identifier}/filings (#2906) Adjust wording for POST /businesses/{identifier}/filings endpoint * Update wording for GET /businesses/{identifier}/filings (#2908) Update wording for GET /businesses/{identifier}/filings endpoint * 22707 - Update wording for GET /businesses/{identifier}/documents/{documentName} (#2910) Update wording for GET /businesses/{identifier}/documents/{documentName} endpoint * 22717-adjust wordings based on the feedback doc and discussion (#2912) * adjust wordings based on the feedback doc and discussion for business overview section and related items * 22700 - Sorted filing request and response examples alphabetically (#2917) Sorted filing request and response examples alphabetically for POST /businesses/{identifier}/filings * Update spec wordings (#2914) * update spec wording * fix duplicate issue * 22698 - fix linting issues related to 7 filings (#2919) * removed the duplications in the enums * adjusted the required item in the Filing schema to filing which is the one in Business Schemas * adjusted filing_header schema to fit the updated filing schema * adjusted examples didn't meet requirements in schemas * Sort examples alphabetically (#2920) * update spec wording * fix duplicate issue * arrange in alphabetical order * fix lint issue * Fix linting issues (#2921) * update spec wording * fix duplicate issue * arrange in alphabetical order * fix lint issue * fix linting issue 1 * fix linting issue 1 * fix linting issue 2 * fix linting issue 3 * fix linting issue 4 --------- Co-authored-by: EasonPan Co-authored-by: Aimee Co-authored-by: ketaki-deodhar <116035339+ketaki-deodhar@users.noreply.github.com> Co-authored-by: PaulG <144158015+PaulGarewal@users.noreply.github.com> --- .github/workflows/legal-oas-ci.yml | 8 +- docs/business.yaml | 3695 ++++++++++++++++++++++++---- 2 files changed, 3280 insertions(+), 423 deletions(-) diff --git a/.github/workflows/legal-oas-ci.yml b/.github/workflows/legal-oas-ci.yml index 3167d51e12..c309a0468e 100644 --- a/.github/workflows/legal-oas-ci.yml +++ b/.github/workflows/legal-oas-ci.yml @@ -11,14 +11,10 @@ defaults: run: shell: bash working-directory: . - -permissions: - contents: write - actions: read - checks: write - + jobs: business-oas-ci: uses: bcgov/bcregistry-sre/.github/workflows/oas-ci.yaml@main with: working_directory: "." + oas_file_directory: "./docs" diff --git a/docs/business.yaml b/docs/business.yaml index b6c568b44a..824ca99c6f 100644 --- a/docs/business.yaml +++ b/docs/business.yaml @@ -3,8 +3,33 @@ info: title: businesses version: '2.0' description: |- - Businesses provideas all of the services needed to manage legal entities. - This encompasses all types of businesses authorized to do business by the Registrar. + The Business Registry is a centralized electronic register of all business in British Columbia. This encompasses all types of businesses authorized to do business by the Registrar. The Business API provides a secure means of integrating your business systems with the Registry. +
+
This API supports the following filings: + - Incorporation Application + - Amalgamation Regular + - Amalgamation Short Form Horizontal + - Amalgamation Short Form Vertical + - Continuation In + - Registration + - AGM Extension Information + - AGM Location Change Information + - Alteration + - Annual Report + - Change of Address + - Change of Directors + - Change of Entity Name + - Change of Registration + - Consent Continuation Out + - Conversion (to change the business type of an organization eg: convert from a Member Funded Society to a BC Company) + - Court Order Information + - Correction + - Dissolution + - Registration (Sole Proprietorship, General Partnership) + - Special Resolution + - Transition + + All API requests must include a BC Registries issued API key and an Account ID. contact: name: BC Registry email: admin@daxiom.com @@ -53,7 +78,7 @@ paths: '404': description: Not Found operationId: get-business - description: 'Based on the users role, this returns basic information about a business.' + description: '

Retrieve a set of information about a business.

Access to a business and its information is dependent on the user being linked to that business, the API will return a 401 response if the user does not have access to that business.

The API will also return a 404 response if the business cannot be found.

' parameters: - $ref: '#/components/parameters/accountId' tags: @@ -80,7 +105,7 @@ paths: schema: $ref: '#/components/schemas/Ledger' operationId: get-businesses-identifier-filings - description: Return the current ledger of filings for a business. + description: Retrieve the list of filings recorded on a business entities ledger. tags: - business parameters: @@ -89,8 +114,8 @@ paths: summary: submit new filing operationId: post-businesses-identifier-filings responses: - '200': - description: OK + '201': + description: CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' @@ -105,7 +130,845 @@ paths: schema: type: object properties: {} - description: Submit a filing to alter the state and data of a business. + examples: + agm-extension-success-response: + summary: AGM Extension Response + value: + errors: [ + null + ] + filing: + agmExtension: + agmDueDate: '2026-06-20' + agmYear: '2024' + alreadyExtended: false + currentDate: '2024-07-10' + expireDateApprovedExt: '2026-06-20' + extReqForAgmYear: false + extensionDuration: 6 + incorporationDate: '2024-06-20T17:31:58.000Z' + isEligible: true + isFirstAgm: true + isGoodStanding: true + isPrevExtension: false + prevAgmDate: null + prevExpiryDate: null + requestExpired: false + totalApprovedExt: 6 + year: '2024' + business: + foundingDate: '2024-06-20T17:31:58.000+00:00' + identifier: BC0882365 + legalName: 882365 B.C. LTD. + legalType: BC + header: + affectedFilings: [] + availableOnPaperOnly: false + certifiedBy: Sample Certified Person + colinIds: [] + comments: [] + date: '2024-07-10T17:56:10.782107+00:00' + deletionLocked: false + effectiveDate: '2024-07-10T17:56:10.782138+00:00' + filingId: 149981 + inColinOnly: false + isCorrected: false + isCorrectionPending: false + name: agmExtension + status: DRAFT + submitter: mocked submitter + agm-location-change-success-response: + summary: AGM Location Change Response + value: + errors: [ + null + ] + filing: + agmLocationChange: + agmLocation: Victoria, BC, Canada + reason: API Specs Tests + year: '2024' + business: + foundingDate: '2023-07-12T17:31:58.000+00:00' + identifier: BC0882365 + legalName: 882365 B.C. LTD. + legalType: BC + header: + affectedFilings: [] + availableOnPaperOnly: false + certifiedBy: Sample Certified Person + colinIds: [] + comments: [] + date: '2024-07-18T15:36:26.345331+00:00' + filingId: 150147 + inColinOnly: false + isCorrected: false + isCorrectionPending: false + name: agmLocationChange + status: DRAFT + submitter: mocked submitter + alteration-success-response: + summary: Alteration Response + value: + filing: + alteration: + business: + identifier: BC0883028 + legalType: BEN + contactPoint: + email: APISpecs@gov.bc.ca + phone: (111) 111-1111 + courtOrder: + effectOfOrder: planOfArrangement + fileNumber: '12345' + hasPlanOfArrangement: true + nameRequest: + expirationDate: '2024-09-10T06:59:00+00:00' + legalName: API SPEC'S NR CHANGE TEST (BEN) CORP. + legalType: BEN + nrNumber: NR 9684750 + submittedDate: '2024-07-15T21:57:31+00:00' + submitter_userid: '' + userId: user@example + nameTranslations: + - name: API Specs Trans + provisionsRemoved: false + shareStructure: + resolutionDates: [ + '2024-07-12' + ] + shareClasses: + - currency: CAD + hasMaximumShares: true + hasParValue: true + hasRightsOrRestrictions: true + maxNumberOfShares: 600 + name: Class1 Shares + parValue: 10 + priority: 1 + series: [] + type: Class + business: + foundingDate: '2024-07-12T20:19:33.556441+00:00' + identifier: BC0883028 + legalName: 0883028 B.C. LTD. + legalType: BC + header: + affectedFilings: [] + availableOnPaperOnly: false + certifiedBy: API Specs + colinIds: [] + comments: [] + date: '2024-07-16T19:55:40.497561+00:00' + deletionLocked: false + effectiveDate: '2024-07-16T19:55:40.497583+00:00' + filingId: 150107 + inColinOnly: false + isCorrected: false + isCorrectionPending: false + isPaymentActionRequired: true + name: alteration + paymentAccount: 1234 + paymentStatusCode: CREATED + paymentToken: 12345 + status: PENDING + submitter: mocked submitter + annual-report-success-response: + summary: Annual Report Response + value: + filing: + annualReport: + annualReportDate: '2024-07-24' + directors: + - actions: [] + appointmentDate: '2024-07-23' + cessationDate: null + deliveryAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + deliveryInstructions: '' + postalCode: V8W 1W4 + streetAddress: 1-940 Blanshard + streetAddressAdditional: '' + id: 1 + isDirectorActionable: true + isFeeApplied: false + mailingAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + deliveryInstructions: '' + postalCode: V8W 1W4 + streetAddress: 1-940 Blanshard + streetAddressAdditional: '' + officer: + email: api.specs@api.specs + firstName: firstName + id: 584282 + lastName: lastName + partyType: person + middleInitial: '' + prevFirstName: firstName + prevLastName: lastName + prevMiddleInitial: '' + role: director + nextARDate: '2024-07-24' + offices: + recordsOffice: + deliveryAddress: + actions: [] + addressCity: Victoria + addressCountry: CA + addressRegion: BC + addressType: delivery + deliveryInstructions: '' + id: 2908346 + postalCode: V8W 3E6 + streetAddress: 200-940 Blanshard St + streetAddressAdditional: '' + mailingAddress: + actions: [] + addressCity: Victoria + addressCountry: CA + addressRegion: BC + addressType: mailing + deliveryInstructions: '' + id: 2908345 + postalCode: V8W 3E6 + streetAddress: 200-940 Blanshard St + streetAddressAdditional: '' + registeredOffice: + deliveryAddress: + actions: [] + addressCity: Victoria + addressCountry: CA + addressRegion: BC + addressType: delivery + deliveryInstructions: '' + id: 2908348 + postalCode: V8W 3E6 + streetAddress: 200-940 Blanshard St + streetAddressAdditional: '' + mailingAddress: + actions: [] + addressCity: Victoria + addressCountry: CA + addressRegion: BC + addressType: mailing + deliveryInstructions: '' + id: 2908347 + postalCode: V8W 3E6 + streetAddress: 200-940 Blanshard St + streetAddressAdditional: '' + business: + foundingDate: '2023-07-21T23:13:48.000+00:00' + identifier: BC0883312 + legalName: 0883312 B.C. LTD. + legalType: BEN + header: + ARFilingYear: 2024 + affectedFilings: [] + availableOnPaperOnly: false + certifiedBy: Sample Certified Person + colinIds: [] + comments: [] + date: '2024-07-24T16:22:13.256843+00:00' + deletionLocked: false + effectiveDate: '2024-07-24T07:00:00+00:00' + email: api.specs@api.specs + filingId: 150312 + inColinOnly: false + isCorrected: false + isCorrectionPending: false + isPaymentActionRequired: true + name: annualReport + paymentAccount: 1234 + paymentStatusCode: CREATED + paymentToken: 12345 + status: PENDING + submitter: mocked submitter + waiveFees: false + change-of-address-success-response: + summary: Change Of Address Response + value: + filing: + business: + legalType: BC + foundingDate: '2024-06-09T00:00:00+00:00' + identifier: BC0880343 + legalName: KD TEST BAKING BC LIMITED + changeOfAddress: + legalType: BC + offices: + recordsOffice: + deliveryAddress: + actions: [ + addressChanged + ] + addressCity: RICHMOND + addressCountry: CA + addressRegion: BC + addressType: delivery + deliveryInstructions: + postalCode: V8N 4R7 + streetAddress: TEST D 2 + streetAddressAdditional: + mailingAddress: + actions: [ + addressChanged + ] + addressCity: RICHMOND + addressCountry: CA + addressRegion: BC + addressType: mailing + deliveryInstructions: + postalCode: V8N 4R7 + streetAddress: TEST M 2 + streetAddressAdditional: + registeredOffice: + deliveryAddress: + actions: [ + addressChanged + ] + addressCity: RICHMOND + addressCountry: CA + addressRegion: BC + addressType: delivery + deliveryInstructions: + postalCode: V8N 4R7 + streetAddress: TEST D 1 + streetAddressAdditional: + mailingAddress: + actions: [ + addressChanged + ] + addressCity: RICHMOND + addressCountry: CA + addressRegion: BC + addressType: mailing + deliveryInstructions: + postalCode: V8N 4R7 + streetAddress: TEST M 1 + streetAddressAdditional: + header: + affectedFilings: [] + availableOnPaperOnly: false + certifiedBy: "full name" + colinIds: [] + comments: [] + date: '2024-07-17T23:14:58.831553+00:00' + deletionLocked: false + effectiveDate: '2024-07-18T07:00:00+00:00' + email: no_one@never.get + filingId: 150166 + futureEffectiveDate: '2024-07-18T07:00:00+00:00' + inColinOnly: false + isCorrected: false + isCorrectionPending: false + isPaymentActionRequired: true + name: changeOfAddress + paymentStatusCode: CREATED + paymentToken: 12345 + status: 'PENDING' + submitter: 'mocked submitter' + change-of-directors-success-response: + summary: Change Of Directors Response + value: + filing: + business: + foundingDate: '2024-07-08T07:00:00.000+00:00' + identifier: BC0871442 + legalName: JIA TEST BC TO ULC + legalType: ULC + changeOfDirectors: + directors: + - actions: + - appointed + appointmentDate: '2024-07-09' + cessationDate: null + deliveryAddress: + addressCity: Richmond + addressCountry: CA + addressRegion: BC + deliveryInstructions: '' + postalCode: V7E 1V2 + streetAddress: 10300 4th Ave + streetAddressAdditional: '' + mailingAddress: + addressCity: Richmond + addressCountry: CA + addressRegion: BC + deliveryInstructions: '' + postalCode: V7E 1V2 + streetAddress: 10300 4th Ave + streetAddressAdditional: '' + officer: + firstName: Doe + lastName: Smith + middleInitial: '' + prevFirstName: '' + prevLastName: '' + prevMiddleInitial: '' + - actions: + - appointed + appointmentDate: '2024-07-09' + cessationDate: null + deliveryAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + deliveryInstructions: '' + postalCode: V8W 1W4 + streetAddress: 1-940 Blanshard + streetAddressAdditional: '' + mailingAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + deliveryInstructions: '' + postalCode: V8W 1W4 + streetAddress: 1-940 Blanshard + streetAddressAdditional: '' + officer: + firstName: Bob + lastName: Smith + middleInitial: '' + prevFirstName: '' + prevLastName: '' + prevMiddleInitial: '' + - actions: + - appointed + appointmentDate: '2024-07-09' + cessationDate: null + deliveryAddress: + addressCity: Richmond + addressCountry: CA + addressRegion: BC + deliveryInstructions: '' + postalCode: V7E 1V2 + streetAddress: 10300 4th Ave + streetAddressAdditional: '' + mailingAddress: + addressCity: Richmond + addressCountry: CA + addressRegion: BC + deliveryInstructions: '' + postalCode: V7E 1V2 + streetAddress: 10300 4th Ave + streetAddressAdditional: '' + officer: + firstName: Jane + lastName: Smith + middleInitial: '' + prevFirstName: '' + prevLastName: '' + prevMiddleInitial: '' + - actions: + - ceased + appointmentDate: '2024-07-09' + cessationDate: '2024-07-21' + deliveryAddress: + addressCity: Richmond + addressCountry: CA + addressRegion: BC + postalCode: V7E 1V2 + streetAddress: 10300 4th Ave + streetAddressAdditional: '' + mailingAddress: + addressCity: Richmond + addressCountry: CA + addressRegion: BC + postalCode: V7E 1V2 + streetAddress: 10300 4th Ave + streetAddressAdditional: '' + officer: + firstName: Doe + lastName: Smith + middleInitial: '' + prevFirstName: '' + prevLastName: '' + prevMiddleInitial: '' + - actions: + - addressChanged + appointmentDate: '2024-07-09' + cessationDate: null + deliveryAddress: + addressCity: Burnaby + addressCountry: CA + addressRegion: BC + postalCode: V5C 3V8 + streetAddress: 3765 1st Ave + streetAddressAdditional: '' + mailingAddress: + addressCity: Burnaby + addressCountry: CA + addressRegion: BC + postalCode: V5C 3V8 + streetAddress: 3765 1st Ave + streetAddressAdditional: '' + officer: + firstName: Jane + lastName: Smith + middleInitial: '' + prevFirstName: '' + prevLastName: '' + prevMiddleInitial: '' + - actions: + - nameChanged + appointmentDate: '2024-07-09' + cessationDate: null + deliveryAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + deliveryInstructions: '' + postalCode: V8W 1W4 + streetAddress: 1-940 Blanshard + streetAddressAdditional: '' + mailingAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + deliveryInstructions: '' + postalCode: V8W 1W4 + streetAddress: 1-940 Blanshard + streetAddressAdditional: '' + officer: + firstName: API + lastName: Specs + middleInitial: '' + prevFirstName: Bob + prevLastName: Smith + prevMiddleInitial: '' + header: + affectedFilings: [] + availableOnPaperOnly: false + certifiedBy: Sample Certified Person + colinIds: [] + comments: [] + date: '2024-07-09T21:39:11.950027+00:00' + deletionLocked: false + effectiveDate: '2024-07-09T07:00:00+00:00' + email: "no_one@never.get" + filingId: 150373 + inColinOnly: false + isCorrected: false + isCorrectionPending: false + isPaymentActionRequired: true + name: changeOfDirectors + paymentAccount: 1234 + paymentStatusCode: CREATED + paymentToken: 12345 + status: PENDING + submitter: mocked submitter + consent-continuation-out-success-response: + summary: Consent Continuation Out Response + value: + filing: + business: + legalName: 0882848 B.C. LTD. + legalType: BEN + identifier: BC0882848 + foundingDate: '2024-07-08T15:34:57.844764+00:00' + consentContinuationOut: + foreignJurisdiction: + country: CA + region: SK + courtOrder: + fileNumber: '12345' + effectOfOrder: planOfArrangement + header: + affectedFilings: [] + availableOnPaperOnly: false + certifiedBy: "string" + colinIds: [] + comments: [] + date: '2024-07-18' + deletionLocked: false + documentOptionalEmail: "user@example.com" + effectiveDate: '2024-07-18T07:00:42.552434+00:00' + email: "user@example.com" + filingId: 150056 + inColinOnly: false + isCorrected: false + isCorrectionPending: false + isPaymentActionRequired: true + name: consentContinuationOut + paymentAccount: '1234' + paymentStatusCode: 'CREATED' + paymentToken: '12345' + status: 'PENDING' + submitter: 'mocked submitter' + voluntary-dissolution-success-response: + summary: Voluntary Dissolution Response + value: + filing: + business: + foundingDate: '2023-07-12T17:31:58.000+00:00' + identifier: BC0882365 + legalName: 882365 B.C. LTD. + legalType: BC + dissolution: + affidavitConfirmed: true + courtOrder: + effectOfOrder: '' + fileNumber: '12345' + hasPlanOfArrangement: false + custodialOffice: + deliveryAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + deliveryInstructions: '' + postalCode: V8W 3E6 + streetAddress: 200-940 Blanshard St + streetAddressAdditional: '' + mailingAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + deliveryInstructions: '' + postalCode: V8W 3E6 + streetAddress: 200-940 Blanshard St + streetAddressAdditional: '' + dissolutionDate: '2024-07-18' + dissolutionType: voluntary + parties: + - party: + deliveryAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + deliveryInstructions: '' + postalCode: V8W 3E6 + streetAddress: 200-940 Blanshard St + inheritMailingAddress: true + mailingAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + deliveryInstructions: '' + postalCode: V8W 3E6 + streetAddress: 200-940 Blanshard St + officer: + email: api.specs@example.com + firstName: Firstname + lastName: Lastname + middleName: '' + organizationName: '' + partyType: person + roles: + - appointmentDate: '2024-07-18' + roleType: Custodian + resolution: + resolutionConfirmed: true + header: + affectedFilings: [] + availableOnPaperOnly: false + certifiedBy: Sample Certified Person + colinIds: [] + comments: [] + date: '2024-07-18T15:36:26.345331+00:00' + deletionLocked: false + effectiveDate: '2027-07-21T07:00:00.000+00:00' + filingId: 149994 + inColinOnly: false + isCorrected: false + isCorrectionPending: false + isPaymentActionRequired: true + name: dissolution + paymentAccount: 1234 + paymentStatusCode: CREATED + paymentToken: 12345 + priority: false + status: PENDING + submitter: mocked submitter + '400': + description: The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax, size too large, invalid request message framing, or deceptive request routing). + content: + application/json: + examples: + agm-extension-failed-invalid-total-approved-extension-response: + summary: AGM Extension - Invalid Total Approved Extension Response + value: + errorMessage: API backend third party service error. + rootCause: errors:[error:Fail to grant extension.],filing:agmExtension:agmDueDate:2026-06-20,agmYear:2024,alreadyExtended:false,currentDate:2024-07-10,expireDateApprovedExt:2026-06-20,extReqForAgmYear:false,extensionDuration:6,incorporationDate:2024-06-20T17:31:58.000Z,isEligible:true,isFirstAgm:true,isGoodStanding:true,isPrevExtension:false,prevAgmDate:null,prevExpiryDate:null,requestExpired:false,totalApprovedExt:7,year:2024,business:foundingDate:2024-06-20T17:31:58.000+00:00,identifier:BC0882365,legalName:0882365 B.C. LTD.,legalType:BC,header:certifiedBy:APISpecs,date:2024-07-10,name:agmExtension + alteration-failed-invalid-legal-type-change-response: + summary: Alteration - Invalid Legal Type Change Response + value: + errorMessage: API backend third party service error. + rootCause: errors:[error:Your business type has not been updated to a BC Benefit Company, BC Unlimited Liability Company, BC Community Contribution Company, BC Limited Company or BC Cooperative Association.,path:/filing/alteration/business/legalType] + alteration-failed-missing-business-legal-name-response: + summary: Alteration - Missing Business Legal Name Response + value: + errorMessage: API backend third party service error. + rootCause: errors:[error:Alteration to Numbered Company can only be done for a Named Company.,path:/filing/business/legalName] + alteration-failed-missing-business-response: + summary: Alteration - Missing Business Response + value: + errorMessage: API backend third party service error. + rootCause: errors:[message:A valid business is required.] + alteration-failed-missing-max-number-of-share-response: + summary: Alteration - Missing Max Number of Shares Response + value: + errorMessage: API backend third party service error. + rootCause: errors:[error:Share class Common Shares must provide value for maximum number of shares,path:/filing/alteration/shareClasses/0/maxNumberOfShares/] + alteration-failed-name-request-does-not-have-the-same-legal-name-response: + summary: Alteration - Name Request Does Not Have the Same Legal Name Response + value: + errorMessage: API backend third party service error. + rootCause: errors:[error:Alteration of Name Request has a different legal name.,path:/filing/alteration/nameRequest/legalName] + alteration-failed-name-request-does-not-have-the-same-legal-type-response: + summary: Alteration - Name Request Does Not Have the Same Legal Type Response + value: + errorMessage: API backend third party service error. + rootCause: errors:[error:Name Request legal type is not same as the business legal type.,path:/filing/alteration/nameRequest/legalType] + alteration-failed-name-request-is-not-approved-response: + summary: Alteration - Name Request Is Not Approved Response + value: + errorMessage: API backend third party service error. + rootCause: errors:[error:Alteration of Name Request is not approved.,path:/filing/alteration/nameRequest/nrNumber,error:Alteration of Name Request has a different legal name.,path:/filing/alteration/nameRequest/legalName] + change-of-directors-failed-invalid-address-country: + summary: Change Of Directors - Invalid Address Country + value: + errorMessage: API backend third party service error. + rootCause: errors:[error:Address Country must resolve to a valid ISO-2 country.] + change-of-directors-failed-invalid-effective-date-prior-to-most-recent-filing-response: + summary: Change Of Directors - Invalid Effective Date (Earlier Than Previous Change of Director Filing) + value: + errorMessage: API backend third party service error. + rootCause: errors:[error:Effective date cannot be before another Change of Director filing.] + change-of-directors-failed-invalid-future-effective-date: + summary: Change Of Directors - Invalid Future Effective Date + value: + errorMessage: API backend third party service error. + rootCause: errors:[error:Filing cannot have a future effective date.] + change-of-directors-failed-missing-business-response: + summary: Change Of Directors - Missing Business Response + value: + errorMessage: API backend third party service error. + rootCause: errors:[message:A valid business is required.] + consent-continuation-out-failed-bc-as-foreign-jurisdiction-region-response: + summary: Consent Continuation Out - BC Specified as Foreign Jurisdiction Region Response + value: + errorMessage: API backend third party service error. + rootCause: errors:[error:Region should not be BC.,path:/filing/consentContinuationOut/foreignJurisdiction/region],filing:business:foundingDate:2024-07-08T15:34:57.844764+00:00,identifier:BC0882848,legalName:0882848 B.C. LTD.,legalType:BEN,consentContinuationOut:courtOrder:effectOfOrder:planOfArrangement,fileNumber:12345,foreignJurisdiction:country:CA,region:BC,header:availableOnPaperOnly:false,certifiedBy:Api specs,date:2024-07-10,documentOptionalEmail:Apispecs@email.com,email:Apispecs@gov.bc.ca,inColinOnly:false,name:consentContinuationOut + consent-continuation-out-failed-invalid-foreign-jurisdiction-country-response: + summary: Consent Continuation Out - Invalid Foreign Jurisdiction Country Response + value: + errorMessage: API backend third party service error. + rootCause: errors:[error:Invalid country.,path:/filing/consentContinuationOut/foreignJurisdiction/country],filing:business:foundingDate:2024-07-08T15:34:57.844764+00:00,identifier:BC0882848,legalName:0882848 B.C. LTD.,legalType:BEN,consentContinuationOut:courtOrder:effectOfOrder:planOfArrangement,fileNumber:12345,foreignJurisdiction:country:,header:availableOnPaperOnly:false,certifiedBy:Api specs,date:2024-07-10,documentOptionalEmail:Apispecs@email.com,email:Apispecs@gov.bc.ca,inColinOnly:false,name:consentContinuationOut + consent-continuation-out-failed-invalid-foreign-jurisdiction-region-response: + summary: Consent Continuation Out - Invalid Foreign Jurisdiction Region Response + value: + errorMessage: API backend third party service error. + rootCause: errors:[error:Invalid region.,path:/filing/consentContinuationOut/foreignJurisdiction/region],filing:business:foundingDate:2024-07-08T15:34:57.844764+00:00,identifier:BC0882848,legalName:0882848 B.C. LTD.,legalType:BEN,state:HISTORICAL,consentContinuationOut:courtOrder:effectOfOrder:planOfArrangement,fileNumber:12345,foreignJurisdiction:country:CA,region:,header:availableOnPaperOnly:false,certifiedBy:Api specs,date:2024-07-10,documentOptionalEmail:Apispecs@email.com,email:Apispecs@gov.bc.ca,inColinOnly:false,name:consentContinuationOut + consent-continuation-out-failed-missing-required-field-response: + summary: Consent Continuation Out - Missing Required Field Response + value: + errorMessage: API backend third party service error. + rootCause: errors:[message:A valid business is required.] + consent-continuation-out-failed-invalid-jurisdiction-response: + summary: Consent Continuation Out - Same Unexpired Foreign Jurisdiction Exist Response + value: + errorMessage: API backend third party service error. + rootCause: errors:[error:Can't have new consent for same jurisdiction if an unexpired one already exists,path:/filing/consentContinuationOut/foreignJurisdiction],filing:business:foundingDate:2024-07-08T15:34:57.844764+00:00,identifier:BC0882848,legalName:0882848 B.C. LTD.,legalType:BEN,consentContinuationOut:courtOrder:effectOfOrder:planOfArrangement,fileNumber:12345,foreignJurisdiction:country:CA,region:AB,header:availableOnPaperOnly:false,certifiedBy:Api specs,date:2024-07-10,documentOptionalEmail:Apispecs@email.com,email:Apispecs@gov.bc.ca,inColinOnly:false,name:consentContinuationOut + voluntary-dissolution-failed-missing-filing-name-response: + summary: Voluntary Dissolution - Missing Filing Name Response + value: + errorMessage: API backend third party service error. + rootCause: errors:[message:filing/header/name is a required property] + '401': + description: Similar to 403 Forbidden, but specifically for use when authentication is required and has failed or has not yet been provided. The user does not have valid authentication credentials for the target resource. + content: + application/json: + examples: + consent-continuation-out-unauthorized-response: + summary: Consent Continuation Out - Unauthorized Response + value: + errorMessage: API backend third party service error. + rootCause: message:You are not authorized to submit a filing for BC1218840. + '422': + description: UNPROCESSABLE ENTITY, in many cases caused by missing one or more required field(s) + content: + application/json: + examples: + agm-extension-failed-missing-agm-year-response: + summary: AGM Extension - Missing agmYear Response + value: + errorMessage: API backend third party service error. + rootCause: "errors:" + agm-extension-failed-missing-ext-req-for-agm-year-response: + summary: AGM Extension - Missing extReqForAgmYear Response + value: + errorMessage: API backend third party service error. + rootCause: "errors:" + agm-extension-failed-missing-is-first-agm-response: + summary: AGM Extension - Missing isFirstAgm Response + value: + errorMessage: API backend third party service error. + rootCause: "errors:" + agm-location-change-failed-missing-agm-location-response: + summary: 'AGM Location Change - Missing AGM Location Response' + value: + errorMessage: API backend third party service error. + rootCause: "errors:" + agm-location-change-failed-missing-reason-response: + summary: AGM Location Change - Missing Reason Response + value: + errorMessage: API backend third party service error. + rootCause: "errors:" + agm-location-change-failed-missing-year-response: + summary: AGM Location Change - Missing Year Response + value: + errorMessage: API backend third party service error. + rootCause: "errors:" + alteration-failed-missing-court-order-file-number-response: + summary: Alteration - Missing Court Order File Number Response + value: + errorMessage: API backend third party service error. + rootCause: "errors:" + annual-report-failed-missing-annual-report-date-response: + summary: Annual Report - Missing Annual Report Date Response + value: + errorMessage: API backend third party service error. + rootCause: "errors:" + annual-report-failed-missing-missing-directors-response: + summary: Annual Report - Missing Directors Response + value: + errorMessage: API backend third party service error. + rootCause: "errors:" + annual-report-failed-missing-offices-response: + summary: Annual Report - Missing Offices Response + value: + errorMessage: API backend third party service error. + rootCause: "errors:" + change-of-address-failed-missing-records-office-response: + summary: Change Of Address - Missing Records Office Address Response + value: + errorMessage: "API backend third party service error." + consent-continuation-out-failed-invalid-court-order-response: + summary: Consent Continuation Out - Invalid Court Order Response + value: + errorMessage: API backend third party service error. + rootCause: "errors:" + voluntary-dissolution-failed-missing-dissolution-date-response: + summary: Voluntary Dissolution - Missing Dissolution Date Response + value: + errorMessage: API backend third party service error. + rootCause: "errors:" + '500': + description: INTERNAL SERVER ERROR + content: + application/json: + examples: + voluntary-dissolution-failed-missing-disslution-type-response: + summary: Voluntary Dissolution - Missing Dissolution Type Response + value: + errorMessage: API backend third party service error. + rootCause: message:Internal server error + description: This is used to submit all filing types that are used to maintain or change the state of the Registration of any business entity in the Registry to which the user has access to. tags: - business requestBody: @@ -113,17 +976,550 @@ paths: application/json: schema: $ref: '#/components/schemas/Filing' + examples: + agm-extension-request: + summary: AGM Extension Request + value: + filing: + header: + name: agmExtension + certifiedBy: Sample Certified Person + date: '2024-07-21' + business: + foundingDate: '2024-06-20T17:31:58.000+00:00' + identifier: BC0882365 + legalName: 882365 B.C. LTD. + legalType: BC + agmLocationChange: + year: '2024' + isFirstAgm: true + extReqForAgmYear: false + totalApprovedExt: 6 + expireDateApprovedExt: '2026-06-20' + currentDate: '2024-07-21' + alreadyExtended: false + requestExpired: false + isGoodStanding: true + incorporationDate: '2024-06-20T17:31:58.000Z' + agmYear: '2024' + prevAgmDate: null + isPrevExtension: false + prevExpiryDate: null + extensionDuration: 6 + agmDueDate: '2026-06-20' + isEligible: true + agm-location-change-request: + summary: AGM Location Change Request + value: + filing: + header: + date: '2024-07-18' + name: agmLocationChange + certifiedBy: Sample Certified Person + business: + foundingDate: '2023-07-12T17:31:58.000+00:00' + identifier: BC0882365 + legalName: 882365 B.C. LTD. + legalType: BC + agmLocationChange: + year: '2024' + reason: API Specs Tests + agmLocation: Victoria, BC, Canada + alteration-request: + summary: Alteration Request + value: + filing: + header: + name: alteration + certifiedBy: Sample Certified Person + date: '2024-07-25' + business: + foundingDate: '2024-07-12T20:19:33.556441+00:00' + identifier: BC0883028 + legalName: 0883028 B.C. LTD. + legalType: BC + alteration: + business: + identifier: BC0883028 + legalType: BEN + nameRequest: + legalType: BEN + expirationDate: '2024-09-10T06:59:00+00:00' + submittedDate: '2024-07-15T21:57:31+00:00' + submitter_userid: '' + userId: user@example + legalName: API SPEC'S NR CHANGE TEST (BEN) CORP. + nrNumber: NR 9684750 + nameTranslations: + - name: API Specs Trans + provisionsRemoved: false + contactPoint: + email: APISpecs@gov.bc.ca + phone: '(111) 111-1111' + shareStructure: + resolutionDates: [ + '2024-07-12' + ] + shareClasses: + - currency: CAD + hasMaximumShares: true + hasParValue: true + hasRightsOrRestrictions: true + maxNumberOfShares: 600 + name: Class1 Shares + parValue: 10 + priority: 1 + series: [] + type: Class + courtOrder: + fileNumber: '12345' + effectOfOrder: planOfArrangement + hasPlanOfArrangement: true + annual-report-request: + summary: Annual Report Request + value: + filing: + header: + name: annualReport + certifiedBy: Sample Certified Person + email: api.specs@api.specs + date: '2024-07-24' + ARFilingYear: 2024 + effectiveDate: '2024-07-24T07:00:00.000+00:00' + waiveFees: false + business: + foundingDate: '2023-07-21T23:13:48.000+00:00' + identifier: BC0883312 + legalName: 0883312 B.C. LTD. + legalType: BEN + annualReport: + annualReportDate: '2024-07-24' + nextARDate: '2024-07-24' + offices: + registeredOffice: + deliveryAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + addressType: delivery + deliveryInstructions: '' + id: 2908348 + postalCode: V8W 3E6 + streetAddress: 200-940 Blanshard St + streetAddressAdditional: '' + actions: [] + mailingAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + addressType: mailing + deliveryInstructions: '' + id: 2908347 + postalCode: V8W 3E6 + streetAddress: 200-940 Blanshard St + streetAddressAdditional: '' + actions: [] + recordsOffice: + deliveryAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + addressType: delivery + deliveryInstructions: '' + id: 2908346 + postalCode: V8W 3E6 + streetAddress: 200-940 Blanshard St + streetAddressAdditional: '' + actions: [] + mailingAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + addressType: mailing + deliveryInstructions: '' + id: 2908345 + postalCode: V8W 3E6 + streetAddress: 200-940 Blanshard St + streetAddressAdditional: '' + actions: [] + directors: + - officer: + email: api.specs@api.specs + firstName: firstName + id: 584282 + lastName: lastName + partyType: person + middleInitial: '' + prevFirstName: firstName + prevLastName: lastName + prevMiddleInitial: '' + appointmentDate: '2024-07-23' + cessationDate: null + deliveryAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + deliveryInstructions: '' + postalCode: V8W 1W4 + streetAddress: 1-940 Blanshard + streetAddressAdditional: '' + mailingAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + deliveryInstructions: '' + postalCode: V8W 1W4 + streetAddress: 1-940 Blanshard + streetAddressAdditional: '' + role: director + id: 1 + isFeeApplied: false + isDirectorActionable: true + actions: [] + change-of-address-request: + summary: Change Of Address + value: + filing: + header: + name: changeOfAddress + certifiedBy: "full name" + email: "no_one@never.get" + date: '2024-07-23' + business: + legalType: BC + foundingDate: '2024-06-09T00:00:00+00:00' + identifier: BC0880343 + legalName: KD TEST BAKING BC LIMITED + changeOfAddress: + legalType: BC + offices: + recordsOffice: + deliveryAddress: + actions: [ + addressChanged + ] + addressCity: RICHMOND + addressCountry: CA + addressRegion: BC + addressType: delivery + deliveryInstructions: + postalCode: V8N 4R7 + streetAddress: TEST D 2 + streetAddressAdditional: + mailingAddress: + actions: [ + addressChanged + ] + addressCity: RICHMOND + addressCountry: CA + addressRegion: BC + addressType: mailing + deliveryInstructions: + postalCode: V8N 4R7 + streetAddress: TEST M 2 + streetAddressAdditional: + registeredOffice: + deliveryAddress: + actions: [ + addressChanged + ] + addressCity: RICHMOND + addressCountry: CA + addressRegion: BC + addressType: delivery + deliveryInstructions: + postalCode: V8N 4R7 + streetAddress: TEST D 1 + streetAddressAdditional: + mailingAddress: + actions: [ + addressChanged + ] + addressCity: RICHMOND + addressCountry: CA + addressRegion: BC + addressType: mailing + deliveryInstructions: + postalCode: V8N 4R7 + streetAddress: TEST M 1 + streetAddressAdditional: + change-of-directors-request: + summary: Change Of Directors Request + value: + filing: + header: + name: changeOfDirectors + certifiedBy: Sample Certified Person + email: no_one@never.get + date: '2024-07-09' + effectiveDate: '2024-07-09T07:00:00+00:00' + business: + foundingDate: '2024-07-08T07:00:00.000+00:00' + identifier: BC0871442 + legalName: JIA TEST BC TO ULC + legalType: ULC + changeOfDirectors: + directors: + - officer: + firstName: Doe + lastName: Smith + middleInitial: '' + prevFirstName: '' + prevLastName: '' + prevMiddleInitial: '' + deliveryAddress: + streetAddress: 10300 4th Ave + streetAddressAdditional: '' + addressCity: Richmond + addressRegion: BC + deliveryInstructions: '' + postalCode: V7E 1V2 + addressCountry: CA + mailingAddress: + streetAddress: 10300 4th Ave + streetAddressAdditional: '' + addressCity: Richmond + addressRegion: BC + deliveryInstructions: '' + postalCode: V7E 1V2 + addressCountry: CA + appointmentDate: '2024-07-09' + cessationDate: null + actions: + - appointed + - officer: + firstName: Bob + lastName: Smith + middleInitial: '' + prevFirstName: '' + prevLastName: '' + prevMiddleInitial: '' + deliveryAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + deliveryInstructions: '' + postalCode: V8W 1W4 + streetAddress: 1-940 Blanshard + streetAddressAdditional: '' + mailingAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + deliveryInstructions: '' + postalCode: V8W 1W4 + streetAddress: 1-940 Blanshard + streetAddressAdditional: '' + appointmentDate: '2024-07-09' + cessationDate: null + actions: + - appointed + - officer: + firstName: Jane + lastName: Smith + middleInitial: '' + prevFirstName: '' + prevLastName: '' + prevMiddleInitial: '' + deliveryAddress: + streetAddress: 10300 4th Ave + streetAddressAdditional: '' + addressCity: Richmond + addressRegion: BC + deliveryInstructions: '' + postalCode: V7E 1V2 + addressCountry: CA + mailingAddress: + streetAddress: 10300 4th Ave + streetAddressAdditional: '' + addressCity: Richmond + addressRegion: BC + deliveryInstructions: '' + postalCode: V7E 1V2 + addressCountry: CA + appointmentDate: '2024-07-09' + cessationDate: null + actions: + - appointed + - officer: + firstName: Doe + lastName: Smith + middleInitial: '' + prevFirstName: '' + prevLastName: '' + prevMiddleInitial: '' + deliveryAddress: + streetAddress: 10300 4th Ave + streetAddressAdditional: '' + addressCity: Richmond + addressRegion: BC + postalCode: V7E 1V2 + addressCountry: CA + mailingAddress: + streetAddress: 10300 4th Ave + streetAddressAdditional: '' + addressCity: Richmond + addressRegion: BC + postalCode: V7E 1V2 + addressCountry: CA + appointmentDate: '2024-07-09' + cessationDate: '2024-07-21' + actions: + - ceased + - officer: + firstName: Jane + lastName: Smith + middleInitial: '' + prevFirstName: '' + prevLastName: '' + prevMiddleInitial: '' + deliveryAddress: + streetAddress: 3765 1st Ave + streetAddressAdditional: '' + addressCity: Burnaby + addressRegion: BC + postalCode: V5C 3V8 + addressCountry: CA + mailingAddress: + streetAddress: 3765 1st Ave + streetAddressAdditional: '' + addressCity: Burnaby + addressRegion: BC + postalCode: V5C 3V8 + addressCountry: CA + appointmentDate: '2024-07-09' + cessationDate: null + actions: + - addressChanged + - officer: + firstName: API + lastName: Specs + middleInitial: '' + prevFirstName: Bob + prevLastName: Smith + prevMiddleInitial: '' + deliveryAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + deliveryInstructions: '' + postalCode: V8W 1W4 + streetAddress: 1-940 Blanshard + streetAddressAdditional: '' + mailingAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + deliveryInstructions: '' + postalCode: V8W 1W4 + streetAddress: 1-940 Blanshard + streetAddressAdditional: '' + appointmentDate: '2024-07-09' + cessationDate: null + actions: + - nameChanged + consent-continuation-out-request: + summary: Consent Continuation Out Request + value: + filing: + header: + name: consentContinuationOut + date: '2024-07-18' + certifiedBy: "string" + email: "user@example.com" + documentOptionalEmail: "user@example.com" + business: + legalName: 0882848 B.C. LTD. + legalType: BEN + identifier: BC0882848 + foundingDate: '2024-07-08T15:34:57.844764+00:00' + consentContinuationOut: + foreignJurisdiction: + country: CA + region: SK + courtOrder: + fileNumber: '12345' + effectOfOrder: planOfArrangement + voluntary-dissolution-request: + summary: Voluntary Dissolution Request + value: + filing: + header: + date: '2024-07-18' + effectiveDate: '2027-07-21T07:00:00.000+00:00' + name: dissolution + certifiedBy: Sample Certified Person + priority: false + business: + foundingDate: '2023-07-12T17:31:58.000+00:00' + identifier: BC0882365 + legalName: 882365 B.C. LTD. + legalType: BC + dissolution: + dissolutionDate: '2024-07-18' + affidavitConfirmed: true + custodialOffice: + deliveryAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + deliveryInstructions: '' + postalCode: V8W 3E6 + streetAddress: 200-940 Blanshard St + streetAddressAdditional: '' + mailingAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + deliveryInstructions: '' + postalCode: V8W 3E6 + streetAddress: 200-940 Blanshard St + streetAddressAdditional: '' + dissolutionType: voluntary + parties: + - party: + deliveryAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + deliveryInstructions: '' + postalCode: V8W 3E6 + streetAddress: 200-940 Blanshard St + inheritMailingAddress: true + mailingAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + deliveryInstructions: '' + postalCode: V8W 3E6 + streetAddress: 200-940 Blanshard St + officer: + email: api.specs@example.com + firstName: Firstname + lastName: Lastname + middleName: '' + organizationName: '' + partyType: person + roles: + - appointmentDate: '2024-07-18' + roleType: Custodian + resolution: + resolutionConfirmed: true + courtOrder: + fileNumber: '12345' + effectOfOrder: '' + hasPlanOfArrangement: false parameters: - schema: type: boolean in: query name: draft - description: 'save draft, no validation' + description: This parameter is used to save a filing in Draft form which can be retrieved at a later time. - schema: type: boolean in: query name: only_validate - description: 'only validate, don''t save' + description: This parameter is used to submit a filing for validation only, no entity will be created. Use this to confirm that a filing is fully complete and correct prior to submission. - $ref: '#/components/parameters/accountId' '/businesses/{identifier}/filings/{filingId}/documents': parameters: @@ -179,7 +1575,7 @@ paths: '404': description: Not Found operationId: get-businesses-identifier-addresses - description: Returns the current addresses for the businesses. The number of addresses are based on the legal type. + description: Returns the current addresses for the businesses. The number of addresses will depend on the requirements of the legal type of the business entity. tags: - business parameters: @@ -237,7 +1633,7 @@ paths: description: The unique identifier for the business or organization. schema: type: string - example: BC1234567 + example: BC0882365 - schema: type: string enum: @@ -255,7 +1651,7 @@ paths: - business responses: '200': - description: Created + description: OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' @@ -1034,7 +2430,7 @@ paths: reportType: lseal stateFilings: [] operationId: get-businesses-identifier-document-documentName - description: Return the requested document. + description: Retrieves a specific document for the specified business. parameters: - schema: type: string @@ -1048,6 +2444,7 @@ paths: /businesses: post: summary: save business creation filing + operationId: post-business tags: - business responses: @@ -1062,25 +2459,1068 @@ paths: $ref: '#/components/headers/AccessControlAllowHeaders' Access-Control-Max-Age: $ref: '#/components/headers/AccessControlMaxAge' - operationId: post-businesses - description: Submitting a creation filing for a business will create that type of business if it is a fully valid filing and payment has been completed. + content: + application/json: + schema: + type: object + properties: {} + examples: + amalgamation-regular-success-response: + summary: Amalgamation Regular Response + value: + filing: + amalgamationApplication: + amalgamatingBusinesses: + - identifier: BC0883189 + role: amalgamating + - identifier: BC0883230 + role: amalgamating + contactPoint: + email: "contact@example.com" + phone: (555) 555-5555 + courtApproval: null + nameRequest: + legalType: BC + offices: + recordsOffice: + deliveryAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + deliveryInstructions: + postalCode: V8Z 5C5 + streetAddress: Test rd + streetAddressAdditional: + mailingAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + addressType: null + deliveryInstructions: + postalCode: V8Z 5C5 + streetAddress: Test rd + streetAddressAdditional: + registeredOffice: + deliveryAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + deliveryInstructions: + postalCode: V8Z 5C5 + streetAddress: Test rd + streetAddressAdditional: + mailingAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + addressType: null + deliveryInstructions: + postalCode: V8Z 5C5 + streetAddress: Test rd + streetAddressAdditional: + parties: + - mailingAddress: + addressCity: Victoria + addressCountry: Canada + addressCountryDescription: Canada + addressRegion: BC + deliveryInstructions: '' + postalCode: V8Z 5C5 + streetAddress: 3950 Helen Rd + streetAddressAdditional: '' + officer: + email: null + firstName: Completing + lastName: Party + partyType: person + middleName: '' + organizationName: '' + roles: + - appointmentDate: '2024-07-24' + roleType: Completing Party + - deliveryAddress: + addressCity: Victoria + addressCountry: Canada + addressCountryDescription: Canada + addressRegion: BC + deliveryInstructions: '' + postalCode: V8Z 5C5 + streetAddress: 3950 Helen Rd + streetAddressAdditional: '' + mailingAddress: + addressCity: Victoria + addressCountry: Canada + addressCountryDescription: Canada + addressRegion: BC + deliveryInstructions: '' + postalCode: V8Z 5C5 + streetAddress: 3950 Helen Rd + streetAddressAdditional: '' + officer: + email: null + firstName: Director + lastName: Tester + partyType: person + roles: + - appointmentDate: '2024-07-24' + roleType: Director + shareStructure: + shareClasses: + - name: Classic 1 Shares + priority: 0 + maxNumberOfShares: 0 + parValue: 0 + currency: string + hasMaximumShares: true + hasParValue: true + hasRightsOrRestrictions: true + series: + - name: string + priority: 0 + hasMaximumShares: true + hasRightsOrRestrictions: true + type: regular + business: + identifier: TO12345678 + header: + accountId: 1234 + affectedFilings: [] + availableOnPaperOnly: false + certifiedBy: full name + colinIds: [] + comments: [] + date: 2024-07-25T19:54:02.949741+00:00 + deletionLocked: false + effectiveDate: 2024-07-25T19:54:02.949764+00:00 + email: no_one@never.get + filingId: 150338 + inColinOnly: false + isCorrected: false + isCorrectionPending: false + name: amalgamationApplication + status: DRAFT + submitter: mocked submitter + amalgamation-short-form-horizontal-success-response: + summary: Amalgamation Short Form Horizontal Response + value: + filing: + amalgamationApplication: + amalgamatingBusinesses: + - identifier: BC0883189 + role: primary + - identifier: BC0883230 + role: amalgamating + contactPoint: + email: "contact@example.com" + phone: (555) 555-5555 + nameRequest: + legalType: BC + parties: + - mailingAddress: + addressCity: Victoria + addressCountry: Canada + addressCountryDescription: Canada + addressRegion: BC + deliveryInstructions: '' + postalCode: V8Z 5C5 + streetAddress: 3950 Helen Rd + streetAddressAdditional: '' + officer: + email: null + firstName: Completing + lastName: Party + partyType: person + roles: + - appointmentDate: '2024-07-24' + roleType: Completing Party + type: horizontal + business: + identifier: TO12345678 + header: + accountId: 1234 + affectedFilings: [] + availableOnPaperOnly: false + certifiedBy: full name + colinIds: [] + comments: [] + date: 2024-07-25T19:54:02.949741+00:00 + deletionLocked: false + effectiveDate: 2024-07-25T19:54:02.949764+00:00 + email: no_one@never.get + filingId: 150338 + inColinOnly: false + isCorrected: false + isCorrectionPending: false + name: amalgamationApplication + status: DRAFT + submitter: mocked submitter + amalgamation-short-form-vertical-success-response: + summary: Amalgamation Short Form Vertical Response + value: + filing: + amalgamationApplication: + amalgamatingBusinesses: + - identifier: BC0883189 + role: holding + - identifier: BC0883230 + role: amalgamating + contactPoint: + email: "contact@example.com" + phone: (555) 555-5555 + nameRequest: + legalType: BC + parties: + - mailingAddress: + addressCity: Victoria + addressCountry: Canada + addressCountryDescription: Canada + addressRegion: BC + deliveryInstructions: '' + postalCode: V8Z 5C5 + streetAddress: 3950 Helen Rd + streetAddressAdditional: '' + officer: + email: null + firstName: Completing + lastName: Party + partyType: person + roles: + - appointmentDate: '2024-07-24' + roleType: Completing Party + type: vertical + business: + identifier: TO12345678 + header: + accountId: 1234 + affectedFilings: [] + availableOnPaperOnly: false + certifiedBy: full name + colinIds: [] + comments: [] + date: 2024-07-25T19:54:02.949741+00:00 + deletionLocked: false + effectiveDate: 2024-07-25T19:54:02.949764+00:00 + email: no_one@never.get + filingId: 150338 + inColinOnly: false + isCorrected: false + isCorrectionPending: false + name: amalgamationApplication + status: DRAFT + submitter: mocked submitter + continuation-in-success-response: + summary: Continuation In Response + value: + filing: + continuationIn: + authorization: + date: '2024-07-01' + files: + - fileKey: 0d41f3b2-f711-4733-88fd-8169646c7dbe.pdf + fileName: TestPDFfile.pdf + contactPoint: + email: test@test.com + phone: 1234567890 + foreignJurisdiction: + country: US + identifier: TEST1234 + incorporationDate: '2024-06-01' + legalName: Test business + region: AL + nameRequest: + legalName: TEST CONT IN LTD. + legalType: C + nrNumber: NR 1234567 + nameTranslations: [] + offices: + recordsOffice: + deliveryAddress: + addressCity: Surrey + addressCountry: CA + addressRegion: BC + deliveryInstructions: + postalCode: V3S 7N3 + streetAddress: 5656 187 St + streetAddressAdditional: + mailingAddress: + addressCity: Surrey + addressCountry: CA + addressRegion: BC + deliveryInstructions: + postalCode: V3S 7N3 + streetAddress: 5656 187 St + streetAddressAdditional: + registeredOffice: + deliveryAddress: + addressCity: Surrey + addressCountry: CA + addressRegion: BC + deliveryInstructions: + postalCode: V3S 7N3 + streetAddress: 5656 187 St + streetAddressAdditional: + mailingAddress: + addressCity: Surrey + addressCountry: CA + addressRegion: BC + deliveryInstructions: + postalCode: V3S 7N3 + streetAddress: 5656 187 St + streetAddressAdditional: + parties: + - mailingAddress: + streetAddress: mailing_address - address line one + streetAddressAdditional: + addressCity: mailing_address city + addressCountry: CA + postalCode: H0H0H0 + addressRegion: BC + officer: + firstName: Joe + lastName: Swanson + middleName: P + email: joe@email.com + organizationName: + partyType: person + roles: + - appointmentDate: '2024-07-26' + roleType: Completing Party + - mailingAddress: + streetAddress: mailing_address - address line one + streetAddressAdditional: + addressCity: mailing_address city + addressCountry: CA + postalCode: H0H0H0 + addressRegion: BC + deliveryAddress: + streetAddress: mailing_address - address line one + streetAddressAdditional: + addressCity: mailing_address city + addressCountry: CA + postalCode: H0H0H0 + addressRegion: BC + officer: + firstName: Director + lastName: Swanson + middleName: P + email: joe@email.com + organizationName: + partyType: person + roles: + - appointmentDate: '2024-07-26' + roleType: Director + shareStructure: + shareClasses: + - name: Classic 1 Shares + priority: 0 + maxNumberOfShares: 0 + parValue: 0 + currency: string + hasMaximumShares: true + hasParValue: true + hasRightsOrRestrictions: true + series: + - name: string + priority: 0 + hasMaximumShares: true + hasRightsOrRestrictions: true + business: + identifier: TO12345678 + header: + accountId: 1234 + affectedFilings: [] + availableOnPaperOnly: false + certifiedBy: full name + colinIds: [] + comments: [] + date: '2024-07-25' + deletionLocked: false + effectiveDate: '2024-07-25T19:54:02.949764+00:00' + email: no_one@never.get + filingId: 150338 + inColinOnly: false + isCorrected: false + isCorrectionPending: false + name: continuationIn + status: DRAFT + submitter: mocked submitter + incorporation-application-success-response: + summary: Incorporation Application Response + value: + errors: + - null + filing: + business: + identifier: Tqcbbbc157 + header: + accountId: 6164 + affectedFilings: [] + availableOnPaperOnly: false + certifiedBy: API Specs + colinIds: [] + comments: [] + date: '2024-07-25' + deletionLocked: false + effectiveDate: '2024-07-25T16:17:57.191129+00:00' + email: no_one@never.get + filingId: 150333 + inColinOnly: false + isCorrected: false + isCorrectionPending: false + name: incorporationApplication + status: DRAFT + submitter: mocked submitter + incorporationApplication: + contactPoint: + email: no_one@never.get + phone: 123-456-7890 + nameRequest: + legalType: BEN + nrNumber: 'NR 1345876' + offices: + recordsOffice: + deliveryAddress: + addressCity: delivery_address city + addressCountry: CA + addressRegion: BC + postalCode: H0H0H0 + streetAddress: delivery_address - address line one + mailingAddress: + addressCity: mailing_address city + addressCountry: CA + addressRegion: BC + postalCode: H0H0H0 + streetAddress: mailing_address - address line one + registeredOffice: + deliveryAddress: + addressCity: delivery_address city + addressCountry: CA + addressRegion: BC + postalCode: H0H0H0 + streetAddress: delivery_address - address line one + mailingAddress: + addressCity: mailing_address city + addressCountry: CA + addressRegion: BC + postalCode: H0H0H0 + streetAddress: mailing_address - address line one + parties: + - mailingAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + postalCode: V8W 3E6 + streetAddress: 200-940 Blanshard St + streetAddressAdditional: '' + officer: + email: severin@example.com + firstName: BCREGTEST Lucille + id: 'p90x2145' + lastName: TWENTY + middleName: '' + organizationName: '' + partyType: person + roles: + - appointmentDate: '2024-07-24' + roleType: Completing Party + - deliveryAddress: + addressCity: Burnaby + addressCountry: CA + addressRegion: BC + postalCode: V5E 1R9 + streetAddress: 6767 Burford St + streetAddressAdditional: '' + mailingAddress: + addressCity: Burnaby + addressCountry: CA + addressRegion: BC + postalCode: V5E 1R9 + streetAddress: 6767 Burford St + streetAddressAdditional: '' + officer: + firstName: Director + id: 'p90x2145' + lastName: Test + middleName: '' + organizationName: '' + partyType: person + roles: + - appointmentDate: '2024-07-24' + roleType: Director + registration-sucess-response: + summary: Registartion Response + value: + filing: + business: + identifier: T12345678 + header: + accountId: 1234 + affectedFilings: [] + availableOnPaperOnly: false + certifiedBy: full name + colinIds: [] + comments: [] + date: 2024-07-25T19:54:02.949741+00:00 + deletionLocked: false + effectiveDate: 2024-07-25T19:54:02.949764+00:00 + email: no_one@never.get + filingId: 150338 + inColinOnly: false + isCorrected: false + isCorrectionPending: false + name: amalgamationApplication + status: DRAFT + submitter: mocked submitter + registration: + business: + natureOfBusiness: sample business + businessType: SP + offices: + businessOffice: + deliveryAddress: + streetAddress: delivery_address - address line one + addressCity: delivery_address city + addressCountry: Canada + postalCode: H0H0H0 + addressRegion: BC + mailingAddress: + streetAddress: mailing_address - address line one + addressCity: mailing_address city + addressCountry: Canada + postalCode: H0H0H0 + addressRegion: BC + contactPoint: + email: no_one@never.get + startDate: '2024-07-26' + nameRequest: + nrNumber: NR 8332083 + legalName: KD API SPEC SP + legalType: SP + parties: + - mailingAddress: + streetAddress: mailing_address - address line one + streetAddressAdditional: + addressCity: mailing_address city + addressCountry: CA + postalCode: H0H0H0 + addressRegion: BC + deliveryAddress: + streetAddress: delivery_address - address line one + streetAddressAdditional: + addressCity: delivery_address city + addressCountry: CA + postalCode: H0H0H0 + addressRegion: BC + officer: + firstName: Joe + lastName: Swanson + middleName: P + email: joe@email.com + organizationName: + partyType: person + roles: + - appointmentDate: '2024-07-26' + roleType: Completing Party + - appointmentDate: '2024-07-26' + roleType: Proprietor + '401': + description: Similar to 403 Forbidden, but specifically for use when authentication is required and has failed or has not yet been provided. The user does not have valid authentication credentials for the target resource. + content: + application/json: + examples: + amalgamation-unauthorized-response: + summary: Amalgamation - Not Authorized To Submit Response + value: + errorMessage: API backend third party service error. + rootCause: message:You are not authorized to submit a filing for TgtPxoS4FF. + continuation-in-unauthorized-response: + summary: Continuation In - Not Authorized To Submit Response + value: + errorMessage: API backend third party service error. + rootCause: message:You are not authorized to submit a filing for TgtPxoS4FF. + incorporation-unauthorized-response: + summary: Incorporation - Not Authorized To Submit Response + value: + errorMessage: API backend third party service error. + rootCause: message:You are not authorized to submit a filing for TgtPxoS4FF. + registration-unauthorized-response: + summary: Registration - Not Authorized To Submit Response + value: + errorMessage: API backend third party service error. + rootCause: message:You are not authorized to submit a filing for TgtPxoS4FF. + description: '

Use this endpoint to create a new business. This endpoint supports creation of a new business entity by these filings:

  • Incorporation Application
  • Amalgamation (Regular, Horizontal and Vertical)
  • Continuation In
  • Registration

' requestBody: content: application/json: schema: - oneOf: - - $ref: '#/components/schemas/Incorporation_application' - - $ref: '#/components/schemas/Registration' + $ref: '#/components/schemas/Filing' + examples: + amalgamation-regular-request: + summary: Amalgamation Regular Request + value: + filing: + header: + accountId: 1234 + certifiedBy: full name + email: "no_one@never.get" + date: '2024-07-26' + name: amalgamationApplication + amalgamationApplication: + amalgamatingBusinesses: + - identifier: BC0883189 + role: amalgamating + - identifier: BC0883230 + role: amalgamating + contactPoint: + email: "contact@example.com" + phone: (555) 555-5555 + courtApproval: null + nameRequest: + legalType: BC + offices: + recordsOffice: + deliveryAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + deliveryInstructions: + postalCode: V8Z 5C5 + streetAddress: Test rd + streetAddressAdditional: + mailingAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + deliveryInstructions: + postalCode: V8Z 5C5 + streetAddress: Test rd + streetAddressAdditional: + registeredOffice: + deliveryAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + deliveryInstructions: + postalCode: V8Z 5C5 + streetAddress: Test rd + streetAddressAdditional: + mailingAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + deliveryInstructions: + postalCode: V8Z 5C5 + streetAddress: Test rd + streetAddressAdditional: + parties: + - mailingAddress: + addressCity: Victoria + addressCountry: Canada + addressCountryDescription: Canada + addressRegion: BC + deliveryInstructions: '' + postalCode: V8Z 5C5 + streetAddress: 3950 Helen Rd + streetAddressAdditional: '' + officer: + email: null + firstName: Completing + lastName: Party + middleName: '' + organizationName: '' + partyType: person + roles: + - appointmentDate: '2024-07-24' + roleType: Completing Party + - mailingAddress: + addressCity: Victoria + addressCountry: Canada + addressCountryDescription: Canada + addressRegion: BC + deliveryInstructions: '' + postalCode: V8Z 5C5 + streetAddress: 3950 Helen Rd + streetAddressAdditional: '' + officer: + email: null + firstName: Director + lastName: Tester + partyType: person + roles: + - appointmentDate: '2024-07-24' + roleType: Director + shareStructure: + shareClasses: + - name: Classic 1 Shares + priority: 0 + maxNumberOfShares: 0 + parValue: 0 + currency: string + hasMaximumShares: true + hasParValue: true + hasRightsOrRestrictions: true + series: + - name: string + priority: 0 + hasMaximumShares: true + hasRightsOrRestrictions: true + type: regular + amalgamation-short-form-horizontal-request: + summary: Amalgamation Short Form Horizontal Request + value: + filing: + header: + accountId: 1234 + certifiedBy: full name + email: "no_one@never.get" + date: '2024-07-26' + name: amalgamationApplication + amalgamationApplication: + amalgamatingBusinesses: + - identifier: BC0883189 + role: holding + - identifier: BC0883230 + role: amalgamating + contactPoint: + email: "contact@example.com" + phone: (555) 555-5555 + nameRequest: + legalType: BC + parties: + - mailingAddress: + addressCity: Victoria + addressCountry: Canada + addressCountryDescription: Canada + addressRegion: BC + deliveryInstructions: '' + postalCode: V8Z 5C5 + streetAddress: 3950 Helen Rd + streetAddressAdditional: '' + officer: + email: null + firstName: Completing + lastName: Party + partyType: person + roles: + - appointmentDate: '2024-07-24' + roleType: Completing Party + type: horizontal + amalgamation-short-form-vertical-request: + summary: Amalgamation Short Form Vertical Request + value: + filing: + header: + accountId: 1234 + certifiedBy: full name + email: "no_one@never.get" + date: '2024-07-26' + name: amalgamationApplication + amalgamationApplication: + amalgamatingBusinesses: + - identifier: BC0883189 + role: primary + - identifier: BC0883230 + role: amalgamating + contactPoint: + email: "contact@example.com" + phone: (555) 555-5555 + courtApproval: null, + nameRequest: + legalType: BC + parties: + - mailingAddress: + addressCity: Victoria + addressCountry: Canada + addressCountryDescription: Canada + addressRegion: BC + deliveryInstructions: '' + postalCode: V8Z 5C5 + streetAddress: 3950 Helen Rd + streetAddressAdditional: '' + officer: + email: null + firstName: Completing + lastName: Party + partyType: person + roles: + - appointmentDate: '2024-07-24' + roleType: Completing Party + type: vertical + continuation-in-request: + summary: Continuation In Request + value: + filing: + header: + accountId: 1234 + certifiedBy: full name + email: 'no_one@never.get' + date: '2024-07-26' + name: continuationIn + continuationIn: + authorization: + date: '2024-07-01' + files: + - file: + lastModified: 1667594705083 + name: TestPDFfile.pdf + size: 83186 + fileKey: 0d41f3b2-f711-4733-88fd-8169646c7dbe.pdf + fileName: TestPDFfile.pdf + contactPoint: + email: test@test.com + phone: 1234567890 + foreignJurisdiction: + country: US + identifier: TEST1234 + incorporationDate: '2024-06-01' + legalName: Test business + region: AL + nameRequest: + nrNumber: NR 1234567 + legalName: TEST CONT IN LTD. + legalType: C + nameTranslations: [] + offices: + recordsOffice: + deliveryAddress: + streetAddress: delivery_address - address line one + addressCity: delivery_address city + addressCountry: Canada + postalCode: H0H0H0 + addressRegion: BC + mailingAddress: + streetAddress: mailing_address - address line one + addressCity: mailing_address city + addressCountry: Canada + postalCode: H0H0H0 + addressRegion: BC + registeredOffice: + deliveryAddress: + streetAddress: delivery_address - address line one + addressCity: delivery_address city + addressCountry: Canada + postalCode: H0H0H0 + addressRegion: BC + mailingAddress: + streetAddress: mailing_address - address line one + addressCity: mailing_address city + addressCountry: Canada + postalCode: H0H0H0 + addressRegion: BC + parties: + - mailingAddress: + streetAddress: mailing_address - address line one + streetAddressAdditional: + addressCity: mailing_address city + addressCountry: CA + postalCode: H0H0H0 + addressRegion: BC + officer: + firstName: Joe + lastName: Swanson + middleName: P + email: joe@email.com + organizationName: + partyType: person + roles: + - appointmentDate: '2024-07-26' + roleType: Completing Party + - mailingAddress: + streetAddress: mailing_address - address line one + streetAddressAdditional: + addressCity: mailing_address city + addressCountry: CA + postalCode: H0H0H0 + addressRegion: BC + deliveryAddress: + streetAddress: mailing_address - address line one + streetAddressAdditional: + addressCity: mailing_address city + addressCountry: CA + postalCode: H0H0H0 + addressRegion: BC + officer: + firstName: Director + lastName: Swanson + middleName: P + email: joe@email.com + organizationName: + partyType: person + roles: + - appointmentDate: '2024-07-26' + roleType: Director + shareStructure: + shareClasses: + - name: Classic 1 Shares + priority: 0 + maxNumberOfShares: 0 + parValue: 0 + currency: string + hasMaximumShares: true + hasParValue: true + hasRightsOrRestrictions: true + series: + - name: string + priority: 0 + hasMaximumShares: true + hasRightsOrRestrictions: true + incorporation-application-request: + summary: Incorporation Application Request + value: + filing: + header: + certifiedBy: API Specs + email: no_one@never.get + name: incorporationApplication + date: '2024-07-25' + accountId: 6164 + incorporationApplication: + nameRequest: + legalType: BEN + nrNumber: NR 1234567 + offices: + registeredOffice: + deliveryAddress: + streetAddress: delivery_address - address line one + addressCity: delivery_address city + addressCountry: CA + postalCode: H0H0H0 + addressRegion: BC + mailingAddress: + streetAddress: mailing_address - address line one + addressCity: mailing_address city + addressCountry: CA + postalCode: H0H0H0 + addressRegion: BC + recordsOffice: + deliveryAddress: + streetAddress: delivery_address - address line one + addressCity: delivery_address city + addressCountry: CA + postalCode: H0H0H0 + addressRegion: BC + mailingAddress: + streetAddress: mailing_address - address line one + addressCity: mailing_address city + addressCountry: CA + postalCode: H0H0H0 + addressRegion: BC + contactPoint: + email: no_one@never.get + phone: 123-456-7890 + parties: + - mailingAddress: + addressCity: Victoria + addressCountry: CA + addressRegion: BC + postalCode: V8W 3E6 + streetAddress: 200-940 Blanshard St + streetAddressAdditional: '' + officer: + email: severin@example.com + firstName: BCREGTEST Lucille + lastName: TWENTY + middleName: '' + organizationName: '' + partyType: person + roles: + - appointmentDate: '2024-07-24' + roleType: Completing Party + - deliveryAddress: + addressCity: Burnaby + addressCountry: CA + addressRegion: BC + postalCode: V5E 1R9 + streetAddress: 6767 Burford St + streetAddressAdditional: '' + mailingAddress: + addressCity: Burnaby + addressCountry: CA + addressRegion: BC + postalCode: V5E 1R9 + streetAddress: 6767 Burford St + streetAddressAdditional: '' + officer: + firstName: Director + lastName: Test + middleName: '' + organizationName: '' + partyType: person + roles: + - appointmentDate: '2024-07-24' + roleType: Director + registration-request: + summary: Registration Request + value: + filing: + header: + accountId: 1234 + certifiedBy: full name + email: "no_one@never.get" + date: '2024-07-26' + name: registration + registration: + business: + natureOfBusiness: sample business + businessType: SP + offices: + businessOffice: + deliveryAddress: + streetAddress: delivery_address - address line one + addressCity: delivery_address city + addressCountry: Canada + postalCode: H0H0H0 + addressRegion: BC + mailingAddress: + streetAddress: mailing_address - address line one + addressCity: mailing_address city + addressCountry: Canada + postalCode: H0H0H0 + addressRegion: BC + contactPoint: + email: no_one@never.get + startDate: '2024-07-26' + nameRequest: + nrNumber: NR 8332083 + legalName: KD API SPEC SP + legalType: SP + parties: + - mailingAddress: + streetAddress: mailing_address - address line one + streetAddressAdditional: + addressCity: mailing_address city + addressCountry: CA + postalCode: H0H0H0 + addressRegion: BC + deliveryAddress: + streetAddress: delivery_address - address line one + streetAddressAdditional: + addressCity: delivery_address city + addressCountry: CA + postalCode: H0H0H0 + addressRegion: BC + officer: + firstName: Joe + lastName: Swanson + middleName: P + email: joe@email.com + organizationName: + partyType: person + roles: + - appointmentDate: '2024-07-26' + roleType: Completing Party + - appointmentDate: '2024-07-26' + roleType: Proprietor parameters: - schema: type: boolean in: query name: draft - description: Set to save a draft in the ledger. No validations are performed. + description: This parameter is used to save a filing in Draft form which can be retrieved at a later time. - schema: type: boolean in: query - description: 'Validate the submission, but do not save or process it. Errors and warnings are returned if there are any.' + description: 'This parameter is used to submit a filing for validation only, no entity will be created. Use this to confirm that a filing is fully complete and correct prior to submission.' name: only_validate - $ref: '#/components/parameters/accountId' parameters: [] @@ -1113,7 +3553,7 @@ paths: schema: $ref: '#/components/schemas/party' operationId: get-businesses-identifier-parties - description: Get all associated parties with a business. + description: Get all parties (Incorporator, Completing Party and Directors) associated with a business. parameters: - $ref: '#/components/parameters/accountId' /businesses/search: @@ -1194,7 +3634,7 @@ components: Address: type: object title: Address Schema - description: 'Standard address format: apartment, unit, or street address number and street name. City, province or territory code, country, postal code and instructions for delivery.' + description: 'Standard address format: apartment, unit, or street address number and street name. City, province or territory code, country, postal code and instructions for delivery.' properties: streetAddress: type: string @@ -1204,7 +3644,7 @@ components: streetAddressAdditional: type: string maxLength: 50 - description: 'Address line 2: extra address details added to line 1. ' + description: 'Address line 2: extra address details added to line 1.' addressCity: type: string maxLength: 40 @@ -1213,7 +3653,7 @@ components: addressRegion: type: string maxLength: 2 - example: 'BC for British Columbia ' + example: 'BC' description: '2 char code for province, state, territory or district.' addressCountry: type: string @@ -1223,15 +3663,15 @@ components: type: string maxLength: 15 example: V8R 2P1 - description: 'Postal, Pin, Zip, or letters/digits representing po stcode. ' + description: 'Postal, Pin, Zip, or letters/digits representing po stcode.' deliveryInstructions: type: string + maxLength: 80 example: '"Our apartment is located at the back of the building."' - description: 'Specific instructions for the freight forwarder or carrier ' + description: 'Specific instructions for the freight forwarder or carrier' required: - streetAddress - addressCity - - addressRegion - addressCountry - postalCode x-examples: @@ -1239,10 +3679,78 @@ components: streetAddress: 5-4761 Bay Street streetAddressAdditional: Student Residence addressCity: Victoria - addressRegion: 'BC for British Columbia ' + addressRegion: 'BC for British Columbia' addressCountry: Canada postalCode: V8R 2P1 - deliveryInstructions: '"Our apartment is located at the back of the building."' + deliveryInstructions: 'Our apartment is located at the back of the building.' + Agm_extension: + type: object + title: AGM Extension Information Schema + description: Notice of AGM(Annual General Meeting) date extension allows companies to request an extension to the deadline for holding an Annual General Meeting (AGM). The longest extension granted at one time is six months. + properties: + agmExtension: + type: object + required: + - year + - isFirstAgm + - extReqForAgmYear + properties: + year: + type: string + description: The year for which the AGM extension is being requested. This year cannot be before the company's incorporation date or in the future. + example: '2024' + isFirstAgm: + type: boolean + description: Indicates if this is the company''s very first AGM since incorporation. + example: true + extReqForAgmYear: + type: boolean + description: Indicates if an extension has already been requested for this AGM year. False for the first extension request of the year, true for subsequent requests within the same AGM year. + example: false + prevAgmRefDate: + type: string + format: date + description: Point of reference from which companies have 15 months to either file an AGM or request an extension. For the first AGM (when isFirstAgm is true), this is not required. Required when isFirstAgm is false. + example: '2023-06-01' + expireDateCurrExt: + type: string + format: date + description: Date of expiration for current extension, if applicable. Required when requesting an additional extension (when extReqForAgmYear is true). + example: '2024-04-10' + totalApprovedExt: + type: integer + description: Total duration of extension approved, measured in months. + example: 6 + extensionDuration: + type: integer + description: Duration of the current extension request in months. Maximum is 6 months per request. + example: 6 + expireDateApprovedExt: + type: string + format: date + description: Expiration date for approved extension. + example: '2024-07-10' + Agm_location_change: + type: object + title: AGM Location Change Information Schema + description: 'Notice of AGM(Annual General Meeting) location change allows changing of the company''s AGM location. Requires the information of the AGM year, reason of change and the new location.' + properties: + agmLocationChange: + type: object + required: + - year + - reason + - agmLocation + properties: + year: + type: string + description: Year of the AGM, Must be on or after incorporation year and cannot be future year. + reason: + type: string + maxLength: 2000 + agmLocation: + type: string + maxLength: 400 Agreement_type: type: object title: Incorporation Agreement Type @@ -1256,7 +3764,7 @@ components: enum: - sample - custom - example: Sample or custom + example: sample description: 'Example: Sample and custom' required: - agreementType @@ -1379,6 +3887,76 @@ components: orderDate: '2019-08-24T14:15:22Z' effectOfOrder: The Company will cease operations orderDetails: The Company is ordered to dissolve + Amalgamation_application: + type: object + title: Amalgamation Application Filing + description: 'Amalgamation_application' + properties: + amalgamationApplication: + type: object + required: + - type + - amalgamatingBusinesses + - nameRequest + - parties + - contactPoint + - courtApproval + properties: + type: + type: string + title: The type of Amalgamation + enum: + - regular + - vertical + - horizontal + amalgamatingBusinesses: + type: array + items: + required: + - role + - identifier + properties: + role: + type: string + enum: + - amalgamating + - holding + - primary + identifier: + type: string + foreignJurisdiction: + $ref: '#/components/schemas/Foreign_jurisdiction' + legalName: + type: string + nameRequest: + $ref: '#/components/schemas/Name_request' + nameTranslations: + $ref: '#/components/schemas/Name_translations' + contactPoint: + $ref: '#/components/schemas/Contact_point' + parties: + type: array + items: + $ref: '#/components/schemas/party' + courtOrder: + $ref: '#/components/schemas/Court_order' + courtApproval: + title: Amalgamation statement + type: boolean + offices: + type: object + required: + - registeredOffice + description: 'Addresses related to the business. ' + properties: + registeredOffice: + $ref: '#/components/schemas/Office' + recordsOffice: + $ref: '#/components/schemas/Office' + shareStructure: + $ref: '#/components/schemas/Share_structure' + required: + - amalgamationApplication Annual_report: type: object title: Annual Report Filing @@ -1395,11 +3973,11 @@ components: annualGeneralMeetingDate: type: string format: date - description: 'Date the AGM (annual general meeting) took place. ' + description: 'Date the AGM (annual general meeting) took place.' annualReportDate: type: string format: date - description: 'Fiscal Year covered in the annual report. ' + description: 'Fiscal Year covered in the annual report.' directors: type: array description: Individual who is a member of the board of directors of the company as a result of having been elected or appointed to that position @@ -1455,7 +4033,7 @@ components: cessationDate: type: string format: date - example: 'Date the officer has ended his/her role ' + example: '2024-07-23' description: Date the director or officer has been terminated in the role. required: - officer @@ -1559,13 +4137,13 @@ components: registeredDate: '2022-04-16T21:36:07.009977+00:00' startDate: '2022-04-10' type: 'DBA' - description: 'Organization or enterprising entity engaged in commercial, industrial, or professional activities.' + description: 'Organization or business entity.' properties: lastLedgerTimestamp: type: string format: date-time example: '2020-11-24T18:24:27.179623+00:00' - description: Recorded date/time of a company's financial transactions. + description: Recorded date/time of a company's filing. fiscalYearEndDate: type: string format: date @@ -1580,7 +4158,7 @@ components: type: string format: date-time example: '2020-11-24T18:23:53.498863+00:00' - description: 'The date written on the company''s certificate of incorporation. ' + description: 'The date written on the company''s certificate of Incorporation, Amalgamation, Continuation In or Registration.' identifier: type: string example: 'BC1234567 is an identifier for a corporation ' @@ -1588,7 +4166,7 @@ components: description: 'Unique code(letters & numbers) to identify a business, issued by the provincial or federal registry.' legalName: type: string - description: Name that appears on the formation document of the business. + description: Registered name of the business. example: '1234567 B.C. Ltd. is a legal name for a corporation ' state: type: string @@ -1599,24 +4177,66 @@ components: legalType: type: string enum: + - A + - B + - BC - BEN + - CBEN + - C + - CC + - CCC + - CEM - CP - - SP + - CS + - CUL + - EPR + - FI + - FOR - GP - - BC - example: 'GP: General Partnership' - description: 'Type of business eg: individual(SP), partnership(GP).' + - LIC + - LIB + - LL + - LLC + - LP + - MF + - PA + - PAR + - PFS + - QA + - QB + - QC + - QD + - QE + - REG + - RLY + - S + - SB + - SP + - T + - TMY + - ULC + - UQA + - UQB + - UQC + - UQD + - UQE + - XCP + - XL + - XP + - XS + example: 'GP' + description: 'Type of business eg: BC corporation (B), Continued in corporation (C), Sole proprietor(SP), General Partnership(GP).' taxId: type: string - pattern: '^[0-9]{9}$' - example: BN123456789 + pattern: '^[0-9]{9}[A-Z]{2}[0-9]{4}$|^[0-9]{9}$' + example: '123456789BC0001' description: 'Company unique business number assigned by CRA: BN9 or BN15. ' goodStanding: type: boolean - description: Being in good standing means that the company is not in the process of being dissolved for non-filing of federal and/or provincial tax returns or non-filing of the BC annual report. + description: The business is up to date with required filings, e.g. Annual Report. adminFreeze: type: boolean - description: 'Example: If a business is not in good standing or investigated for fraud BC Registry Admin might freeze the business to prevent further filing from them. ' + description: 'The business has been placed in a Frozen state by the Registry which will prevent any further filings from being made ' naics: $ref: '#/components/schemas/Naics' natureOfBusiness: @@ -1645,7 +4265,7 @@ components: example: '''https://LEGAL-API-HOST/api/v2/businesses/IDENTIFIER/filings/FILING_ID''' alternateNames: type: array - description: The alternate name of the business + description: The alternate name of the business. Only applicable for Sole Proprietorship(SP) and General Partnership(GP). Only applicable for Sole Proprietorship(SP) and General Partnership(GP). items: type: object properties: @@ -1682,16 +4302,37 @@ components: format: date description: The end date of the alternate name (reserved for future use) nullable: true - example: '' + example: '2024-07-15' type: type: string description: The type of the alternate name enum: - DBA - TRANSLATION + warnings: + type: array + items: + type: object + properties: + code: + type: string + title: Warning code + example: 'INVALID_LEGAL_STRUCTURE_DIRECTORS' + message: + type: string + title: Warning message + example: 'A minimum of 3 directors is required' + warningType: + type: string + title: Warning message + example: 'MISSING_REQUIRED_BUSINESS_INFO' + filing: + type: string + title: The link to the filing that resulted in the non-compliance. required: - identifier Change_of_address: + title: Change of Address Filing type: object description: 'Change of an address used by the business, could be different types of address eg: delivery address. ' properties: @@ -1749,46 +4390,67 @@ components: deliveryInstructions: '"Our unit is located at the back of the building."' Change_of_directors: type: object - description: 'Add or remove a director, or update information regarding a current director.' + title: Change of Directors Filing + description: Filing to add, remove, or update information regarding company directors. properties: changeOfDirectors: - type: array - description: 'Add or remove a director, or update information regarding a current director.' - items: - $ref: '#/components/schemas/party' + type: object + description: This section contains all the changes you want to make to your company''s directors. + required: + - directors + properties: + directors: + type: array + items: + allOf: + - $ref: '#/components/schemas/Director' + - type: object + properties: + actions: + type: array + title: List of actions taken on a director + description: Select one or more actions that apply to this director + items: + type: string + enum: + - appointed + - ceased + - nameChanged + - addressChanged + example: ["appointed"] + required: + - actions + required: + - changeOfDirectors x-examples: Example 1: changeOfDirectors: - - party: - taxId: BN123456789 - roles: - - appointmentDate: '2019-08-24' - cessationDate: '2019-08-24' - roleType: Completing Party - officer: - givenName: John - familyName: Smith - additionalName: Adam + directors: + - officer: + firstName: John + lastName: Smith middleInitial: A - taxId: BN123456789 - email: abc.def@gov.bc.ca deliveryAddress: streetAddress: 5-4761 Bay Street streetAddressAdditional: Building A addressCity: Victoria - addressRegion: BC for British Columbia + addressRegion: BC addressCountry: Canada postalCode: V8R 2P1 - deliveryInstructions: '"Our unit is located at the back of the building."' + deliveryInstructions: "Our unit is located at the back of the building." mailingAddress: streetAddress: 5-4761 Bay Street streetAddressAdditional: string addressCity: Victoria - addressRegion: BC for British Columbia + addressRegion: BC addressCountry: Canada postalCode: V8R 2P1 - deliveryInstructions: '"Our unit is located at the back of the building."' + deliveryInstructions: "Our unit is located at the back of the building." title: Chief Executive Officer + appointmentDate: '2019-08-24' + cessationDate: null + actions: + - appointed Change_of_name: type: object title: Change of Entity Name @@ -1913,7 +4575,6 @@ components: deliveryInstructions: '"Our unit is located at the back of the building."' parties: - party: - taxId: BN123456789 roles: - appointmentDate: '2019-08-24' cessationDate: '2019-08-24' @@ -1923,7 +4584,6 @@ components: familyName: Smith additionalName: Adam middleInitial: A - taxId: BN123456789 email: abc.def@gov.bc.ca deliveryAddress: streetAddress: 5-4761 Bay Street @@ -1980,6 +4640,126 @@ components: timestamp: '2022-04-19 15:59:55' reference: businessId: C1234567 + Continuation_in: + type: object + title: Continuation In Filing + description: Represents the filing for a foreign corporation applying to “continue in” to BC. To do so, authorization must have been received from the foreign jurisdiction. Authorization is typically in the form of a letter. The authorization must be sent to the registry as a precondition to this transaction. + required: + - continuationIn + properties: + continuationIn: + type: object + required: + - foreignJurisdiction + - authorization + - nameRequest + - offices + - parties + properties: + business: + $ref: '#/components/schemas/Business' + foreignJurisdiction: + type: object + required: + - country + - identifier + - legalName + - incorporationDate + properties: + country: + $ref: '#/components/schemas/Foreign_jurisdiction/properties/country' + region: + $ref: '#/components/schemas/Foreign_jurisdiction/properties/region' + identifier: + type: string + title: Identifier of the business in the foreign jurisdiction. + legalName: + type: string + title: Legal name of the business in the foreign jurisdiction. + incorporationDate: + type: string + format: date + title: Incorporation date of the business in the foreign jurisdiction. + taxId: + type: string + title: The BN9 of this business + pattern: "^[0-9]{9}$" + affidavitFileKey: + type: string + title: The Identifier for affidavit file in file server + authorization: + type: object + required: + - files + - date + properties: + files: + type: array + minItems: 1 + items: + required: + - fileKey + - fileName + properties: + fileKey: + type: string + title: The Identifier for authorization file in file server + fileName: + type: string + title: The name of the file in file server + date: + type: string + format: date + title: Authorization date + expiryDate: + type: string + format: date + title: Authorization expiry date + contactPoint: + $ref: '#/components/schemas/Contact_point' + nameRequest: + $ref: '#/components/schemas/Name_request' + nameTranslations: + $ref: '#/components/schemas/Name_translations' + offices: + type: object + description: 'Addresses related to the business. ' + properties: + registeredOffice: + $ref: '#/components/schemas/Office' + recordsOffice: + $ref: '#/components/schemas/Office' + required: + - registeredOffice + parties: + type: array + description: 'Persons having a role in the corporation eg: company officer.' + items: + $ref: '#/components/schemas/party' + shareStructure: + $ref: '#/components/schemas/Share_structure' + courtOrder: + $ref: '#/components/schemas/Court_order' + Consent_continuation_out: + type: object + title: Consent Continuation Out Filing + description: Represents the filing for a company's consent to continue out of British Columbia to another jurisdiction. This filing is required when a BC company wants to move its registration to a different province or country. This consent is valid for six months from the date of authorization. If the continuation is not completed within this period, a new consent may be required. + required: + - foreignJurisdiction + properties: + foreignJurisdiction: + $ref: '#/components/schemas/Foreign_jurisdiction' + courtOrder: + $ref: '#/components/schemas/Court_order' + x-examples: + Example 1: + consentContinuationOut: + foreignJurisdiction: + country: "CA" + region: "ON" + courtOrder: + fileNumber: "A1234" + effectOfOrder: "planOfArrangement" Contact_point: type: object title: Business Contact Point Schema @@ -2002,7 +4782,7 @@ components: description: 'Phone number to be used to contact the business eg: (250) 234-4433.' extension: type: number - example: (555) 555-5555 + example: 123 description: Extension number of the business contact phone number (555) 555-5555. required: - email @@ -2049,7 +4829,6 @@ components: deliveryInstructions: '"Our unit is located at the back of the building."' parties: - party: - taxId: BN123456789 roles: - appointmentDate: '2019-08-24' cessationDate: '2019-08-24' @@ -2059,7 +4838,6 @@ components: familyName: Lane additionalName: Adam middleInitial: A - taxId: BN123456789 email: abc.def@gov.bc.ca deliveryAddress: streetAddress: 5-4761 Bay Street @@ -2155,7 +4933,7 @@ components: - CP - HC - CSC - example: '''CP''' + example: 'CP' description: 'Defines cooperatives by type of membership eg: Financial Cooperatives.' rulesFileKey: type: string @@ -2254,6 +5032,7 @@ components: type: string description: The date and time that the court order has been issued. format: date-time + example: '1970-01-01T00:00:00+00:00' effectOfOrder: type: string minLength: 0 @@ -2264,6 +5043,9 @@ components: minLength: 0 maxLength: 2000 description: A brief note to explain the purpose of the Court Order. + fileKey: + type: string + title: The Identifier for court order file in file server required: - courtOrder x-examples: @@ -2299,6 +5081,71 @@ components: title: Path of the property in json description: '***Item not used*** What will be changed in the correction filing.' type: object + Director: + title: Director Schema + type: object + description: Represents a single director of a company, including personal information and appointment details. + properties: + officer: + type: object + description: Personal information about the director. + properties: + firstName: + type: string + maxLength: 30 + description: First name of the director/officer. + example: "Jane" + lastName: + type: string + maxLength: 30 + description: Last name of the director/officer. + example: "Doe" + middleInitial: + type: string + maxLength: 30 + description: The middle name initial of the director/officer. + example: "A" + prevFirstName: + type: string + maxLength: 30 + description: previous first name, in the case of a legal name change in a filing + example: "Janet" + prevLastName: + type: string + maxLength: 30 + description: previous last name, in the case of a legal name change in a filing + example: "Smith" + prevMiddleInitial: + type: string + maxLength: 30 + description: previous middle name, in the case of a legal name change in a filing + example: "B" + required: + - firstName + - lastName + deliveryAddress: + $ref: '#/components/schemas/Address' + mailingAddress: + $ref: '#/components/schemas/Address' + title: + type: string + description: 'Official title or position of the director in the company.' + example: "Chief Financial Officer" + appointmentDate: + type: string + format: date + description: 'The date when the director started their role. Format: YYYY-MM-DD' + example: "2023-06-15" + cessationDate: + type: string + format: date + nullable: true + description: 'The date when the director ended their role. Format: YYYY-MM-DD' + required: + - officer + - deliveryAddress + - appointmentDate + - cessationDate Dissolution: title: Dissolution Filing type: object @@ -2312,7 +5159,6 @@ components: hasLiabilities: true parties: - party: - taxId: BN123456789 roles: - appointmentDate: '2019-08-24' cessationDate: '2019-08-24' @@ -2322,7 +5168,6 @@ components: familyName: Smith additionalName: Adam middleInitial: A - taxId: BN123456789 email: abc.def@gov.bc.ca deliveryAddress: streetAddress: 5-4761 Bay Street @@ -2455,172 +5300,178 @@ components: isPaymentActionRequired: true '': string properties: - header: - type: object - required: - - name - - date - - certifiedBy - properties: - name: - type: string - title: The type of the main filing. - enum: - - alteration - - annualReport - - amalgamationApplication - - appointReceiver - - changeOfDirectors - - changeOfAddress - - changeOfName - - changeOfRegistration - - continuedOut - - conversion - - correction - - courtOrder - - dissolution - - dissolved - - incorporationApplication - - registration - - restoration - - specialResolution - - transition - - registrarsNotation - - registrarsOrder - description: 'Filing name. ' - availableOnPaperOnly: - type: boolean - description: 'If filing results(ouputs) available only on paper: Yes/No. ' - inColinOnly: - type: boolean - description: 'Filing information stored in COLIN only: Yes/No.' - date: - type: string - format: date - title: The submission date of the final version of the filing. - description: 'Date of the filing. ' - certifiedBy: - type: string - description: 'Staff certifying filing. ' - email: - type: string - format: email - description: email contact for the filing. - filingId: - type: integer - title: The id of the filing. - default: 0 - description: 'Filing identifier eg: 1234. ' - example: 1234 - effectiveDate: - type: string - format: date-time - title: The date and time a filing should become valid and applied. - description: Date and time the filing is taking effect. - paymentToken: - type: string - title: A valid payment token for this filing against this business. - description: 'Replaces sensitive payment information with a unique identifier, received back from SBC_PAY' - submitter: - type: string - title: Account name of the person submitting this filing. - description: 'Person/applicant submitting the filing. ' - status: - type: string - title: The status of this filing. - enum: - - DRAFT - - PENDING - - COMPLETED - - ERROR - description: 'Status of the filing eg: ''draft''. ' - example: '"DRAFT", "PENDING", "COMPLETED", "ERROR"' - affectedFilings: - type: array - title: List of affected filings (ids) from this filing. - description: 'Filings related to the header eg: [1234,4856].' - items: - type: integer - example: '[1234,4856]' - isCorrected: - type: boolean - title: Has this filing been corrected? - description: 'If filing has been corrected: Yes/No.' - isCorrectionPending: - type: boolean - title: Is a correction pending for this filing? - description: 'If filing correction are in pending status: Yes/No.' - comments: - type: array - title: List of filing comments. - description: 'Notes about filing. ' - items: - $ref: '#/components/schemas/Comment' - waiveFees: - type: boolean - description: 'Are fees being waived for the filing: Yes/No.' - priority: - type: boolean - description: 'Is it a priority filing: Yes/No. ' - routingSlipNumber: - type: string - title: A valid routing slip number in case of a staff filing. - maxLength: 9 - pattern: '^\d{9}$' - description: If filing paid with cash or cheque there will be a routing slip of 9 digits. - folioNumber: - type: string - title: A folio number used for payment tracking purposes. - maxLength: 50 - description: 'Reference number to help keep track of transactions eg: used in BCOL. ' - example: '1332' - datNumber: - type: string - title: A dat number used for payment tracking purposes. - maxLength: 10 - pattern: '^[A-Z]{1}[0-9]{7,9}$' - description: Payment identifyer (9 digits) for FAS payments. - example: C234567890 - bcolAccountNumber: - type: string - title: BCOL account number. - maxLength: 6 - pattern: ^(.*)$ - example: '910207' - description: 'BCOL account number to be debited if paying with a BCOL account eg: 910207.' - sbcAccount: - type: integer - title: authorization system account number. - description: 'SBC_AUTH account number. ' - paymentAccount: - type: string - title: payment org account identifier. - maxLength: 30 - pattern: ^(.*)$ - description: 'Payment identifyer from where the payment will be debited. ' - example: '180670' - paymentMethod: - type: string - title: payment method. - enum: - - ONLINE_BANKING - - CC - - DIRECT_PAY - - DRAWDOWN - - INTERNAL - description: 'Method of payment used to pay for filing, possible values are: ONLINE_BANKING,CC,DIRECT_PAY,DRAWDOWN,INTERNAL.' - example: credit card CC - isPaymentActionRequired: - type: boolean - title: flag for payment redirect. - description: Further action required to finalize the payment. + name: + type: string + title: The type of the main filing. + enum: + - adminFreeze + - alteration + - agmExtension + - agmLocationChange + - amalgamationApplication + - amendedAGM + - amendedAnnualReport + - amendedChangeOfDirectors + - annualReport + - appointReceiver + - changeOfDirectors + - changeOfAddress + - changeOfName + - changeOfRegistration + - consentContinuationOut + - continuationIn + - continuationOut + - continuedOut + - conversion + - correction + - courtOrder + - dissolution + - dissolved + - incorporationApplication + - putBackOn + - registration + - restoration + - specialResolution + - transition + - registrarsNotation + - registrarsOrder + description: 'Filing name. ' + availableOnPaperOnly: + type: boolean + description: 'If filing results(ouputs) available only on paper: Yes/No. ' + inColinOnly: + type: boolean + description: 'Filing information stored in COLIN only: Yes/No.' + date: + type: string + format: date + title: The submission date of the final version of the filing. + description: 'Date of the filing. ' + certifiedBy: + type: string + description: 'Staff certifying filing. ' + email: + type: string + format: email + description: email contact for the filing. + filingId: + type: integer + title: The id of the filing. + default: 0 + description: 'Filing identifier eg: 1234. ' + example: 1234 + effectiveDate: + type: string + format: date-time + title: The date and time a filing should become valid and applied. + description: Date and time the filing is taking effect. + paymentToken: + type: string + title: A valid payment token for this filing against this business. + description: 'Replaces sensitive payment information with a unique identifier, received back from SBC_PAY' + submitter: + type: string + title: Account name of the person submitting this filing. + description: 'Person/applicant submitting the filing. ' + status: + type: string + title: The status of this filing. + enum: + - DRAFT + - PENDING + - COMPLETED + - ERROR + description: 'Status of the filing eg: ''draft''. ' + example: 'DRAFT' + affectedFilings: + type: array + title: List of affected filings (ids) from this filing. + description: 'Filings related to the header eg: [1234,4856].' + items: + type: integer + example: 1234 + isCorrected: + type: boolean + title: Has this filing been corrected? + description: 'If filing has been corrected: Yes/No.' + isCorrectionPending: + type: boolean + title: Is a correction pending for this filing? + description: 'If filing correction are in pending status: Yes/No.' + comments: + type: array + title: List of filing comments. + description: 'Notes about filing. ' + items: + $ref: '#/components/schemas/Comment' + waiveFees: + type: boolean + description: 'Are fees being waived for the filing: Yes/No.' + priority: + type: boolean + description: 'Is it a priority filing: Yes/No. ' + routingSlipNumber: + type: string + title: A valid routing slip number in case of a staff filing. + maxLength: 9 + pattern: '^\d{9}$' + description: If filing paid with cash or cheque there will be a routing slip of 9 digits. + folioNumber: + type: string + title: A folio number used for payment tracking purposes. + maxLength: 50 + description: 'Reference number to help keep track of transactions eg: used in BCOL. ' + example: '1332' + datNumber: + type: string + title: A dat number used for payment tracking purposes. + maxLength: 10 + pattern: '^[A-Z]{1}[0-9]{7,9}$' + description: Payment identifyer (9 digits) for FAS payments. + example: C234567890 + bcolAccountNumber: + type: string + title: BCOL account number. + maxLength: 6 + pattern: ^(.*)$ + example: '910207' + description: 'BCOL account number to be debited if paying with a BCOL account eg: 910207.' + sbcAccount: + type: integer + title: authorization system account number. + description: 'SBC_AUTH account number. ' + example: 416 + paymentAccount: + type: string + title: payment org account identifier. + maxLength: 30 + pattern: ^(.*)$ + description: 'Payment identifyer from where the payment will be debited. ' + example: '180670' + paymentMethod: + type: string + title: payment method. + enum: + - ONLINE_BANKING + - CC + - DIRECT_PAY + - DRAWDOWN + - INTERNAL + description: 'Method of payment used to pay for filing, possible values are: ONLINE_BANKING,CC,DIRECT_PAY,DRAWDOWN,INTERNAL.' + example: 'CC' + isPaymentActionRequired: + type: boolean + title: flag for payment redirect. + description: Further action required to finalize the payment. '': type: string x-stoplight: id: 7nl2sc9w8mtqr description: Header name. required: - - header + - name + - date + - certifiedBy Filing: type: object title: Registry Filing Envelope @@ -2754,7 +5605,6 @@ components: deliveryInstructions: string parties: - party: - taxId: string roles: - appointmentDate: '2019-08-24' cessationDate: '2019-08-24' @@ -2764,7 +5614,6 @@ components: familyName: string additionalName: string middleInitial: string - taxId: string email: user@example.com deliveryAddress: streetAddress: string @@ -2803,38 +5652,144 @@ components: hasRightsOrRestrictions: true description: Submitting updates related to a business or incorporating/registering a new business. properties: - header: - $ref: '#/components/schemas/filing_header' - business: - $ref: '#/components/schemas/Business' filing: - oneOf: - - oneOf: - - $ref: '#/components/schemas/Incorporation_application' - - $ref: '#/components/schemas/Registration' - - anyOf: - - $ref: '#/components/schemas/Alteration' - - $ref: '#/components/schemas/Alteration' - - $ref: '#/components/schemas/Annual_report' - - $ref: '#/components/schemas/Change_of_address' - - $ref: '#/components/schemas/Change_of_directors' - - $ref: '#/components/schemas/Change_of_name' - - $ref: '#/components/schemas/Change_of_registration' - - $ref: '#/components/schemas/Conversion' - - $ref: '#/components/schemas/Court_order' - - $ref: '#/components/schemas/Correction' - - $ref: '#/components/schemas/Dissolution' - - $ref: '#/components/schemas/Incorporation_application' - - $ref: '#/components/schemas/Registrars_notation' - - $ref: '#/components/schemas/Registrars_order' - - $ref: '#/components/schemas/Registration' - - $ref: '#/components/schemas/Restoration' - - $ref: '#/components/schemas/Special_resolution' - - $ref: '#/components/schemas/Transition' - - $ref: '#/components/schemas/Unmanaged' + properties: + header: + $ref: '#/components/schemas/filing_header' + business: + $ref: '#/components/schemas/Business' + filing: + oneOf: + - oneOf: + - $ref: '#/components/schemas/Incorporation_application' + - $ref: '#/components/schemas/Registration' + - anyOf: + - $ref: '#/components/schemas/Agm_extension' + - $ref: '#/components/schemas/Agm_location_change' + - $ref: '#/components/schemas/Alteration' + - $ref: '#/components/schemas/Amalgamation_application' + - $ref: '#/components/schemas/Annual_report' + - $ref: '#/components/schemas/Change_of_address' + - $ref: '#/components/schemas/Change_of_directors' + - $ref: '#/components/schemas/Change_of_name' + - $ref: '#/components/schemas/Change_of_registration' + - $ref: '#/components/schemas/Consent_continuation_out' + - $ref: '#/components/schemas/Continuation_in' + - $ref: '#/components/schemas/Conversion' + - $ref: '#/components/schemas/Court_order' + - $ref: '#/components/schemas/Correction' + - $ref: '#/components/schemas/Dissolution' + - $ref: '#/components/schemas/Incorporation_application' + - $ref: '#/components/schemas/Registrars_notation' + - $ref: '#/components/schemas/Registrars_order' + - $ref: '#/components/schemas/Registration' + - $ref: '#/components/schemas/Restoration' + - $ref: '#/components/schemas/Special_resolution' + - $ref: '#/components/schemas/Transition' + - $ref: '#/components/schemas/Unmanaged' description: Submitting updates related to a business or incorporating/registering a new business. required: - - header + - filing + Foreign_jurisdiction: + type: object + title: Foreign Jurisdiction Schema + description: Represents the foreign jurisdiction for business operations. + required: + - country + properties: + country: + type: string + description: The country code of the foreign jurisdiction (ISO 3166-1 alpha-2 code). + minLength: 2 + maxLength: 2 + example: "CA" + region: + description: The specific region (province/state) within Canada or USA. For other countries, this field can be null. + oneOf: + - type: string + description: Canadian provinces and territories. + enum: + - "AB" + - "BC" + - "MB" + - "NB" + - "NL" + - "NS" + - "NT" + - "NU" + - "ON" + - "PE" + - "QC" + - "SK" + - "YT" + - "FEDERAL" + example: "ON" + - type: string + description: US states and territories. + enum: + - "AK" + - "AL" + - "AR" + - "AS" + - "AZ" + - "CA" + - "CO" + - "CT" + - "DC" + - "DE" + - "FL" + - "GA" + - "GU" + - "HI" + - "IA" + - "ID" + - "IL" + - "IN" + - "KS" + - "KY" + - "LA" + - "MA" + - "MD" + - "ME" + - "MI" + - "MN" + - "MO" + - "MP" + - "MS" + - "MT" + - "NC" + - "ND" + - "NE" + - "NH" + - "NJ" + - "NM" + - "NV" + - "NY" + - "OH" + - "OK" + - "OR" + - "PA" + - "PR" + - "RI" + - "SC" + - "SD" + - "TN" + - "TX" + - "UM" + - "UT" + - "VA" + - "VI" + - "VT" + - "WA" + - "WI" + - "WV" + - "WY" + example: "WA" + x-examples: + Example 1: + foreignJurisdiction: + country: "CA" + region: "QC" Incorporation_application: title: Incorporation Application Filing type: object @@ -2913,7 +5868,6 @@ components: deliveryInstructions: '"Our apartment is located at the back of the building."' parties: - party: - taxId: BN123456789 roles: - appointmentDate: '2019-08-24' cessationDate: '2019-08-24' @@ -2923,7 +5877,6 @@ components: familyName: string additionalName: string middleInitial: string - taxId: BN123456789 email: abc.def@gov.bc.ca deliveryAddress: streetAddress: 5-4761 Bay Street @@ -3022,7 +5975,7 @@ components: type: string format: uri description: 'Name of legal filing. ' - example: '"http://example.com"' + example: 'http://example.com' receipt: type: string description: 'Confirmation of filing and payment completion. ' @@ -3051,10 +6004,10 @@ components: submitter: Registry Staff items: $ref: '#/components/schemas/Ledger_item' - description: 'Business record to summarize revenues and expenses of the business eg: common ledger for asset accounts.' + description: 'The ledger is the record of all filings that have been performed on or in association with a business entity.' Ledger_item: type: object - description: 'Ledger items track accounting items eg: assets, liabilities, capital, revenues, and expenses.' + description: 'Set of information recorded by the Registry in relation to an individual filing on a business entity''s ledger.' x-examples: Example 1: availableOnPaperOnly: true @@ -3079,7 +6032,7 @@ components: properties: availableOnPaperOnly: type: boolean - description: Yes if information only accessible on paper. + description: Yes if information only accessible on paper. This typically relates to very old filings that pre-date online Registry systems. businessIdentifier: type: string minLength: 1 @@ -3102,10 +6055,10 @@ components: type: string format: date-time minLength: 1 - description: Date the filing application was done. + description: Date the filing was performed. legalFilings: type: array - description: Filing that business is legally required to do. + description: This field identifies filings that corporations are required to submit under the BC Corporations Act. items: type: string enum: @@ -3134,48 +6087,48 @@ components: type: string minLength: 1 format: uri - description: 'Link for documents related to ledger. ' + description: 'Link for documents related to filing.' displayName: type: string minLength: 1 - description: Name to be displayed for ledger item. + description: This field represents the name to be displayed for the ledger item associated with the filing record. effectiveDate: type: string minLength: 1 format: date-time - description: Date ledger item takes effect. + description: Date filing was to be effective. filingId: type: number - description: 'Number identifying ledger item filing. ' + description: 'Unique Identifier of the filing.' filingLink: type: string minLength: 1 format: uri - description: 'Link related to ledger item filing. ' + description: 'Link related to filing.' name: type: string minLength: 1 - description: 'Name related to ledger item. ' + description: 'Name of the filing to which the record relates.' isFutureEffective: type: boolean - description: Identify if ledger item filing effective date is further than the application date (yes/no). + description: Identify if filing was submitted with a future effective date (yes/no). paymentStatusCode: type: string minLength: 1 - description: 'Code indicating the state of the payment eg: Completed. ' + description: 'Code indicating the state of the payment for the filing eg: Completed.' example: Completed status: type: string minLength: 1 - description: 'Text describing the state of the ledger item. ' + description: 'Text describing the state of the filing.' submittedDate: type: string minLength: 1 - description: 'Date the ledger item was submitted. ' + description: 'Date the filing was submitted.' submitter: type: string minLength: 1 - description: 'Name of the person submitting the ledger item. ' + description: 'Name of the user who performed the filing.' required: - availableOnPaperOnly - businessIdentifier @@ -3196,13 +6149,13 @@ components: Naics: type: object title: NAICS Schema - description: NAICS is an abbreviation for The North American Industry Classification System and is a standard used to classify business activities. + description: '

NAICS is an abbreviation for The North American Industry Classification System and is a standard used to classify business activities.

NAICS information is not required or collected for all types of business entities.

' properties: naicsCode: type: string pattern: '^[0-9]{5,9}$' description: 'Six digits unique identifier assigned to a business activity. ' - example: 32621 is the code for 'Tires Manufacturing' description + example: '32621' naicsDescription: type: string example: 32621 is the code for 'Tires Manufacturing' description @@ -3219,6 +6172,7 @@ components: nrNumber: type: string maxLength: 10 + example: NR 1234567 description: 'Unique number identifying the request. ' legalType: type: string @@ -3238,6 +6192,7 @@ components: expires: type: string format: date-time + example: '1970-01-01T00:00:00+00:00' description: Date and time the request will be in 'expired' status. consent: type: string @@ -3270,7 +6225,7 @@ components: Name_translations: type: array title: Name Translations Schema - description: 'Used when business name is to be translated. ' + description: 'Used when business name is to be translated.' x-examples: Example 1: - id: '1234' @@ -3280,25 +6235,34 @@ components: properties: id: type: string - description: 'Name unique identifyer eg: 1234. ' + description: 'Name unique identifyer eg: 1234.' example: '1234' name: type: string maxLength: 50 title: Name Translation pattern: '^[ A-Za-zÀ-ÿ_@./#’&+-]*$' - description: 'Text indicating name translation to be used. ' + description: 'Text indicating name translation to be used.' + type: + type: string + title: The type of translation + enum: + - TRANSLATION + - DBA required: - name Office: title: Office Schema type: object - description: 'Addresses related to the business. ' + description: 'Addresses related to the business.' + required: + - mailingAddress + - deliveryAddress properties: officeType: type: string - example: 'Head office ' - description: 'Type of office eg: registered office. ' + example: 'Head office' + description: 'Type of office eg: registered office.' mailingAddress: $ref: '#/components/schemas/Address' deliveryAddress: @@ -3310,31 +6274,27 @@ components: streetAddress: 5-4761 Bay Street streetAddressAdditional: Building A addressCity: Victoria - addressRegion: 'BC for British Columbia ' + addressRegion: 'BC for British Columbia' addressCountry: Canada postalCode: V8R 2P1 - deliveryInstructions: '"Our apartment is located at the back of the building."' + deliveryInstructions: 'Our apartment is located at the back of the building.' deliveryAddress: streetAddress: 5-4761 Bay Street streetAddressAdditional: Building A addressCity: Victoria - addressRegion: 'BC for British Columbia ' + addressRegion: 'BC for British Columbia' addressCountry: Canada postalCode: V8R 2P1 - deliveryInstructions: '"Our apartment is located at the back of the building."' + deliveryInstructions: 'Our apartment is located at the back of the building.' party: type: object title: party - description: 'Represent a person and its role in relation to a business. ' + description: 'Represent a person and its role in relation to a business.' properties: party: type: object - description: 'Represent a person and its role in relation to a business. ' + description: 'Represent a person and its role in relation to a business.' properties: - taxId: - type: string - description: 'Company unique business number assigned by CRA: BN9 or BN15 eg: BN123456789.' - example: BN123456789 roles: type: array description: 'Role of the person in relation to the business eg: director' @@ -3344,7 +6304,6 @@ components: oneOf: - $ref: '#/components/schemas/Person' - $ref: '#/components/schemas/Business' - - $ref: '#/components/schemas/Business' description: Officer is a key management executive of the business deliveryAddress: $ref: '#/components/schemas/Address' @@ -3353,7 +6312,7 @@ components: title: type: string example: Chief Executive Officer - description: 'Title of the party in relation to the business eg: Chief Executive Officer ' + description: 'Title of the party in relation to the business eg: Chief Executive Officer' required: - roles - officer @@ -3361,7 +6320,6 @@ components: x-examples: Example 1: party: - taxId: BN123456789 roles: - appointmentDate: '2019-08-24' cessationDate: '2019-08-24' @@ -3371,94 +6329,23 @@ components: familyName: Smith additionalName: Adam middleInitial: A - taxId: BN123456789 email: abc.def@gov.bc.ca deliveryAddress: streetAddress: 5-4761 Bay Street streetAddressAdditional: Building A addressCity: Victoria - addressRegion: 'BC for British Columbia ' + addressRegion: 'BC for British Columbia' addressCountry: Canada postalCode: V8R 2P1 - deliveryInstructions: '"Our apartment is located at the back of the building."' + deliveryInstructions: 'Our apartment is located at the back of the building.' mailingAddress: streetAddress: 5-4761 Bay Street streetAddressAdditional: Building A addressCity: Victoria - addressRegion: 'BC for British Columbia ' + addressRegion: 'BC for British Columbia' addressCountry: Canada postalCode: V8R 2P1 - deliveryInstructions: '"Our apartment is located at the back of the building."' - title: Chief Executive Officer - party - copy: - type: object - x-stoplight: - id: ee4nvid30gu0u - title: party - description: 'Represent a person and its role in relation to a business. ' - properties: - party: - type: object - description: 'Represent a person and its role in relation to a business. ' - properties: - taxId: - type: string - example: BN123456789 - description: 'Company unique business number assigned by CRA: BN9 or BN15 eg: BN123456789.' - roles: - type: array - description: 'Role of the person in relation to the business eg: director.' - items: - $ref: '#/components/schemas/partyRole' - officer: - oneOf: - - $ref: '#/components/schemas/Person' - - $ref: '#/components/schemas/Business' - - $ref: '#/components/schemas/Business' - description: Officer is a key management executive of the business - deliveryAddress: - $ref: '#/components/schemas/Address' - mailingAddress: - $ref: '#/components/schemas/Address' - title: - type: string - example: Chief Executive Officer - description: 'Title of the party in relation to the business eg: Chief Executive Officer.' - required: - - roles - - officer - - mailingAddress - x-examples: - Example 1: - party: - taxId: BN123456789 - roles: - - appointmentDate: '2019-08-24' - cessationDate: '2019-08-24' - roleType: Completing Party - officer: - givenName: John - familyName: smith - additionalName: Adam - middleInitial: A - taxId: BN123456789 - email: abc.def@gov.bc.ca - deliveryAddress: - streetAddress: 5-4761 Bay Street - streetAddressAdditional: Building A - addressCity: Victoria - addressRegion: 'BC for British Columbia ' - addressCountry: Canada - postalCode: V8R 2P1 - deliveryInstructions: '"Our apartment is located at the back of the building."' - mailingAddress: - streetAddress: 5-4761 Bay Street - streetAddressAdditional: Building A - addressCity: Victoria - addressRegion: 'BC for British Columbia ' - addressCountry: Canada - postalCode: V8R 2P1 - deliveryInstructions: '"Our apartment is located at the back of the building."' + deliveryInstructions: 'Our apartment is located at the back of the building.' title: Chief Executive Officer partyRole: type: object @@ -3482,16 +6369,20 @@ components: - Incorporator - Proprietor - Partner + - Applicant description: 'The role a person occupies in the business eg: officer.' x-examples: Example 1: appointmentDate: '2019-08-24' cessationDate: '2019-08-24' roleType: Director + required: + - roleType + - appointmentDate Person: type: object title: Person Schema - description: 'An individual that is currently or had previously occupied a role in relation to a business. ' + description: 'An individual that is currently or had previously occupied a role in relation to a business.' properties: givenName: type: string @@ -3505,17 +6396,11 @@ components: type: string title: 'An additional name for a Person, can be used for a middle name.' maxLength: 30 - description: 'Other name used by the individual. ' + description: 'Other name used by the individual.' middleInitial: type: string maxLength: 30 description: Initial of the individual's middle name. - taxId: - type: string - title: The CRA business number - pattern: '^[0-9]{9}$' - description: 'Company unique business number assigned by CRA: BN9 or BN15 ' - example: BN123456789 email: type: string format: email @@ -3527,7 +6412,6 @@ components: familyName: Smith additionalName: Adam middleInitial: A - taxId: BN123456789 email: abc.def@gov.bc.ca Registrars_notation: title: Registrars Notation Information Schema @@ -3756,7 +6640,6 @@ components: deliveryInstructions: '"Our apartment is located at the back of the building."' parties: - party: - taxId: BN123456789 roles: - appointmentDate: '2019-08-24' cessationDate: '2019-08-24' @@ -3766,7 +6649,6 @@ components: familyName: string additionalName: string middleInitial: string - taxId: BN123456789 email: abc.def@gov.bc.ca deliveryAddress: streetAddress: 5-4761 Bay Street @@ -3850,7 +6732,7 @@ components: type: integer title: 'The display order of the shares that indicates priority. ' description: 'The display order that indicates priority eg: 2. with value 2, the share class will be displayed the second, after share class with priority 1. ' - example: 'Eg: with value 2, the share class will be displayed the second, after share class with priority 1. ' + example: 2 maxNumberOfShares: type: number title: 'Maximum number of shares in the class. ' @@ -3994,25 +6876,6 @@ components: BN: '123456789' target: string weight: 0 - Suggestion_item - copy: - type: object - x-stoplight: - id: 21kymuins8gxo - description: A suggestion from an auto-search - properties: - name: - type: string - description: Matching term - identifier: - type: string - BN: - type: string - target: - type: string - weight: - type: integer - description: The weight of the search term is scored by the matching algorithm against the search term provided. - title: '' Transition: type: object title: Transition Filing @@ -4097,7 +6960,6 @@ components: deliveryInstructions: '"Receptopn is on 2nd floor."' parties: - party: - taxId: BN123456789 roles: - appointmentDate: '2019-08-24' cessationDate: '2021-06-14' @@ -4107,7 +6969,6 @@ components: familyName: Williams additionalName: Lucy middleInitial: L - taxId: BN123456789 email: abc.def@gov.bc.ca deliveryAddress: streetAddress: 5-111 Bay Street @@ -4166,7 +7027,7 @@ components: securitySchemes: api_key: type: apiKey - description: API Gateway assigned API key for a consumer with the PPR API privilege. Required for all requests. + description: API Gateway assigned API key for a user with the Business Registry API privilege. Required for all requests. name: x-apikey in: header jwt: @@ -4210,7 +7071,7 @@ components: accountId: name: Account-Id in: header - description: The account that the user is operating on behalf of. + description: Identifier for the user that is performing the requested action. required: true schema: type: string