v1

latestOpenAPI 3.1.02026-07-241695611.0 MB

Consortium

Post Consortium Search Batch

Submit a CSV of consortium searches (one search per row, one of each identifier). Always processed asynchronously (202 + batch id); poll GET /consortium/searches/batches/{batch_id} and download per-row results via /consortium/searches/batches/{batch_id}/download. Batches are capped at 40,000 rows. Allowed columns: reference_id, ein, phone, email, website, business_name, officer_first_name, officer_last_name, officer_state, address_street, address_city, address_state, address_zip, business_id.

post/consortium/searches/batches

Response

Successful Response

idstring uuid required

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

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

progressnumber nullable

Fraction of entries processed so far, in [0, 1].

completed_countinteger nullable

Number of entries processed so far.

total_countinteger nullable

Total number of entries in the batch.

created_atstring date-time required

When the batch was accepted.

Example response

{
  "total_count": 100
}