openapi: 3.0.0
info:
contact:
name: Onfido
url: https://public.support.onfido.com
description: "\nCreate trust at onboarding and beyond with a complete, AI-powered digital\nidentity solution built to help you know your customers online. \nAutomation allows you to acquire new customers and reduce costs while\nmeeting global KYC and AML compliance."
license:
name: MIT
title: Onfido Signed API
version: v3.6
servers:
- url: https://api.{region}.onfido.com/v3.6
variables:
region:
default: eu
enum:
- eu
- us
- ca
security:
- Token: []
tags:
- name: Signed
paths:
/workflow_runs/{workflow_run_id}/signed_evidence_file:
get:
description: 'Retrieves the signed evidence file for the designated Workflow Run
'
operationId: download_signed_evidence_file
parameters:
- description: Workflow Run ID
in: path
name: workflow_run_id
required: true
schema:
format: uuid
type: string
responses:
'200':
content:
application/pdf:
schema:
format: binary
type: string
description: The signed evidence PDF binary data.
'302':
description: Found
headers:
Location:
description: Link to the signed evidence file PDF.
schema:
format: uri
type: string
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Unexpected error
summary: Retrieve Workflow Run Evidence Summary File
tags:
- Signed
components:
schemas:
ErrorProperties:
example:
type: type
message: message
fields:
key: ''
properties:
type:
type: string
message:
type: string
fields:
additionalProperties: true
type: object
title: ErrorProperties
type: object
Error:
example:
error:
type: type
message: message
fields:
key: ''
properties:
error:
$ref: '#/components/schemas/ErrorProperties'
title: Error
type: object
securitySchemes:
Token:
in: header
name: Authorization
type: apiKey
externalDocs:
url: https://documentation.onfido.com