Merge pull request #11 from onfido/feature/v3.1

API v3.1 additions

openapi.yaml

@@ -2,17 +2,18 @@ openapi: 3.0.0
 info:
   title: Onfido API
   description: The Onfido API is used to submit check requests.
-  version: 3.0.0
+  version: 3.1.0
   license:
     name: MIT
 servers:
-  - url: https://api.onfido.com/v3
-  - url: https://api.{region}.onfido.com/v3
+  - url: https://api.{region}.onfido.com/v3.1
     variables:
       region:
         enum:
+          - eu
           - us
-        default: us
+          - ca
+        default: eu
 security:
   - Token: []
 components:
@@ -64,6 +65,8 @@ paths:
     $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

paths/checks.yaml

@@ -72,3 +72,20 @@
           description: No Content
         default:
           $ref: ../responses/default_error.yaml
+
+  download: 
+    get:
+      summary: Download a PDF of the check
+      operationId: download_check
+      parameters:
+        - name: check_id
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: The PDF binary data
+        default:
+          $ref: ../responses/default_error.yaml
+

schemas/checks/check.yaml

@@ -49,7 +49,6 @@
         description: The ID of the applicant to do the check on.
       privacy_notices_read_consent_given:
         type: boolean
-        writeOnly: true
         description: Indicates whether the privacy notices and terms of service have been read and, where specific laws require, that consent has been given for Onfido.
       tags:
         type: array
@@ -72,6 +71,11 @@
         writeOnly: true
         description: >
           Defaults to `true`. Write-only. If set to `false`, you will only receive a response when all reports in your check have completed.
+      webhook_ids:
+        type: array
+        items:
+          type: string
+        description: Optional. An array of strings describing which webhooks to trigger for this check. By default, all webhooks registered in the account will be triggered and this value will be null in the responses.
       report_ids:
         description: An array of report ids.
         type: array