Post International Search

post

https://api.baselayer.com/international/searches

Create a new international business search.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Represents an international business search request.

name

length between 1 and 500

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

address

length between 2 and 500

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

iso2_country_code

string

enum

required

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

filing_number

length between 1 and 128

The company registration (filing) number to search for — for example the filing_number of a result picked from GET /international/registrations. 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/address matching is skipped and the match fields stay null.

officer_names

array | null

The officer names to include in the search.

website

The website to include in the search.

phone_number

The phone number to include in the search.

The email to include in the search.

alternative_names

array | null

The alternative names to include in the search.

reference_id

length ≤ 128

An optional reference ID to associate with the search request.

options

array of objects

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

Options

Allowed:

Headers

Prefer

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.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/vnd.baselayer.v1+json

201Response

422Validation Error