Post Search

post

https://api.baselayer.com/searches

Create a new business search.

Supports both the legacy Accept: application/vnd.osiris.sync+json header (v1 backward compatibility) and the new Prefer header (RFC 7240) for controlling sync/async execution. When both are present, Prefer takes precedence.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Represents a business search request.

name

string

required

length between 1 and 500

The name of the business to search for.

address

string

required

length between 2 and 500

The address of the business to search for.

officer_names

array | null

The officer names to include in the search.

website

length ≥ 1

The website to include in the search.

phone_number

length ≤ 24

The phone number to include in the search.

length ≤ 64

The email to include in the search.

alternative_names

array | null

The alternative names to include in the search.

tin

length between 9 and 9

The TIN/EIN to search for.

options

array of objects

Defaults to []

Optional features to enable during search execution.

Options

reference_id

length ≤ 128

An optional reference ID to associate with the search request.

Headers

Prefer

Request execution preference (RFC 7240). Use respond-async for asynchronous execution, or wait=N to specify a synchronous timeout hint in seconds. When present, takes precedence over the legacy Accept header sync flag.

The MIME type of the response to accept.

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