Skip to main content
WEBHOOK

Body

application/json
id
string<uuid>
required

Unique identifier for the international business search.

state
enum<string>
required

The current state of the search.

Available options:
PENDING,
EXECUTING,
COMPLETED,
FAILED,
CANCELLED
created_at
string<date-time>
required

The datetime the search was created.

Example:

"2026-08-31T10:31:07.837093"

url
string<uri>
required

The API URL to retrieve the search.

Required string length: 1 - 2083
Example:

"https://api.baselayer.com/searches/c623e29e-1f57-11ef-938f-1edb1b067314"

__event__
WebhookMetadata · object
user
UserAttributionResponse (v1) · object | null

Details on the User who performed the search.

name
string | null

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

Example:

"Acme Corporation"

address
string | null

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

Example:

"1640 Riverside Drive, Hill Valley, CA"

iso2_country_code
enum<string> | null

The ISO 2 country code the search ran against.

Available options:
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
Example:

"GB"

search_address
InternationalAddressSummaryResponse (v1) · object | null

The sanitized address inputted in the search.

filing_number
string | null

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

Example:

"09517735"

reference_id
string | null

The reference ID inputted in the search.

Example:

"Search1234"

business_name_match
enum<string> | null

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

Available options:
NO_MATCH,
SIMILAR,
EXACT
Example:

"EXACT"

business_address_match
enum<string> | null

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

Available options:
NO_MATCH,
REGION,
CITY,
COUNTRY,
EXACT
Example:

"EXACT"

filing_number_match
boolean | null

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.

Example:

true

updated_at
string<date-time> | null

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

Example:

"2026-08-31T10:31:07.837103"

verified
boolean | null

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

Example:

true

scores
ScoreResponse (v1) · object[] | null

An array containing Baselayer's ratings.

error
string | null

Any errors that occurred.

warnings
string[]

Any warnings that occurred.

Example:

"Address validation is unavailable."

options
enum<string>[]

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

Available options:
Order.Enhanced
Example:
business
InternationalBusinessResponse (v1) · object | 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.

Response

Successful Response