{ "opencollection": "1.0.0", "info": { "name": "Onfido Run API", "version": "v3.6" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Run", "type": "folder" }, "items": [ { "info": { "name": "Retrieve Workflow Run", "type": "http" }, "http": { "method": "GET", "url": "https://api.{region}.onfido.com/v3.6/workflow_runs/:workflow_run_id", "params": [ { "name": "workflow_run_id", "value": "", "type": "path", "description": "The unique identifier of the Workflow Run." } ] }, "docs": "A single workflow run can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.\n" }, { "info": { "name": "Retrieve Workflow Run Evidence Summary File", "type": "http" }, "http": { "method": "GET", "url": "https://api.{region}.onfido.com/v3.6/workflow_runs/:workflow_run_id/signed_evidence_file", "params": [ { "name": "workflow_run_id", "value": "", "type": "path", "description": "Workflow Run ID" } ] }, "docs": "Retrieves the signed evidence file for the designated Workflow Run\n" }, { "info": { "name": "List Tasks", "type": "http" }, "http": { "method": "GET", "url": "https://api.{region}.onfido.com/v3.6/workflow_runs/:workflow_run_id/tasks", "params": [ { "name": "workflow_run_id", "value": "", "type": "path", "description": "The unique identifier of the Workflow Run to which the Tasks belong." } ] }, "docs": "The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.\n" }, { "info": { "name": "Retrieve Task", "type": "http" }, "http": { "method": "GET", "url": "https://api.{region}.onfido.com/v3.6/workflow_runs/:workflow_run_id/tasks/:task_id", "params": [ { "name": "workflow_run_id", "value": "", "type": "path", "description": "The unique identifier of the Workflow Run to which the Task belongs." }, { "name": "task_id", "value": "", "type": "path", "description": "The identifier of the Task you want to retrieve." } ] }, "docs": "A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run.\n" }, { "info": { "name": "Complete Task", "type": "http" }, "http": { "method": "POST", "url": "https://api.{region}.onfido.com/v3.6/workflow_runs/:workflow_run_id/tasks/:task_id/complete", "params": [ { "name": "workflow_run_id", "value": "", "type": "path", "description": "The unique identifier of the Workflow Run to which the Task belongs." }, { "name": "task_id", "value": "", "type": "path", "description": "The identifier of the Task you want to complete." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Completes a Send / Receive Data Task.\n" }, { "info": { "name": "Create Timeline File for Workflow Run", "type": "http" }, "http": { "method": "POST", "url": "https://api.{region}.onfido.com/v3.6/workflow_runs/:workflow_run_id/timeline_file", "params": [ { "name": "workflow_run_id", "value": "", "type": "path", "description": "The unique identifier of the Workflow Run." } ] }, "docs": "Triggers the generation of the Timeline File for the designated Workflow Run.\n" }, { "info": { "name": "Retrieve Timeline File for Workflow Run", "type": "http" }, "http": { "method": "GET", "url": "https://api.{region}.onfido.com/v3.6/workflow_runs/:workflow_run_id/timeline_file/:timeline_file_id", "params": [ { "name": "workflow_run_id", "value": "", "type": "path", "description": "The unique identifier of the Workflow Run." }, { "name": "timeline_file_id", "value": "", "type": "path", "description": "The unique identifier for the Timefile File." } ] }, "docs": "Retrieves the Timeline File for the designated Workflow Run.\n" } ] } ], "bundled": true }