v1

latestOpenAPI 3.1.02026-07-241695611.0 MB

Get Task Status

Retrieve the status of a business search by ID.

get/searches/{id}/status

Path parameters

idstring uuid required

The unique identifier of the search to retrieve the status for.

Example:412a49b5-7466-426b-bf1e-081b00b54576

The unique identifier of the search to retrieve the status for.

Response

Successful Response

idstring uuid required

Unique identifier for the business search.

state'PENDING' | 'EXECUTING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' required

errorstring nullable

Any errors that occurred.

warningsstring[]

Any warnings that occurred.

business_urlstring uri nullable

The API URL to retrieve the business details.

console_urlstring uri required

The URL to the business search details in the console.

Example response

{
  "error": "RuntimeError The Business Search could not be completed.",
  "warnings": [
    "IRS Validation is unavailable."
  ],
  "business_url": "https://api.baselayer.com/businesses/ae752082-1f7e-11ef-b572-1edb1b067314",
  "console_url": "https://console.baselayer.com/search/c06777fe-1f7e-11ef-af7e-1edb1b067314"
}