Merge pull request #12 from onfido/feature/new-openapi-spec

OpenApi specification expansion (beta)

README.md

@@ -1,15 +1,5 @@
-# Onfido OpenAPI Specification
+# Onfido OpenAPI specification (beta)
 
-Onfido's OpenAPI specification (current API version: v3).
+:warning: We are currently expanding our OpenAPI specification to include all report responses. It is in beta and we welcome any feedback. You can contact us via the issues tab, but we don't yet officially support this specification. :warning:
 
-Used to generate client libraries for the v3 API in the following languages:
-
-* [PHP](https://github.com/onfido/api-php-client)
-
-## Support
-
-We officially support these libraries, but for any libraries you generate with this specification, our Product Support team can only advise on a best-effort basis.
-
-Please refer to https://developers.onfido.com and
-https://documentation.onfido.com for more detailed documentation about the
-Onfido API or [contact our Product Support team](mailto:[email protected]) via email for technical support.
+For our latest stable release that is officially supported please use [v1.0.0](https://github.com/onfido/onfido-openapi-spec/tree/v1.0.0). 

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: eu
+        default: us
 security:
   - Token: []
 components:

schemas/reports/document_CDQ_reasons.yaml

@@ -0,0 +1,27 @@
+type: object
+properties:
+  obscured_data_points:
+    type: string
+    description: When data points are obscured to the point that we cannot confirm if the fonts match the expected ones.
+  obscured_security_features: 
+    type: string
+    description: When a critical security feature is obscured. This can also refer to when the holder's wet signature, necessary for the document to be valid, is not present.
+  abnormal_document_features: 
+    type: string
+    description: One of 3 reasons (1) OCR Assisted Scans (i.e. when you're able to move the mouse and highlight part of text), (2) Severely Washed out Background, (3) Overlapping Text.
+  watermarks_digital_text_overlay:
+    type: string
+    description: Any digital text or electronic watermarks on the document.
+  corner_removed:
+    type: string
+    description: If the corner has been physically cut off. This can be found on some documents that are no longer valid.
+  punctured_document:
+    type: string
+    description: A punched hole is present.
+  missing_back:
+    type: string
+    description: When the back of a document is needed for processing, but is not available.
+  digital_document:
+    type: string
+    description: When a document has been published digitally, there aren’t enough security features to review so we cannot perform a full fraud assessment.
+

schemas/reports/document_IQ_reasons.yaml

@@ -0,0 +1,32 @@
+type: object
+properties: 
+  dark_photo:
+    type: string
+    description: When an image of the document is too dark to be able to see data points.
+  glare_on_photo:
+    type: string
+    description: When there is light reflecting on the document causing glare to obstruct data points.
+  blurred_photo:
+    type: string
+    description: When data points are blurred and no reference can be made elsewhere in the document or if the data points are too blurry and 'they could be something else'.
+  covered_photo:
+    type: string 
+    description: When data points have been covered either by the applicant or by another object such as a sticker.
+  other_photo_issue:
+    type: string
+    description: Any other reason not listed, such as when holograms are obscuring data points.
+  damaged_document:
+    type: string
+    description: When a document is damaged and we are unable to make out data points.
+  incorrect_side:
+    type: string 
+    description: When the incorrect side of a document has been uploaded, and we have not received the front.
+  cut_off_document:
+    type: string
+    description: When data points are not included in the image due to the document being cut off.
+  no_document_in_image:
+    type: string
+    description: If no document has been uploaded or there is a blank image.
+  two_documents_uploaded:
+    type: string
+    description: When 2 different documents are submitted in the same check.

schemas/reports/document_ODP_reasons.yaml

@@ -0,0 +1,14 @@
+type: object
+properties:
+  photo_of_screen:
+    type: string
+    description: When the applicant's document is on a physical screen or device.
+  screenshot:
+    type: string
+    description: When the applicant has used their mobile phone, tablet, or computer to take a photo within the device.
+  document_on_printed_paper:
+    type: string 
+    description: When the applicant has previously captured an image of the document, printed it out, and has now taken a photo of this print out to upload.
+  scan: 
+    type: string
+    description: When the document has clearly been captured using a scanner and there are visible indicators of this