Skip to main content
POST
Start Liens Search

Authorizations

X-API-Key
string
header
required

Headers

Prefer
string | null

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.

Example:

"respond-async"

Body

application/json

Represents a request to initiate a liens search for a business.

business_id
string<uuid>
required

The ID of the business the liens search task should be run against. Mutually exclusive with person_id.

type
string
default:Business
Allowed value: "Business"
search_states
enum<string>[] | null

This is required for individual searches. For business searches, specifies an override list of states for the liens search. If provided, the search will exclusively target liens within these states, irrespective of the business's registered states.

Available options:
AL,
AK,
AZ,
AR,
CA,
CO,
CT,
DE,
DC,
FL,
GA,
HI,
ID,
IL,
IN,
IA,
KS,
KY,
LA,
ME,
MD,
MA,
MI,
MN,
MS,
MO,
MT,
NE,
NV,
NH,
NJ,
NM,
NY,
NC,
ND,
OH,
OK,
OR,
PA,
RI,
SC,
SD,
TN,
TX,
UT,
VT,
VA,
WA,
WV,
WI,
WY,
PR,
VI,
AE,
AA,
AP,
GU,
AS

Response

Response

Represents the response from a liens search request. This includes the unique identifier of the request, the current state of the request, and a list of lien filings associated with the request.

id
string<uuid>
required

The identifier of this liens search response.

search_entities
AdditionalLiensSearchEntityResponse (v1) · object[]
required

A list of entities searched in the liens search.

state
enum<string>
required

The current state of the liens search request.

Available options:
PENDING,
EXECUTING,
COMPLETED,
FAILED,
CANCELLED
filings
LienFilingResponse (v1) · object[]
required

A list of lien filings associated with the search request.

last_updated_at
string<date>
required

The date the lien search result was last updated.

Example:

"2024-06-01"

error
string | null

Any errors that occurred during the liens search request.

Example:

"TimeoutError: The Liens Search could not be completed."

searched_states
enum<string>[] | null

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.

Available options:
AL,
AK,
AZ,
AR,
CA,
CO,
CT,
DE,
DC,
FL,
GA,
HI,
ID,
IL,
IN,
IA,
KS,
KY,
LA,
ME,
MD,
MA,
MI,
MN,
MS,
MO,
MT,
NE,
NV,
NH,
NJ,
NM,
NY,
NC,
ND,
OH,
OK,
OR,
PA,
RI,
SC,
SD,
TN,
TX,
UT,
VT,
VA,
WA,
WV,
WI,
WY,
PR,
VI,
AE,
AA,
AP,
GU,
AS
Example:
business_id
string<uuid> | null

The identifier of the business associated with these lien filings.

Example:

"bc145d0c-aea1-4572-844a-2d11ca1f85c0"

person_id
string<uuid> | null

The identifier of the person associated with these lien filings.

Example:

"9cb64976-4cc4-4f52-8171-ce8744d52333"

business_search_id
string<uuid> | null

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

Example:

"0b8d7416-e62c-420e-a593-7c86f26b1590"