API Reference
API Reference

BusinessSearch.submitted

wbhk
BusinessSearch.submitted

Emitted when a Business search has been submitted for processing.

Payload
__event__
object
Defaults to [object Object]
uuid
required

The unique identifier of the search.

options
array of strings
required

Optional features enabled during search execution.

Options*
Allowed:
orderables
array of objects
Defaults to []

A list of associated requests that were made as a result of ordering optional features through the options when the search was submitted. This allows you to correlate associated operations that will complete asynchronously once the search is completed. For example, if you order Website Analysis when issuing the search you will have a corresponding WebsiteAnalysisRequest orderable containing the ID and URL of the forthcoming associated operations.

Orderables
UserAttributionResponse (v1) | null

Details on the User who performed the search.

string
enum
required

The current state of the search.

Allowed:
string
required

The name inputted in the search.

string
required

The address string inputted in the search.

AddressSummaryResponse (v1) | null

The sanitized address inputted in the search.

array | null

The officer names inputted in the search.

array | null

The alternative names inputted in the search.

The website inputted in the search.

The phone number inputted in the search.

The email inputted in the search.

The TIN/EIN inputted in the search.

The reference ID inputted in the search.

Indicates whether the inputted TIN/EIN was a match, per the IRS. If a TIN is submitted with the search, and a response of null is returned, this indicates that the IRS validation service is currently having a temporary outage. Please see status.baselayer.com for status updates.

IRSTINMatchType | null

The type of match that occurred.

deprecated

If the inputted TIN/EIN was not a match, but is a real TIN/EIN, this field returns the name of the entity to whom that TIN/EIN actually belongs.

watchlist_hits
array of objects
Defaults to []

The watchlist hits associated with the searched business.

Watchlist Hits
MatchType | null

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

AddressMatchType | null

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

MatchType | null

Indicates how close the inputted officer name matches the found business officers.

MatchType | null

Indicates how close the inputted officer name matches the found business registered agent.

Does the inputted website match the found business website?

Indicates whether the website match was established via a cross-domain redirect. True when business_website_match is True and the match was found because one website redirects to the other's domain.

AddressValidationLevel | null

The validation level derived during address normalization.

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
BusinessResponse (v1) | null

A representation of the Business identified by the Search.

uri
required
length between 1 and 2083

The API URL to retrieve the search.

uri
required
length between 1 and 2083

The API URL to retrieve the status of the search.

required
length between 1 and 2083

The API URL to retrieve the business details.

uri
length between 1 and 2083

The URL to the search details in the console.

Responses

Updated 3 months ago

Did this page help you?
LoadingLoading…

Updated 3 months ago

Did this page help you?