Sign in

v1

latestOpenAPI 3.1.02026-07-241695611.0 MB
Search

Get Search Batch

Retrieve a SearchBatch by ID and return it in SearchBatchResponse format.

get/searches/batch/{id}

Path parameters

idstring uuid required

The unique identifier of the search batch to retrieve searches for.

Example:a3c16db9-52f0-4f67-9ce3-0fae6f9f3f31

The unique identifier of the search batch to retrieve searches for.

Response

Successful Response

idstring uuid required

Unique identifier for the business search batch.

namestring required

The name of the business search batch.

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

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

completed_countinteger nullable

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

total_countinteger nullable

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

created_atstring date-time required

The datetime the business search batch was created.

optionsstring[]

Optional features to enable during business search execution.

warningsstring[]

Any warnings that occurred.

export_csv_uristring nullable

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

export_jsonl_uristring nullable

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

report_versioninteger nullable

Report schema version. Available after batch completion.

Example response

{
  "options": [
    "Order.WebsiteAnalysis"
  ],
  "questionnaire": {
    "kyb": {
      "current_provider": "Middesk",
      "new_applications_per_month": 500,
      "avg_uw_time_hours": 24,
      "avg_uw_time_minutes": 2,
      "match_rate_pct": 25,
      "approval_rate_pct": 72
    },
    "web_presence": {
      "current_provider": "Built in-house"
    },
    "liens": {
      "current_provider": "LexisNexis"
    },
    "litigations": {
      "current_provider": "LexisNexis"
    }
  }
}