--- title: "InternationalBusinessSearch.submitted" method: POST path: "InternationalBusinessSearch.submitted" tags: ["Webhook Events"] --- # InternationalBusinessSearch.submitted `POST InternationalBusinessSearch.submitted` (webhook) Emitted when an International Business search has been submitted for processing. ## Payload - V1InternationalBusinessSearchSubmittedWebhook - `__event__` WebhookMetadata - `type` 'BusinessSearch.submitted' | 'BusinessSearch.responded' | 'BusinessSearch.completed' | 'BusinessSearch.failed' | 'BusinessSearch.cancelled' | 'BusinessSearch.updated' | 'PersonSearch.submitted' | 'PersonSearch.completed' | 'PersonSearch.failed' | 'PersonSearch.updated' | 'DMFSearch.submitted' | 'DMFSearch.completed' | 'DMFSearch.failed' | 'LiensSearch.submitted' | 'LiensSearch.completed' | 'LiensSearch.failed' | 'LienFiling.created' | 'LienFiling.updated' | 'LienFiling.deleted' | 'DocketSearch.submitted' | 'DocketSearch.completed' | 'DocketSearch.failed' | 'DocketDetailsSearch.submitted' | 'DocketDetailsSearch.completed' | 'DocketDetailsSearch.failed' | 'DocketExhibitSearch.submitted' | 'DocketExhibitSearch.completed' | 'DocketExhibitSearch.failed' | 'APIKey.created' | 'APIKey.deleted' | 'OnboardingSession.completed' | 'Order.created' | 'RegistrationEnrichment.submitted' | 'RegistrationEnrichment.completed' | 'RegistrationEnrichment.failed' | 'NAICSPredictionRequest.submitted' | 'NAICSPredictionRequest.completed' | 'NAICSPredictionRequest.failed' | 'WebsiteAnalysisRequest.submitted' | 'WebsiteAnalysisRequest.completed' | 'WebsiteAnalysisRequest.failed' | 'WebPresenceRequest.submitted' | 'WebPresenceRequest.completed' | 'WebPresenceRequest.failed' | 'PortfolioItem.created' | 'PortfolioItem.updated' | 'PortfolioItem.deleted' | 'PortfolioGroup.created' | 'PortfolioGroup.updated' | 'PortfolioGroup.deleted' | 'TINVerification.submitted' | 'TINVerification.completed' | 'TINVerification.failed' | 'AdverseMediaSearch.submitted' | 'AdverseMediaSearch.completed' | 'AdverseMediaSearch.failed' | 'EmployeeVerificationRequest.submitted' | 'EmployeeVerificationRequest.completed' | 'EmployeeVerificationRequest.failed' | 'InternationalBusinessSearch.submitted' | 'InternationalBusinessSearch.completed' | 'InternationalBusinessSearch.failed', required — The canonical list of supported Webhook events. Every Webhook event sent via the notifier must be registered here. An exhaustive match is used against this enumeration to ensure that all events are valid and have corresponding rendering logic. @see WebhookNotifier.render_payload - `origin` 'api' | 'console' | 'mcp' | 'onboarding' - `organization_id` string, nullable - `application_id` string, nullable - `external_id` string, nullable - `application_type` string, nullable - `id` string, uuid, required — Unique identifier for the international business search. - `user` V1UserAttributionResponse — Response model for user attribution operations. This model defines the structure for user attribution API responses. - `id` string, uuid, required — Unique identifier for the user. - `first_name` string, required — First name of the user. - `last_name` string, required — Last name of the user. - `email` string, required — Email address of the user. - `state` 'PENDING' | 'EXECUTING' | 'COMPLETED' | 'FAILED' | 'CANCELLED', required - `name` string, nullable — The name inputted in the search (null for filing-number-only searches). - `address` string, nullable — The address string inputted in the search (null for filing-number-only searches). - `iso2_country_code` 'AR' | 'AU' | 'AT' | 'BE' | 'BR' | 'CA' | 'CZ' | 'DK' | 'FI' | 'FR' | 'DE' | 'IN' | 'IE' | 'IT' | 'JP' | 'KE' | 'LU' | 'MY' | 'MX' | 'NL' | 'NZ' | 'NG' | 'NO' | 'PL' | 'PT' | 'SA' | 'SK' | 'ES' | 'SE' | 'CH' | 'TR' | 'UA' | 'GB' — Enumeration of ISO 3166-1 alpha-2 country codes supported for international searches. This is a subset of ISO2CountryCode that includes only jurisdictions where international search capabilities are available. - `search_address` V1InternationalAddressSummaryResponse - `premise` string, nullable — Alphanumeric code for the location (e.g., building number). - `thoroughfare` string, nullable — Complete street name. - `dependent_thoroughfare` string, nullable — Secondary street name or cross street. - `locality` string, required — Most common population center (e.g., city name). - `dependent_locality` string, nullable — Additional locality information (e.g., neighborhood, district). - `administrative_area` string, nullable — Most common administrative division (e.g., province, state, region). - `postal_code` string, nullable — Complete postal code. - `country_iso_3` string, required — ISO 3166-1 alpha-3 country code (e.g., 'CAN', 'GBR', 'AUS'). - `latitude` number, nullable — Latitude coordinate of the address. - `longitude` number, nullable — Longitude coordinate of the address. - `type` string, nullable — Registry-provided address type, e.g. Registered Office, Principal Place of Business, or SAIL. - `full_address` string, required — Return the complete formatted address for display. - `filing_number` string, nullable — The company registration (filing) number inputted in the search. - `reference_id` string, nullable — The reference ID inputted in the search. - `business_name_match` 'NO_MATCH' | 'SIMILAR' | 'EXACT' - `business_address_match` 'NO_MATCH' | 'REGION' | 'CITY' | 'COUNTRY' | 'EXACT' - `filing_number_match` boolean, nullable — Whether the inputted filing number found the company at the registry. False means the search fell back to the name search; null means no filing number was provided. - `created_at` string, date-time, required — The datetime the search was created. - `updated_at` string, date-time, nullable — The datetime the search was updated at (generally when the search completed). - `verified` boolean, nullable — Indicates whether the found business was a close enough match to be considered verified. - `scores` V1ScoreResponse[], nullable — An array containing Baselayer's ratings. - `type` 'fraud' | 'risk' | 'kyb', required - `score` number, required — The score value. - `rating` string, required — The rating associated with the score. - `error` string, nullable — Any errors that occurred. - `warnings` string[] — Any warnings that occurred. - `options` InternationalBusinessSearchOptions[] — Optional, separately-billed add-ons requested for this search. - `business` V1InternationalBusinessResponse - `name` string, required — The name of the international business. - `file_number` string, required — The file number of the registration. - `status` 'active' | 'inactive' | 'unknown', required — Status field indicating whether the corporate registration filing is active or inactive. - `standing` string, nullable — The registry's own status wording behind the coarse `status` (e.g. 'Registered', 'In Liquidation'). - `legal_form` string, nullable — The registry's legal form / legal structure for the business (e.g. 'ltd', 'gmbh'). - `country` 'AR' | 'AU' | 'AT' | 'BE' | 'BR' | 'CA' | 'CZ' | 'DK' | 'FI' | 'FR' | 'DE' | 'IN' | 'IE' | 'IT' | 'JP' | 'KE' | 'LU' | 'MY' | 'MX' | 'NL' | 'NZ' | 'NG' | 'NO' | 'PL' | 'PT' | 'SA' | 'SK' | 'ES' | 'SE' | 'CH' | 'TR' | 'UA' | 'GB', required — Enumeration of ISO 3166-1 alpha-2 country codes supported for international searches. This is a subset of ISO2CountryCode that includes only jurisdictions where international search capabilities are available. - `issue_date` string, date, nullable — The date the registration was issued. - `incorporation_date` string, date, nullable — The date the international business was incorporated. Often the same as the issue date. - `last_annual_account_date` string, date, nullable — The date of the business's most recent annual account filing (a data-freshness signal). - `dissolution_date` string, date, nullable — The date the business was dissolved, when the registry provides it. Populated only when the enhanced profile add-on was ordered. - `dissolved` boolean, nullable — Whether the registry data indicates the business is dissolved. - `registration_authority` string, nullable — Registry authority name, e.g. Companies House, United Kingdom. - `registration_authority_code` string, nullable — Registry authority code where provided, e.g. CA-ON or CA-FE. - `registration_type` string, nullable — Registry-provided registration type, e.g. Federal, Extra-Provincial, or Registered society. - `registry_type` string, nullable — Registry-provided entity or registry type where distinct from legal form. - `addresses` V1InternationalAddressSummaryResponse[] — The addresses of the international business. - `premise` string, nullable — Alphanumeric code for the location (e.g., building number). - `thoroughfare` string, nullable — Complete street name. - `dependent_thoroughfare` string, nullable — Secondary street name or cross street. - `locality` string, required — Most common population center (e.g., city name). - `dependent_locality` string, nullable — Additional locality information (e.g., neighborhood, district). - `administrative_area` string, nullable — Most common administrative division (e.g., province, state, region). - `postal_code` string, nullable — Complete postal code. - `country_iso_3` string, required — ISO 3166-1 alpha-3 country code (e.g., 'CAN', 'GBR', 'AUS'). - `latitude` number, nullable — Latitude coordinate of the address. - `longitude` number, nullable — Longitude coordinate of the address. - `type` string, nullable — Registry-provided address type, e.g. Registered Office, Principal Place of Business, or SAIL. - `full_address` string, required — Return the complete formatted address for display. - `alternative_names` string[] — A list of alternative names (e.g. DBAs, trading names, and former registered names) found associated with the business entity. - `officers` V1InternationalOfficer[] — Directors and officers of the business. Populated only when the enhanced profile add-on was ordered. - `name` string, nullable — Name of the party as recorded in the registry. For a person this is their full name; for a corporate party it is the company name. - `entity_type` 'Business' | 'Person' - `date_of_birth` string, date, nullable — Date of birth of the party when the party is a person. Registries commonly disclose only the month and year, in which case the day defaults to the first of the month. - `nationality` string, nullable — Nationality of the party when the party is a person. - `place_of_residence` string, nullable — Place of residence of the party when the party is a person, as a single formatted address string. - `place_of_birth` string, nullable — Place of birth of the party when the party is a person, as a single formatted address string. - `address` string, nullable — Correspondence or registered address of the party, as a single formatted address string. - `id_number` string, nullable — Registry-assigned identifier for the party (e.g. a personal or entity reference number in the source registry). - `registration_number` string, nullable — Company registration number of the party when the party is itself a corporation. Null for individual parties. - `titles` string[] — The officer's role titles at this business (e.g. "Director", "Secretary"). - `is_active` boolean, nullable — Whether the officer's appointment is currently active. - `powers` string[] — Powers or authorities granted to the officer, as described by the registry (e.g. authority to represent the company). - `start_date` string, date, nullable — Date the officer's appointment began. - `end_date` string, date, nullable — Date the officer's appointment ended, if it is no longer active. - `directorships` V1InternationalOfficerDirectorship[] — Other companies at which this officer holds or held a role, when the registry discloses them. - `company_name` string, nullable — Name of the other company at which the officer holds or held a role. - `company_number` string, nullable — Registration number of that other company in its home registry. - `title` string, nullable — The officer's role at that other company (e.g. "Director"). - `is_active` boolean, nullable — Whether the officer's role at that other company is currently active. - `beneficial_owners` V1InternationalBeneficialOwner[] — Ultimate beneficial owners of the business from structured UBO filings, plus registry role-based ownership signals such as Australian Ultimate Holding Company representatives. Populated only when the enhanced profile add-on was ordered. - `name` string, nullable — Name of the party as recorded in the registry. For a person this is their full name; for a corporate party it is the company name. - `entity_type` 'Business' | 'Person' - `date_of_birth` string, date, nullable — Date of birth of the party when the party is a person. Registries commonly disclose only the month and year, in which case the day defaults to the first of the month. - `nationality` string, nullable — Nationality of the party when the party is a person. - `place_of_residence` string, nullable — Place of residence of the party when the party is a person, as a single formatted address string. - `place_of_birth` string, nullable — Place of birth of the party when the party is a person, as a single formatted address string. - `address` string, nullable — Correspondence or registered address of the party, as a single formatted address string. - `id_number` string, nullable — Registry-assigned identifier for the party (e.g. a personal or entity reference number in the source registry). - `registration_number` string, nullable — Company registration number of the party when the party is itself a corporation. Null for individual parties. - `nature_of_control` string[] — How the owner exercises control over the business, as described by the registry (e.g. ownership-of-shares or voting-rights statements). - `notified_date` string, date, nullable — Date the registry was notified of the beneficial ownership. - `kind` string, nullable — The registry's classification of the beneficial owner (e.g. its person-with-significant-control kind). - `start_date` string, date, nullable — Date the beneficial ownership began. - `shareholders` V1InternationalShareholder[] — Shareholders of the business. Populated only when the enhanced profile add-on was ordered. - `name` string, nullable — Name of the party as recorded in the registry. For a person this is their full name; for a corporate party it is the company name. - `entity_type` 'Business' | 'Person' - `date_of_birth` string, date, nullable — Date of birth of the party when the party is a person. Registries commonly disclose only the month and year, in which case the day defaults to the first of the month. - `nationality` string, nullable — Nationality of the party when the party is a person. - `place_of_residence` string, nullable — Place of residence of the party when the party is a person, as a single formatted address string. - `place_of_birth` string, nullable — Place of birth of the party when the party is a person, as a single formatted address string. - `address` string, nullable — Correspondence or registered address of the party, as a single formatted address string. - `id_number` string, nullable — Registry-assigned identifier for the party (e.g. a personal or entity reference number in the source registry). - `registration_number` string, nullable — Company registration number of the party when the party is itself a corporation. Null for individual parties. - `percentage` string, nullable — Percentage of the share class held, as a string exactly as provided by the registry (e.g. "50.0"). - `share_count` number, nullable — Number of shares held by the shareholder. - `total_nominal_value` number, nullable — Total nominal (face) value of the shares held by the shareholder. - `share_class` string, nullable — Description of the class of shares held (e.g. "Ordinary"). - `beneficially_held` boolean, nullable — Whether the shares are held beneficially (for the shareholder's own benefit) rather than on behalf of another party. - `share_capital` V1InternationalShareCapital[] — Share capital structure of the business. Populated only when the enhanced profile add-on was ordered. - `class_code` string, nullable — Registry code identifying the share class. - `class_description` string, nullable — Human-readable description of the share class (e.g. "Ordinary"). - `quantity` number, nullable — Number of shares issued in this class. - `unit_nominal_value` number, nullable — Nominal (face) value of a single share in this class. - `currency` string, nullable — Currency in which the share values for this class are denominated. - `total_nominal_value` number, nullable — Total nominal (face) value of all shares issued in this class. - `voting_rights` string, nullable — Voting rights attached to shares in this class, as described by the registry. - `contact` V1InternationalCompanyContact — Contact details for an international business (enhanced profile). - `email` string, nullable — Contact email address on file for the business. - `phone` string, nullable — Contact telephone number on file for the business. - `fax` string, nullable — Fax number on file for the business. - `website` string, nullable — Website on file for the business. - `identifiers` V1InternationalCompanyIdentifiers — Extra registry and tax identifiers for an international business. The primary registration number is the top-level ``file_number``; these are the *additional* identifiers (tax id, secondary registration number, and any other registry-specific identifiers), enriched by the enhanced profile add-on. - `tax_id` string, nullable — Tax identifier registered for the business (e.g. VAT or other national tax number), where the registry provides one. - `secondary_registration_number` string, nullable — An additional registration number distinct from the primary file number, where the registry provides one. - `other_identifiers` string[] — Any further registry-specific identifiers associated with the business. - `activities` V1InternationalBusinessActivity[] — Classified business activities (e.g. SIC / NACE codes) for the business. Fully populated only when the enhanced profile add-on was ordered. - `code` string, nullable — Classification code for the activity (e.g. a SIC or NACE code). Null when the registry files the activity as a free-text declaration rather than a coded classification. - `description` string, nullable — Human-readable description of the business activity. - `registered_agent` V1InternationalRegisteredAgent — The registered agent listed for an international business (enhanced profile). - `name` string, nullable — Name of the registered agent listed for the business. - `address` string, nullable — Address of the registered agent, as a single formatted address string. - `url` string, uri, required — The API URL to retrieve the search. ## Acknowledgement `200` Successful Response - unknown ## Other responses - `422` — Validation Error --- [API](https://skmtc.net/baselayer/apis/baselayer-api-service.md) · [All operations](https://skmtc.net/baselayer/apis/baselayer-api-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/baselayer/baselayer-api-service/versions/0cc89938bc26/schema)