File Processing

Get file verification job status

Check the status and progress of a file verification job. Supports long-polling with the timeout parameter. File job statuses are exhaustively enumerated as preparing, pending, running, processing, merging, paused, completed, completed_with_warning, failed, and cancelled.

get/v1/verify/file/{job_id}

Request

  • Base URL: https://api.billionverify.com
  • URL: https://api.billionverify.com/v1/verify/file/{job_id}
  • Auth: API key in header BV-API-KEY

Path parameters

job_idstring uuid required

The job ID returned from file upload

Query parameters

timeoutinteger

Long-polling timeout in seconds (0-300). If set, the request will wait until job completes or timeout.

Response

Job status retrieved

successboolean
codestring
messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.