v1

latestOpenAPI 3.1.02026-07-241695611.0 MB

Lien Search

Get Liens Search Status

This endpoint retrieves the status of a specific lien search request by its unique identifier. It returns a LiensSearchState object that includes the state of the request.

get/lien_searches/{liens_search_request_id}/status

Path parameters

liens_search_request_idstring uuid required

The unique identifier of the liens search request.

Example:56f06be8-475b-4a5d-86af-ae620fcfeaeb

The unique identifier of the liens search request.

Response

Successful Response

idstring uuid required

The identifier of this liens search response.

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

errorstring nullable

Any errors that occurred during the liens search request.

last_updated_atstring date required

The date the lien search result was last updated.

searched_statesStateAbbreviation[] nullable

Indicates the list of states specified in the liens search request. When states are provided, the search was limited to liens within these specified states, regardless of the business's registered states.

person_idstring uuid nullable

The identifier of the person associated with these lien filings.

business_idstring uuid nullable

The identifier of the business associated with these lien filings.

business_search_idstring uuid nullable

The identifier of the business search associated with these lien filings.

Example response

{
  "error": "TimeoutError: The Liens Search could not be completed.",
  "last_updated_at": "2024-06-01",
  "searched_states": [
    "CA",
    "GA"
  ],
  "person_id": "f87e0009-5d0b-4d6c-934d-3c3cdaa80b6c",
  "business_id": "85f91a95-9dfb-4692-a3cf-7e5b24a80254",
  "business_search_id": "fabc43a5-9ffa-445b-9659-70970613c823"
}