Skip to main content
POST
Post International Search

Authorizations

X-API-Key
string
header
required

Headers

Idempotency-Key
string | null

An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked Idempotent-Replayed: true, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource.

Prefer
string | null

Request execution preference (RFC 7240). Use respond-async for asynchronous execution, wait=N to specify a synchronous timeout hint in seconds, or priority=low to route the task to the low-priority queue.

Example:

"respond-async"

Body

application/json

Represents an international business search request.

iso2_country_code
enum<string>
required

The ISO 2 country code of the business to search for.

Available options:
AU,
AT,
BH,
BE,
BA,
BR,
BN,
KH,
CA,
CN,
CO,
HR,
CW,
CY,
CZ,
DK,
DO,
EE,
FI,
FR,
GF,
PF,
GE,
DE,
GI,
GR,
GP,
GG,
HK,
IS,
IE,
IM,
IL,
IT,
JP,
LV,
LI,
LT,
LU,
MY,
MH,
MQ,
YT,
ME,
NL,
NC,
NZ,
NO,
OM,
PK,
PA,
PE,
PL,
PT,
QA,
RE,
RO,
RU,
BL,
PM,
WS,
SG,
SK,
SI,
SB,
ES,
SE,
CH,
TW,
TT,
UG,
GB,
UY,
VI,
VU,
WF
Example:

"GB"

name
string | null

The name of the business to search for. Required (together with address) unless filing_number is provided.

Required string length: 1 - 500
Example:

"White, Floyd and Cook"

address
string | null

The address of the business to search for. Required (together with name) unless filing_number is provided.

Required string length: 2 - 500
Example:

"1 Parliament St, London SW1A 2JR, United Kingdom"

filing_number
string | null

The company registration (filing) number at the country's registry. When provided, the registry is searched by this number first; a name (if also provided) is used as a fallback when no company matches the number. A filing_number with iso2_country_code is a complete request on its own. Name and address may each be supplied independently. Provided inputs contribute to KYB/Risk scores; omitted name or address inputs are excluded from matching and scoring.

Required string length: 1 - 128
Example:

"09517735"

officer_names
string[] | null

The officer names to include in the search.

Example:
website
string | null

The website to include in the search.

Example:

"https://www.figueroa.com/"

phone_number
string | null

The phone number to include in the search.

Example:

"436-502-9710"

email
string | null

The email to include in the search.

Example:

"zacharymoore@example.com"

alternative_names
string[] | null

The alternative names to include in the search.

Example:
reference_id
string | null

An optional reference ID to associate with the search request.

Maximum string length: 128
Example:

"Search1234"

options
enum<string>[]

Optional, separately-billed add-ons to enable for this search.

Available options:
Order.Pep,
Order.Enhanced
Example:

Response

Response

Response model for international business search.

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-10-29T05:44:48.205317"

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"

country_name
string | null
required

The display name of iso2_country_code, as GET /international/countries names it.

Example:

"United Kingdom"

user
UserAttributionResponse (v1) · object | null

Details on the User who performed the search.

idempotency_key
string | null

The Idempotency-Key header the request that created this resource carried, if any.

name
string | null

The name inputted in the search (null when omitted).

Example:

"Acme Corporation"

address
string | null

The address string inputted in the search (null when omitted).

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,
BH,
BE,
BA,
BR,
BN,
KH,
CA,
CN,
CO,
HR,
CW,
CY,
CZ,
DK,
DO,
EE,
FI,
FR,
GF,
PF,
GE,
DE,
GI,
GR,
GP,
GG,
HK,
IS,
IN,
IE,
IM,
IL,
IT,
JP,
KE,
LV,
LI,
LT,
LU,
MY,
MH,
MQ,
YT,
MX,
ME,
NL,
NC,
NZ,
NG,
NO,
OM,
PK,
PA,
PE,
PL,
PT,
QA,
RE,
RO,
RU,
BL,
PM,
WS,
SA,
SG,
SK,
SI,
SB,
ES,
SE,
CH,
TW,
TT,
TR,
UG,
UA,
GB,
UY,
VI,
VU,
WF
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. Null when this input was omitted.

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. Null when this input was omitted.

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 or the lookup was unavailable.

Example:

true

updated_at
string<date-time> | null

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

Example:

"2026-10-29T05:44:48.205334"

verified
boolean | null

True when the KYB grade is A or B. A filing-number mismatch reduces the score but does not independently block verification.

Example:

true

scores
ScoreResponse (v1) · object[] | null

An array containing Baselayer's ratings.

watchlist_hits
WatchlistHitResponse (v1) · object[]

Persisted watchlist screening results for this search. A source with count zero completed screening without matches. An absent source does not indicate a completed or clean screen.

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.Pep,
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.