GET /v1/batch/{jobId}

Path parameters

Parameter Type Description
jobId string Batch job ID returned from POST /v1/batch

Response

{
  "id": "job_01HXYZ123",
  "status": "done",
  "type": "email",
  "total_rows": 1000,
  "processed_rows": 1000,
  "result_url": "https://api.checkharbor.com/v1/batch/job_01HXYZ123/download?sig=...",
  "created_at": "2024-06-11T10:00:00Z"
}
Field Type Description
id string Job ID
status enum queued processing done failed
type enum email phone ip
total_rows integer Total rows in CSV
processed_rows integer Rows processed so far
result_url string | null Signed download URL when status=done
created_at string ISO 8601 timestamp

Example

    curl https://api.checkharbor.com/v1/batch/job_01HXYZ123 \
      -H "X-Api-Key: chk_live_..."
    ```

    // One-shot poll
    const job = await checkharbor.batch.get("job_01HXYZ123");
// Wait until done (polls automatically)
const done = await checkharbor.batch.waitUntilDone("job_01HXYZ123", {
  pollMs: 3000,
  timeoutMs: 600_000,
});
```




    # One-shot poll
    job = client.batch.get("job_01HXYZ123")
# Wait until done (polls automatically)
done = client.batch.wait_until_done("job_01HXYZ123", poll_seconds=3, timeout_seconds=600)
```