Get candidate verification batch

get_candidate_verification_batch Read batch progress, individual job observations and reserved, consumed and released check units. Unknown observations do not establish absence.

Available in the deployed MCP and HTTP bundle. Confirm access and inputs with your connected catalog. Workspace scopes and enabled providers still apply.

Access	Behavior
`discovery:read`, `watches:read`	Reads saved data

This read does not start a verification job.

Example request

Connect through MCP, CLI, or HTTP. Replace example identifiers with records from your workspace.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_candidate_verification_batch",
    "arguments": {
      "batchId": "batch_example"
    }
  }
}

agentlinkops call get_candidate_verification_batch --args '{"batchId":"batch_example"}'

curl "$AGENTLINKOPS_API_URL/v1/commands/get_candidate_verification_batch" \
  -H "Authorization: Bearer $AGENTLINKOPS_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{"batchId":"batch_example"}'

Returned result

Illustrative data validated against the documented response schema. IDs and dates are examples, not a live account capture. MCP returns this data in structuredContent and in a text content block; generic HTTP and CLI return the JSON result directly.

Full response example

{
  "schema_version": 1,
  "id": "batch_example",
  "workspace_id": "ws_example",
  "project_id": "pr_example",
  "run_id": "dr_example",
  "created_at": "2026-09-13T12:00:00.000Z",
  "state": "pending",
  "counts": {
    "rejected": 0,
    "queued": 1,
    "running": 0,
    "succeeded": 0,
    "failed": 0,
    "cancelled": 0
  },
  "items": [
    {
      "ordinal": 0,
      "candidate_id": "dc_bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
      "local_reference": "ledger:example",
      "job_id": "job_example",
      "watch_id": "watch_example",
      "state": "queued",
      "error_code": null,
      "observation": null,
      "usage": {
        "unit": "source_check",
        "units": 1,
        "state": "reserved",
        "period": "2026-09"
      }
    }
  ],
  "reservation": {
    "units": 1,
    "outstanding": 1,
    "consumed": 0,
    "released": 0,
    "period": "2026-09"
  },
  "recurring_monitoring_created": false
}

Response formats

format selects the row shape. detailed is the example above: every field. concise keeps, per row: ordinal, candidate_id, local_reference, job_id, watch_id, state, error_code, observation, usage; every top-level field (cursors, counts, coverage, metadata) is kept in both. The observation state an unknown-versus-absent decision depends on is never dropped. MCP and code mode default to concise; the CLI and HTTP default to detailed; the response names the default it applied in defaults_applied.

Input fields

Omit optional fields when you do not want to supply them. Null is accepted only where listed. Unknown input properties are rejected.

Field	Type	Presence	Meaning and constraints
`batchId`	string	Required	Identifier of the batch returned by its create or list operation. pattern: ”^[a-zA-Z0-9_-]{1,128}$“
`format`	string	Optional	Response shape: concise keeps the fields needed to decide and to call next (the evidence state always included); detailed returns every field. MCP and code mode default to concise; REST and the CLI to detailed. The response names the default it applied in defaults_applied. values: “concise”, “detailed”

Validation and omitted values

Inspect per-item state, observation and reservation totals even when the aggregate batch is completed or partial.

Output fields

Fields inside optional or nullable parents apply only when that parent exists. Common schema conventions explain evidence states, empty lists and extensions.

schema_version (number, required): must equal 1
id (string, required): Resource identifier returned by the operation.
workspace_id (string, required): Workspace that owns this record.
project_id (string, required): Project that owns this record.
run_id (string, required): Identifier returned by the related operation.
state (string, required): Saved lifecycle or evidence state, as enumerated for this record. values: “pending”, “completed”, “partial”, “failed”
counts (object, required): additional fields rejected
items (array, required): Records in this bounded page. minItems: 1; maxItems: 50
reservation (object / null, required).
replayed (boolean, optional): True when the response reuses an earlier request with the same idempotency value.
recurring_monitoring_created (boolean, required): Whether this operation enrolled recurring monitoring. must equal false
created_at (string, required): UTC timestamp when the record was created.

All fields and nested objects

Field	Type	Presence	Meaning and constraints
`schema_version`	number	Required	must equal 1
`id`	string	Required	Resource identifier returned by the operation.
`workspace_id`	string	Required	Workspace that owns this record.
`project_id`	string	Required	Project that owns this record.
`run_id`	string	Required	Identifier returned by the related operation.
`state`	string	Required	Saved lifecycle or evidence state, as enumerated for this record. values: “pending”, “completed”, “partial”, “failed”
`counts`	object	Required	additional fields rejected
`counts.rejected`	integer	Required	minimum: 0; maximum: 9007199254740991
`counts.queued`	integer	Required	minimum: 0; maximum: 9007199254740991
`counts.running`	integer	Required	minimum: 0; maximum: 9007199254740991
`counts.succeeded`	integer	Required	minimum: 0; maximum: 9007199254740991
`counts.failed`	integer	Required	minimum: 0; maximum: 9007199254740991
`counts.cancelled`	integer	Required	minimum: 0; maximum: 9007199254740991
`items`	array	Required	Records in this bounded page. minItems: 1; maxItems: 50
`items[].ordinal`	integer	Required	minimum: 0; maximum: 9007199254740991
`items[].candidate_id`	string	Required	Identifier returned by the related operation.
`items[].local_reference`	string / null	Required	Customer reference for joining this record to a local ledger entry.
`items[].job_id`	string / null	Required	Identifier returned by the related operation.
`items[].watch_id`	string / null	Required	Identifier returned by the related operation.
`items[].state`	string	Required	Saved lifecycle or evidence state, as enumerated for this record. values: “rejected”, “queued”, “running”, “succeeded”, “failed”, “cancelled”
`items[].error_code`	string / null	Required	Latest delivery detail code; null when no failure or retry has been recorded.
`items[].observation`	object / null	Required
`items[].observation.id`	string	Required	Resource identifier returned by the operation.
`items[].observation.state`	string	Required	Saved lifecycle or evidence state, as enumerated for this record.
`items[].observation.reason`	string / null	Required	Recorded explanation; null when no explanation applies.
`items[].observation.checked_at`	string	Required	UTC timestamp of the saved check.
`items[].usage`	object / null	Required
`items[].usage.unit`	string	Required	must equal “source_check”
`items[].usage.units`	number	Required
`items[].usage.state`	string	Required	Saved lifecycle or evidence state, as enumerated for this record.
`items[].usage.period`	string	Optional
`reservation`	object / null	Required
`reservation.units`	integer	Required	minimum: 0; maximum: 9007199254740991
`reservation.outstanding`	integer	Required	minimum: 0; maximum: 9007199254740991
`reservation.consumed`	integer	Required	minimum: 0; maximum: 9007199254740991
`reservation.released`	integer	Required	minimum: 0; maximum: 9007199254740991
`reservation.period`	string	Required
`replayed`	boolean	Optional	True when the response reuses an earlier request with the same idempotency value.
`recurring_monitoring_created`	boolean	Required	Whether this operation enrolled recurring monitoring. must equal false
`created_at`	string	Required	UTC timestamp when the record was created.

Download input schema · Download output schema

Errors and retries

The command is annotated idempotent. Reuse an accepted idempotency key when the input provides one; changing the payload under a reused key can conflict. See error recovery for status, scope, cooldown, cursor and retry handling. Unknown observations are result data and do not establish loss.

HTTP resource routes

These existing resource routes share the operation’s domain behavior. Their parameter placement, status and response envelope can differ from generic invocation. See HTTP route details.

Method and route	Success	Details
`GET /v1/discovery/verification-batches/{batchId}`	200	Remaining read arguments go in query parameters.

Continue

monitor_discovery_candidate Follow the related workflow, inspect capability status, or return to the command index.

Overview

MCP, CLI and API commands

CLI client

HTTP and events

Optional local workflows

Get candidate verification batch

Example request

Returned result

Response formats

Input fields

Validation and omitted values

Output fields

Errors and retries

HTTP resource routes

Continue

​Example request

​Returned result

​Response formats

​Input fields

​Validation and omitted values

​Output fields

​Errors and retries

​HTTP resource routes

​Continue

Example request

Returned result

Response formats

Input fields

Validation and omitted values

Output fields

Errors and retries

HTTP resource routes

Continue