Skip to main content
GET
Get Lien Filing Import Batch

Authorizations

X-API-Key
string
header
required

Path Parameters

batch_id
string<uuid>
required

The unique identifier of the bulk lien import batch.

Example:

"2a5c08dc-b9c1-43e2-ab85-a90180ad8c42"

Response

Successful Response

A bulk lien import (ENG-6884) — returned when one is accepted, by the polling endpoint, and as the payload of its completion/failure webhooks.

The four outcome counts partition the rows processed so far: every completed row is exactly one of imported / already imported / not found / invalid.

id
string<uuid>
required

The batch's id, used to poll status and fetch per-row results.

name
string
required

The name of the batch, taken from the uploaded file.

Example:

"q3-portfolio-liens.csv"

state
enum<string>
required

Processing state of the batch.

Available options:
PENDING,
EXECUTING,
COMPLETED,
FAILED,
CANCELLED
Example:

"PENDING"

total_count
integer
required

Rows read from the uploaded CSV, excluding blank lines.

Example:

100

created_at
string<date-time>
required

When the batch was accepted.

completed_count
integer
required
read-only

Rows processed so far, whatever their outcome — the sum of the four outcome counts.

Examples:

0

50

progress
number
required
read-only

Fraction of the uploaded rows processed so far, in [0, 1].

Examples:

0

0.5

1

imported_count
integer
default:0

Rows that resolved against the public record and produced a newly imported filing.

Example:

80

already_imported_count
integer
default:0

Rows naming a lien the organization had already imported; the existing filing is kept.

Example:

15

not_found_count
integer
default:0

Rows whose state and filing number matched nothing in the public record.

Example:

4

invalid_row_count
integer
default:0

Rows rejected before resolution (unparseable state, blank filing number, and the like).

Example:

1

error
string | null

Why the batch last failed, as a human-readable message. Set when the state is FAILED; a batch that failed once and succeeded on a resume can still carry the message from that attempt, so read it alongside the state rather than as a failure signal on its own.

Example:

"The uploaded CSV could not be read from storage."