API Reference
API Reference

InternationalBusinessSearch.submitted

wbhk
InternationalBusinessSearch.submitted

Emitted when an International Business search has been submitted for processing.

Payload
__event__
object
Defaults to [object Object]
uuid
required

Unique identifier for the international business search.

UserAttributionResponse (v1) | null

Details on the User who performed the search.

string
enum
required

The current state of the search.

Allowed:

The name inputted in the search (null for filing-number-only searches).

The address string inputted in the search (null for filing-number-only searches).

InternationalSearchISO2CountryCode | null

The ISO 2 country code the search ran against.

InternationalAddressSummaryResponse (v1) | null

The sanitized address inputted in the search.

The company registration (filing) number inputted in the search.

The reference ID inputted in the search.

MatchType | null

Indicates how close the inputted name matches the found business entity.

InternationalAddressMatchType | null

Indicates how close the inputted address matches the found business entity.

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.

date-time
required

The datetime the search was created.

The datetime the search was updated at (generally when the search completed).

Indicates whether the found business was a close enough match to be considered verified.

array | null

An array containing Baselayer's ratings.

Any errors that occurred.

warnings
array of strings
Defaults to []

Any warnings that occurred.

Warnings
options
array of objects

Optional, separately-billed add-ons requested for this search.

Options
Allowed:
InternationalBusinessResponse (v1) | null

A summary of the found business. When the enhanced profile add-on is ordered, this also includes officers, beneficial owners, shareholders, share capital, contact details, and the registered agent, along with fuller registry and tax identifiers and classified business activities.

uri
required
length between 1 and 2083

The API URL to retrieve the search.

Responses

Updated 3 months ago

Did this page help you?
LoadingLoading…

Updated 3 months ago

Did this page help you?