API Reference

Alpha

Verify

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Cancel Verify Job

VerifyCancelResponse alpha().verify().cancel(VerifyCancelParamsparams = VerifyCancelParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

POST/api/alpha/verify/{job_id}/cancel

Cancel a running Verify job.

Stops processing and marks the job as CANCELLED. Returns the updated job. Jobs already in a terminal state (COMPLETED, FAILED, CANCELLED) cannot be cancelled.

ParametersExpand Collapse

VerifyCancelParams params

Optional<String> jobId

Optional<String> organizationId

Optional<String> projectId

ReturnsExpand Collapse

class VerifyCancelResponse:

Response for a Verify job.

String id

Unique identifier

Configuration configuration

Verify configuration used for this job

Optional<String> targetPages

Comma-separated page numbers or ranges to analyze (1-based). Omit to analyze all pages. Ignored for non-PDF inputs.

Optional<Tier> tier

Verify tier: ‘fast’ runs only the quick deterministic forensic checks (metadata, content integrity, container structure, pixel statistics); ‘agentic’ (default) runs the full pipeline including the learned detectors and the semantic review pass.

One of the following:

AGENTIC("agentic")

FAST("fast")

DocumentInputType documentInputType

Type of the document input (FILE)

One of the following:

FILE_ID("file_id")

PARSE_JOB_ID("parse_job_id")

URL("url")

String fileInput

ID of the input file

String projectId

Project this job belongs to

Status status

Current job status: PENDING, RUNNING, COMPLETED, FAILED, or CANCELLED

One of the following:

CANCELLED("CANCELLED")

COMPLETED("COMPLETED")

FAILED("FAILED")

PENDING("PENDING")

RUNNING("RUNNING")

String userId

User who created this job

Optional<LocalDateTime> createdAt

Creation datetime

formatdate-time

Optional<String> errorMessage

Error message if job failed

Optional<Result> result

Result of a Verify (doctored-document) analysis.

Raw per-signal detail (evidence list, per-family sub-scores, raw regions, forensic heatmaps) is available separately via the job’s details endpoint.

String detectorVersion

Version of the detector that produced the result

double overallScore

Overall doctoring likelihood (0 to 1)

maximum1

minimum0

Verdict verdict

Overall verdict for the document

One of the following:

AUTHENTIC("AUTHENTIC")

DOCTORED("DOCTORED")

LIKELY_DOCTORED("LIKELY_DOCTORED")

NO_STRONG_SIGNAL("NO_STRONG_SIGNAL")

SUSPICIOUS("SUSPICIOUS")

Optional<CompositeScores> compositeScores

Composite scores, each answering one question about the document

Optional<AiGenerated> aiGenerated

Was this content synthesized by a generative model?

Optional<Boolean> applicable

Whether the checks feeding this composite ran on this document. When false the document was not checked for this — not cleared of it

Optional<Double> score

Score (0 to 1); null when the composite was not applicable

maximum1

minimum0

Optional<DocumentCoherence> documentCoherence

Does the document’s content agree with itself (checksums, arithmetic, machine-readable zones)?

Optional<Boolean> applicable

Whether the checks feeding this composite ran on this document. When false the document was not checked for this — not cleared of it

Optional<Double> score

Score (0 to 1); null when the composite was not applicable

maximum1

minimum0

Optional<DocumentMetadata> documentMetadata

Does the file’s provenance / toolchain history look suspicious? Advisory: individually weak workflow-hygiene signals

Optional<Boolean> applicable

Whether the checks feeding this composite ran on this document. When false the document was not checked for this — not cleared of it

Optional<Double> score

Score (0 to 1); null when the composite was not applicable

maximum1

minimum0

Optional<KnownFraud> knownFraud

Has this asset (or its template) been seen in fraud before?

Optional<Boolean> applicable

Whether the checks feeding this composite ran on this document. When false the document was not checked for this — not cleared of it

Optional<Double> score

Score (0 to 1); null when the composite was not applicable

maximum1

minimum0

Optional<ManuallyEdited> manuallyEdited

Was this document altered after creation (splice, retype, redact, inpaint)?

Optional<Boolean> applicable

Whether the checks feeding this composite ran on this document. When false the document was not checked for this — not cleared of it

Optional<Double> score

Score (0 to 1); null when the composite was not applicable

maximum1

minimum0

Optional<Recapture> recapture

Was the document captured through a channel that destroys forensic evidence (photo of a screen, print-then-rescan)?

Optional<Boolean> applicable

Whether the checks feeding this composite ran on this document. When false the document was not checked for this — not cleared of it

Optional<Double> score

Score (0 to 1); null when the composite was not applicable

maximum1

minimum0

Optional<Double> confidence

Confidence in the verdict (0 to 1): how firmly the detected signals support the verdict bucket, independent of the doctoring likelihood itself

maximum1

minimum0

Optional<String> error

Error detail when the analysis could not complete

Optional<Long> pageCount

Number of analysed pages (1 for images/docx)

minimum1

Optional<List<PageDimension>> pageDimensions

Rendered pixel size per page, so region bboxes can be scaled onto the page

long height

Rendered page height in pixels

long page

0-based page index (0 for standalone images)

long width

Rendered page width in pixels

Optional<String> reasoning

Explanation of the verdict

Optional<List<SuspectRegion>> suspectRegions

Regions that led to the suspected fraud, ranked most-suspect first, each with an explanation of what makes it suspect

List<long> bbox

Region bounding box as [x, y, w, h] in page-render pixels

String explanation

Human-readable explanation of what makes this region suspect

String kind

Kind of anomaly detected in this region

long page

0-based page index (0 for standalone images)

double score

Suspicion score for this region (0 to 1)

maximum1

minimum0

String source

Detector that flagged this region

Optional<Boolean> primary

Whether this region is part of the small set of decisive evidence behind the verdict — the boxes a reviewer should look at first

Optional<String> review

Automated reviewer verdict for this region (confirmed, dismissed, unsure, or empty). A dismissed region can still be surfaced when it is the only place to look; this label says how to read it

Optional<Double> syntheticScore

Likelihood (0 to 1) that the document is wholly generated or fabricated rather than a capture of a real document. Null for jobs completed before this score was introduced

maximum1

minimum0

Optional<Double> tamperingScore

Likelihood (0 to 1) that a real captured document was locally edited — a genuine capture with regions altered after the fact. Null for jobs completed before this score was introduced

maximum1

minimum0

Optional<String> transactionId

Idempotency key

Optional<LocalDateTime> updatedAt

Update datetime

formatdate-time

Cancel Verify Job

Java

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

package ai.llamaindex.llamacloud.example;

import ai.llamaindex.llamacloud.client.LlamaCloudClient;
import ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;
import ai.llamaindex.llamacloud.models.alpha.verify.VerifyCancelParams;
import ai.llamaindex.llamacloud.models.alpha.verify.VerifyCancelResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();

        VerifyCancelResponse response = client.alpha().verify().cancel("job_id");
    }
}

200 example

{
  "id": "id",
  "configuration": {
    "target_pages": "1,3,5-7",
    "tier": "agentic"
  },
  "document_input_type": "file_id",
  "file_input": "file_input",
  "project_id": "project_id",
  "status": "CANCELLED",
  "user_id": "user_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "error_message": "error_message",
  "result": {
    "detector_version": "detector_version",
    "overall_score": 0,
    "verdict": "AUTHENTIC",
    "composite_scores": {
      "ai_generated": {
        "applicable": true,
        "score": 0
      },
      "document_coherence": {
        "applicable": true,
        "score": 0
      },
      "document_metadata": {
        "applicable": true,
        "score": 0
      },
      "known_fraud": {
        "applicable": true,
        "score": 0
      },
      "manually_edited": {
        "applicable": true,
        "score": 0
      },
      "recapture": {
        "applicable": true,
        "score": 0
      }
    },
    "confidence": 0,
    "error": "error",
    "page_count": 1,
    "page_dimensions": [
      {
        "height": 0,
        "page": 0,
        "width": 0
      }
    ],
    "reasoning": "reasoning",
    "suspect_regions": [
      {
        "bbox": [
          0,
          0,
          0,
          0
        ],
        "explanation": "explanation",
        "kind": "kind",
        "page": 0,
        "score": 0,
        "source": "source",
        "primary": true,
        "review": "review"
      }
    ],
    "synthetic_score": 0,
    "tampering_score": 0
  },
  "transaction_id": "transaction_id",
  "updated_at": "2019-12-27T18:11:19.117Z"
}

Returns Examples

200 example

{
  "id": "id",
  "configuration": {
    "target_pages": "1,3,5-7",
    "tier": "agentic"
  },
  "document_input_type": "file_id",
  "file_input": "file_input",
  "project_id": "project_id",
  "status": "CANCELLED",
  "user_id": "user_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "error_message": "error_message",
  "result": {
    "detector_version": "detector_version",
    "overall_score": 0,
    "verdict": "AUTHENTIC",
    "composite_scores": {
      "ai_generated": {
        "applicable": true,
        "score": 0
      },
      "document_coherence": {
        "applicable": true,
        "score": 0
      },
      "document_metadata": {
        "applicable": true,
        "score": 0
      },
      "known_fraud": {
        "applicable": true,
        "score": 0
      },
      "manually_edited": {
        "applicable": true,
        "score": 0
      },
      "recapture": {
        "applicable": true,
        "score": 0
      }
    },
    "confidence": 0,
    "error": "error",
    "page_count": 1,
    "page_dimensions": [
      {
        "height": 0,
        "page": 0,
        "width": 0
      }
    ],
    "reasoning": "reasoning",
    "suspect_regions": [
      {
        "bbox": [
          0,
          0,
          0,
          0
        ],
        "explanation": "explanation",
        "kind": "kind",
        "page": 0,
        "score": 0,
        "source": "source",
        "primary": true,
        "review": "review"
      }
    ],
    "synthetic_score": 0,
    "tampering_score": 0
  },
  "transaction_id": "transaction_id",
  "updated_at": "2019-12-27T18:11:19.117Z"
}