How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Onfido

Onfido Run API

The Run API from Onfido — 7 operation(s) for run.

Documentation Provider Profile APIs.io OpenAPI GitHub

Onfido Run API is one of 45 APIs that Onfido publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Run. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 7 operations across 7 paths, and defines 13 schemas. It is described by OpenAPI 3.0.0, at version v3.6.

Requests are made against a single base URL, https://api.{region}.onfido.com/v3.6.

7 operations 7 paths 13 schemas 5 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v3.6
Server
https://api.{region}.onfido.com/v3.6
Authentication
API Key
Contact
Onfido
License
MIT
Resource Areas
1

Authentication & Security 1

Onfido Run API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Token). By default, every request must be authenticated.

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 5 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Run 7
GET
/workflow_runs/{workflow_run_id}
Retrieve Workflow Run
find_workflow_run 1 param → 200default
GET
/workflow_runs/{workflow_run_id}/signed_evidence_file
Retrieve Workflow Run Evidence Summary File
download_signed_evidence_file 1 param → 200302default
GET
/workflow_runs/{workflow_run_id}/tasks
List Tasks
list_tasks 1 param → 200default
GET
/workflow_runs/{workflow_run_id}/tasks/{task_id}
Retrieve Task
find_task 2 params → 200default
POST
/workflow_runs/{workflow_run_id}/tasks/{task_id}/complete
Complete Task
complete_task 2 params body → 200default
POST
/workflow_runs/{workflow_run_id}/timeline_file
Create Timeline File for Workflow Run
create_timeline_file 1 param → 202default
GET
/workflow_runs/{workflow_run_id}/timeline_file/{timeline_file_id}
Retrieve Timeline File for Workflow Run
find_timeline_file 2 params → 200302default

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are task (8 properties), workflow_run_response (8 properties), workflow_run_shared (7 properties), TaskItem (6 properties). Each schema is shown below with its type and property counts.

ErrorProperties
object
3 properties
Complete_Task_Data_Builder
The Task completion payload.
Error
object
1 property
workflow_run_link
object
5 properties
workflow_run_status
string
TaskItem
object
6 properties
task
object
8 properties
workflow_run_response
object
8 properties 1 required
complete_task_builder
object
1 property 1 required
timeline_file_reference
object
2 properties 2 required
workflow_run
workflow_run_shared
object
7 properties 2 required
workflow_run_error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

onfido-run-api-openapi.yml Raw ↑

Other APIs Onfido publishes across the network.

Onfido Addresses API
AE Profile APIs.io
Onfido Applicants API
AE Profile APIs.io
Onfido Attempts API
AE Profile APIs.io
Onfido Cancel API
AE Profile APIs.io
Onfido Capture API
AE Profile APIs.io
Onfido Captures API
AE Profile APIs.io
Onfido Checks API
AE Profile APIs.io
Onfido Complete API
AE Profile APIs.io
Onfido Documents API
AE Profile APIs.io
Onfido Download API
AE Profile APIs.io
Onfido Downloads API
AE Profile APIs.io
Onfido Electronic API
AE Profile APIs.io
#Run
← Back to O APIs
API Details
ID
onfido:onfido-run-api
Server
https://api.{region}.onfido.com/v3.6
Docs
https://documentation.onfido.com/
Provider
Onfido
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=onfido-run-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/onfido-run-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Onfido Run API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.