List Verify Runs | Extend Documentation

{
  "object": "list",
  "data": [
    {
      "object": "verify_run",
      "id": "vr_xK9mLPqRtN3vS8wF5hB2cQ",
      "file": {
        "object": "file",
        "id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
        "name": "Invoices.pdf",
        "type": "PDF",
        "parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
        "metadata": {
          "pageCount": 30,
          "parentSplit": {
            "id": "string",
            "type": "Invoice",
            "identifier": "other_2_9",
            "startPage": 1,
            "endPage": 10
          }
        },
        "createdAt": "2024-03-21T16:45:00Z",
        "updatedAt": "2024-03-21T16:45:00Z"
      },
      "status": "PROCESSED",
      "riskLevel": "LOW",
      "failureReason": "string",
      "failureMessage": "string",
      "metadata": {},
      "metrics": {
        "processingTimeMs": 4210,
        "pageCount": 7
      },
      "config": {
        "engine": "verify_agentic",
        "engineVersion": "0.1.0",
        "advancedOptions": {
          "requireParsing": true
        }
      },
      "usage": {
        "credits": 9,
        "totalCredits": 15,
        "breakdown": [
          {
            "object": "parse_run",
            "id": "pr_3UZSj69pYZDKHFuuX57ic",
            "credits": 6,
            "charges": [
              {
                "product": "extraction_performance",
                "unit": "page",
                "quantity": 10,
                "credits": 30
              },
              {
                "product": "review_agent",
                "unit": "page",
                "quantity": 10,
                "credits": 10
              },
              {
                "product": "agentic_text_correction",
                "unit": "page",
                "quantity": 3,
                "credits": 3,
                "pages": [
                  2,
                  4,
                  7
                ]
              }
            ]
          }
        ]
      },
      "source": "API",
      "sourceId": "apireq_Xj8mK2pL9nR4vT7qY5wZ",
      "createdAt": "2024-03-21T16:45:00Z",
      "updatedAt": "2024-03-21T16:45:00Z"
    }
  ],
  "nextPageToken": "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
}

List verify runs, with optional filters for status, source, risk level, and file name.

Returns a paginated list of run summaries, each carrying the run’s riskLevel but not its output. Use GET /verify_runs/{id} to retrieve the signals and evidence for a specific run.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

Query parameters

statusenumOptional

Filter verify runs by status.

Allowed values:

sourceenumOptional

Filter verify runs by the source that created them. If not provided, runs from all sources are returned.

Allowed values:

sourceIdstringOptional

Filter verify runs by sourceId. For API-created runs this is the request ID of the creating request.

riskLevelenumOptional

Return only processed runs whose result has this risk level. A zero-retention run stops matching once its result has been purged.

Allowed values:

fileNameContainsstringOptional

Filters runs by file. A verify run ID (vr_...) matches that run, a file ID (file_...) matches runs on that file, and any other value matches runs whose file name contains it.

Example: "statement"

sortByenumOptionalDefaults to updatedAt

Sort by the given field.

Allowed values:

sortDirenumOptionalDefaults to desc

Sort in ascending or descending order. Ascending order means the earliest result is returned first.

Allowed values:

nextPageTokenstringOptional

The token used to fetch the page of results from a previous request. We use cursor based pagination and will return a nextPageToken in the response if there are more results.

Note that if other parameters are changed in subsequent requests, you may receive inconsistent data.

maxPageSizeintegerOptional1-1000Defaults to 10

The maximum number of results to return in the response. You may receive less than this number if there are fewer results than the maximum.

Response

Successfully retrieved verify runs

objectenum

Allowed values:

datalist of objects

nextPageTokenstringOptional

The token used to fetch the page of results from a previous request. We use cursor based pagination and will return a nextPageToken in the response if there are more results.

Note that if other parameters are changed in subsequent requests, you may receive inconsistent data.

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error