forked from onfido/onfido-openapi-spec
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
158 lines (158 loc) · 4.68 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
openapi: 3.0.0
info:
title: Onfido API v3.6
version: v3.6
description: The Onfido API (v3.6)
contact:
name: Onfido
url: https://public.support.onfido.com
license:
name: MIT
servers:
- url: https://api.{region}.onfido.com/v3.6
variables:
region:
enum:
- eu
- us
- ca
default: eu
security:
- Token: []
components:
securitySchemes:
Token:
type: apiKey
name: Authorization
in: header
externalDocs:
url: https://documentation.onfido.com
paths:
#
# CORE RESOURCES
#
# Applicants
/applicants:
$ref: paths/applicants.yaml#/applicants
/applicants/{applicant_id}:
$ref: paths/applicants.yaml#/applicant
/applicants/{applicant_id}/restore:
$ref: paths/applicants.yaml#/restore
# Workflow Runs
/workflow_runs:
$ref: paths/workflow_runs.yaml#/workflow_runs
/workflow_runs/{workflow_run_id}:
$ref: paths/workflow_runs.yaml#/retrieve
/workflow_runs/{workflow_run_id}/signed_evidence_file:
$ref: paths/workflow_runs.yaml#/signed_evidence_file
# Documents
/documents:
$ref: paths/documents.yaml#/documents
/documents/{document_id}:
$ref: paths/documents.yaml#/document
/documents/{document_id}/download:
$ref: paths/documents.yaml#/download
/documents/{document_id}/video/download:
$ref: paths/documents.yaml#/video/download
# Live Photos
/live_photos:
$ref: paths/live_photos.yaml#/live_photos
/live_photos/{live_photo_id}:
$ref: paths/live_photos.yaml#/live_photo
/live_photos/{live_photo_id}/download:
$ref: paths/live_photos.yaml#/download
# Live Videos
/live_videos:
$ref: paths/live_videos.yaml#/live_videos
/live_videos/{live_video_id}:
$ref: paths/live_videos.yaml#/live_video
/live_videos/{live_video_id}/download:
$ref: paths/live_videos.yaml#/download
/live_videos/{live_video_id}/frame:
$ref: paths/live_videos.yaml#/frame
# Tasks
/workflow_runs/{workflow_run_id}/tasks:
$ref: paths/tasks.yaml#/tasks
/workflow_runs/{workflow_run_id}/tasks/{task_id}:
$ref: paths/tasks.yaml#/task
/workflow_runs/{workflow_run_id}/tasks/{task_id}/complete:
$ref: paths/tasks.yaml#/complete_task
# Motion Captures
/motion_captures:
$ref: paths/motion_captures.yaml#/motion_captures
/motion_captures/{motion_capture_id}:
$ref: paths/motion_captures.yaml#/motion_capture
/motion_captures/{motion_capture_id}/download:
$ref: paths/motion_captures.yaml#/download
/motion_captures/{motion_capture_id}/frame:
$ref: paths/motion_captures.yaml#/frame
# Monitors
/watchlist_monitors:
$ref: paths/watchlist_monitors.yaml#/watchlist_monitors
/watchlist_monitors/{monitor_id}:
$ref: paths/watchlist_monitors.yaml#/watchlist_monitor
/watchlist_monitors/{monitor_id}/matches:
$ref: paths/watchlist_monitors.yaml#/matches
/watchlist_monitors/{monitor_id}/new_report:
$ref: paths/watchlist_monitors.yaml#/new_report
# ID Photos
/id_photos:
$ref: paths/id_photos.yaml#/id_photos
/id_photos/{id_photo_id}:
$ref: paths/id_photos.yaml#/id_photo
/id_photos/{id_photo_id}/download:
$ref: paths/id_photos.yaml#/download
# Qualified Electronic Signature
/qualified_electronic_signature/documents:
$ref: paths/qualified_electronic_signature.yaml#/documents
# Timeline Files
/workflow_runs/{workflow_run_id}/timeline_file:
$ref: paths/timeline_files.yaml#/timeline_files
/workflow_runs/{workflow_run_id}/timeline_file/{timeline_file_id}:
$ref: paths/timeline_files.yaml#/retrieve
#
# OTHER ENDPOINTS
#
# Ping
/ping:
$ref: paths/ping.yaml#/ping
# Webhooks
/webhooks:
$ref: paths/webhooks.yaml#/webhooks
/webhooks/{webhook_id}:
$ref: paths/webhooks.yaml#/webhook
/webhooks/resend:
$ref: paths/webhooks.yaml#/webhooks_resend
# Address Picker
/addresses/pick:
$ref: paths/addresses.yaml#/pick
# Generate SDK Tokens
/sdk_token:
$ref: paths/sdk_tokens.yaml#/sdk_token
# Repeat attempts
/repeat_attempts/{report_id}:
$ref: paths/repeat_attempts.yaml#/repeat_attempts
# Autofill
/extractions:
$ref: paths/extractions.yaml#/extractions
# Fraud reporting (ALPHA)
/results_feedback:
$ref: paths/results_feedback.yaml#/results_feedback
# Checks
/checks:
$ref: paths/checks.yaml#/checks
/checks/{check_id}:
$ref: paths/checks.yaml#/check
/checks/{check_id}/resume:
$ref: paths/checks.yaml#/resume
/checks/{check_id}/download:
$ref: paths/checks.yaml#/download
# Reports
/reports:
$ref: paths/reports.yaml#/reports
/reports/{report_id}:
$ref: paths/reports.yaml#/report
/reports/{report_id}/resume:
$ref: paths/reports.yaml#/resume
/reports/{report_id}/cancel:
$ref: paths/reports.yaml#/cancel