RunsGet one run

Get one run

Detail shape - includes checks, reviews, and the decision fields.

Pass ?view=report to replace the response body with the report's content model: the same document GET /v1/runs/{id}/report.pdf is printed from, before rendering. Use it to display results in your own UI without parsing a PDF.

curl -X GET "https://api.deepvue.link/v1/runs/123e4567-e89b-12d3-a456-426614174000?view=report" \
  -H "Content-Type: application/json" \
  -H "client-id: YOUR_API_KEY" \
  -H "x-api-key: YOUR_API_KEY"
{
  "id": "1e30a341-cb3b-48b8-9992-99a1b436b8d9",
  "workflow_id": "e97e7d78-4ceb-4283-8080-5c5e0b72ddac",
  "reference_id": "user_123",
  "status": "completed",
  "started_at": "2026-07-30T09:14:02Z",
  "completed_at": "2026-07-30T09:16:41Z",
  "action_required": null,
  "checks": [
    {
      "key": "pan",
      "label": "PAN verification",
      "status": "passed",
      "data": {
        "valid": true,
        "name_on_pan": "ANUJ RAWAT"
      }
    },
    {
      "key": "eaadhaar",
      "label": "e-Aadhaar",
      "status": "passed",
      "data": {
        "name": "ANUJ RAWAT",
        "dob": "1995-04-12"
      }
    },
    {
      "key": "face_match",
      "label": "Face match",
      "status": "passed",
      "data": {
        "match": true,
        "score": 0.94
      }
    }
  ],
  "decision": null,
  "resolved_at": null,
  "error": null
}
GET
/v1/runs/{id}
GET
Base URLstring

Target server for requests. Edit to use your own host.

API Key (header: client-id)
client-idstring
Required

Your Deepvue client identifier.

Your Deepvue client identifier.
API Key (header: x-api-key)
x-api-keystring
Required

Your Deepvue API key. Secret - keep it server-side.

Your Deepvue API key. Secret - keep it server-side.
path
idstring
Required

The run's UUID.

Format: uuid
query
viewstring

Set to report to return the report content model instead of the run.

Options: report
Request Preview
Response

Response will appear here after sending the request

Authentication

header
client-idstring
Required

API Key for authentication. Your Deepvue client identifier.

header
x-api-keystring
Required

API Key for authentication. Your Deepvue API key. Secret - keep it server-side.

Path Parameters

idstring
Required

The run's UUID.

Query Parameters

viewstring

Set to report to return the report content model instead of the run.

Allowed values:report

Responses

idstring
Required
workflow_idstring
Required
reference_idstring
Required

Echoed from the trigger request.

statusstring
Required

Six statuses that partition runs - every run is exactly one of them. Terminal: completed, failed, expired, cancelled. Non-terminal: in_progress, abandoned.

abandoned is the only status that can un-happen: the run stays live and resumes the moment the customer returns. abandoned and expired are computed at read time.

Allowed values:in_progressabandonedcompletedfailedexpiredcancelled
started_atstring
Required
completed_atstring
Required

null until terminal.

action_requiredstring
Required

Non-null only on a non-terminal status.

errorstring
Required

Non-null only when status is failed or expired.

checksarray

Detail endpoint only; omitted when empty.

decisionstring
Required

Always present - a value or an explicit null - so you test a value rather than a key's existence. null means no verdict is owed.

notesstring

What the reviewer typed. Omitted (never null) when they typed nothing.

resolved_atstring
Required

null until a verdict is recorded.

reviewsarray

Detail endpoint only; omitted when the run is flagged for nothing.