From 708bacf86d1f634d8f3ae19195106755766aee1a Mon Sep 17 00:00:00 2001 From: Phoebe Baxter Date: Wed, 3 Mar 2021 15:54:15 +0000 Subject: [PATCH 1/4] Add v3.1 additions --- openapi.yaml | 2 ++ paths/checks.yaml | 17 +++++++++++++++++ schemas/checks/check.yaml | 5 +++++ 3 files changed, 24 insertions(+) diff --git a/openapi.yaml b/openapi.yaml index 30555999..90307e4d 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -64,6 +64,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 diff --git a/paths/checks.yaml b/paths/checks.yaml index d93af4f0..2ba149cd 100644 --- a/paths/checks.yaml +++ b/paths/checks.yaml @@ -72,3 +72,20 @@ description: No Content default: $ref: ../responses/default_error.yaml + + download: + post: + 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 + \ No newline at end of file diff --git a/schemas/checks/check.yaml b/schemas/checks/check.yaml index 2759a8e4..0bc228b7 100644 --- a/schemas/checks/check.yaml +++ b/schemas/checks/check.yaml @@ -72,6 +72,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 From e98807f3aff3e9522e0504a0aaaa57d774e1bc96 Mon Sep 17 00:00:00 2001 From: Phoebe Baxter Date: Mon, 8 Mar 2021 15:38:31 +0000 Subject: [PATCH 2/4] Edits --- paths/checks.yaml | 2 +- schemas/checks/check.yaml | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/paths/checks.yaml b/paths/checks.yaml index 2ba149cd..4500cd4e 100644 --- a/paths/checks.yaml +++ b/paths/checks.yaml @@ -74,7 +74,7 @@ $ref: ../responses/default_error.yaml download: - post: + get: summary: Download a PDF of the check operationId: download_check parameters: diff --git a/schemas/checks/check.yaml b/schemas/checks/check.yaml index 0bc228b7..86c31ed4 100644 --- a/schemas/checks/check.yaml +++ b/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 From 1a286c7af5e33ca641921a7f570f1fa9a6e60e4e Mon Sep 17 00:00:00 2001 From: Phoebe Baxter Date: Mon, 8 Mar 2021 16:02:00 +0000 Subject: [PATCH 3/4] Update urls and bump version --- openapi.yaml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index 90307e4d..83e408ea 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -2,16 +2,17 @@ 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.onfido.com/v3.1 + - url: https://api.{region}.onfido.com/v3.1 variables: region: enum: - us + - ca default: us security: - Token: [] From ed6d3ffd565f3c12f61de60d38bb025e44cf25e1 Mon Sep 17 00:00:00 2001 From: Phoebe Baxter Date: Tue, 23 Mar 2021 14:37:15 +0000 Subject: [PATCH 4/4] Update base url --- openapi.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index 83e408ea..d2e1b105 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -6,14 +6,14 @@ info: license: name: MIT servers: - - url: https://api.onfido.com/v3.1 - url: https://api.{region}.onfido.com/v3.1 variables: region: enum: + - eu - us - ca - default: us + default: eu security: - Token: [] components: