SearchBatch.updated

Emitted when a search batch's downloadable results have been regenerated. A batch's CSV/JSONL/ZIP export and report are a snapshot taken when the batch finished, while some TIN (EIN) verifications were still resolving with the IRS; once those verdicts land the files are rewritten in place with the final results and this event is sent. The payload carries the batch's new exports_generated_at; re-download the export to pick up the change. The export URLs themselves are stable, so a cached copy is what goes stale, not the link.

Payload
__event__
object
Defaults to [object Object]
uuid
required

Unique identifier for the business search batch.

string
required

The name of the business search batch.

string
enum
required

The current state of the business search batch.

Allowed:
0 to 1

Processing progress from 0.0 to 1.0. Null if not yet started.

≥ 0

Number of rows that have been processed. Null if not yet started.

≥ 0

Total number of rows to process. Null if not yet started.

date-time
required

The datetime the business search batch was created.

options
array of strings
Defaults to []

Optional features to enable during business search execution.

Options
Allowed:
warnings
array of strings
Defaults to []

Any warnings that occurred.

Warnings

GCS URI for the pre-computed CSV export. Available after batch completion.

GCS URI for the pre-computed JSONL export. Available after batch completion.

Report schema version. Available after batch completion.

When the export artifacts above were generated. Null until the batch first exports. This moves forward whenever the exports are regenerated because late TIN verdicts changed the results, so compare it against the value you last downloaded to tell whether your copy is current.

integer
≥ 0
Defaults to 0

How many of this batch's searches have concluded still awaiting a TIN verification verdict from the IRS AND will be retried to get one. A positive count means the exports are provisional: those rows report a pending TIN status today, and the files and report will be regenerated once the verdicts land. Zero means nothing is left to retry, so the exports will not change again on their own — it does NOT mean every TIN was verified. Rows whose retries ran out, or whose program has TIN-match retries switched off, leave this count without an answer; tin_matching_unresolved_count reports those. A search that is still running is in neither count, because its TIN match has not been attempted to a conclusion yet — so on a batch that has not reached COMPLETED, both counts can read zero with verifications still to come.

integer
≥ 0
Defaults to 0

How many of this batch's searches supplied a TIN, finished without a verification verdict, and will not be retried for one — the retry attempts were used up, the program has TIN-match retries switched off, the search was cancelled, or it was made against a sandbox application. These rows are final at a non-matched status: waiting longer will not change them, and re-submitting the search is the only way to try again. Counted alongside tin_matching_pending_count rather than folded into it, because a batch can settle (pending zero) with unresolved rows still in it. A search that has not finished is in neither count — nothing has been given up on yet — so both reading zero on a batch that is still running does not mean every TIN was verified.

DataTestQuestionnaire | null

Data-test questionnaire answers submitted with the batch, if any.

Responses

LoadingLoading…