go-onfido-openapi/openapi.yaml at master · alpacahq/go-onfido-openapi · GitHub

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
openapi: 3.0.0
info:
  title: Onfido API
  description: The Onfido API is used to submit check requests.
  version: 3.1.0
  license:
    name: MIT
servers:
  - url: https://api.{region}.onfido.com/v3.1
    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
  # Documents
  /documents:
    $ref: paths/documents.yaml#/documents
  /documents/{document_id}:
    $ref: paths/documents.yaml#/document
  /documents/{document_id}/download:
    $ref: paths/documents.yaml#/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#/download_frame
  # 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
  #
  # OTHER ENDPOINTS
  #
  # Webhooks
  /webhooks:
    $ref: paths/webhooks.yaml#/webhooks
  /webhooks/{webhook_id}:
    $ref: paths/webhooks.yaml#/webhook
  # Address Picker
  /addresses/pick:
    $ref: paths/addresses.yaml#/pick
  # SDK Tokens
  /sdk_token:
    $ref: paths/sdk_tokens.yaml#/sdk_token