Skip to content

Commit

Permalink
Merge pull request #16 from onfido/release/v3.2
Browse files Browse the repository at this point in the history 
Adds support for API v3.2
  • Loading branch information
@Phoebe-B
Phoebe-B authored Jun 24, 2021
2 parents 67e7b3d + af435ee commit 07e5d5e
Show file tree
Hide file tree
Showing 10 changed files with 196 additions and 10 deletions.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

: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 or [email](mailto:[email protected]), but we don't yet officially support this specification. :warning:

This specification supports Onfido API v3 onwards.
This specification supports the latest version of the Onfido API.

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).

Expand Down
4 changes: 2 additions & 2 deletions openapi.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@ openapi: 3.0.0
info:
title: Onfido API
description: The Onfido API is used to submit check requests.
version: 3.1.0
version: 3.2.0
license:
name: MIT
servers:
- url: https://api.{region}.onfido.com/v3.1
- url: https://api.{region}.onfido.com/v3.2
variables:
region:
enum:
Expand Down
119 changes: 115 additions & 4 deletions output.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
"info": {
"title": "Onfido API",
"description": "The Onfido API is used to submit check requests.",
"version": "3.1.0",
"version": "3.2.0",
"license": {
"name": "MIT"
}
},
"servers": [
{
"url": "https://api.{region}.onfido.com/v3.1",
"url": "https://api.{region}.onfido.com/v3.2",
"variables": {
"region": {
"enum": [
Expand Down Expand Up @@ -1097,7 +1097,7 @@
}
},
"document_ids": {
"description": "Optional. An array of document ids, for use with Document reports only. If omitted, the Document report will use the most recently uploaded document by default.",
"description": "Optional. Array of strings describing which document to process in checks containing a Document report or a Facial Similarity report, or both. By default, the most recently uploaded document is used. `document_ids` is only usable with Document and Facial Similarity reports.",
"type": "array",
"writeOnly": true,
"items": {
Expand Down Expand Up @@ -1323,7 +1323,7 @@
},
"documents": {
"type": "array",
"description": "Array of objects with document ids that were used in the Onfido engine. [ONLY USED IN A DOCUMENT CHECK]",
"description": "Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]",
"items": {
"type": "object",
"required": [
Expand Down Expand Up @@ -1385,6 +1385,11 @@
"type": "number",
"format": "float",
"description": "A floating point number between 0 and 1 that expresses how similar the two faces are, where 1 is a perfect match."
},
"document_id": {
"type": "string",
"format": "uuid",
"description": "The UUID for the document containing the extracted face that was used for face matching."
}
}
}
Expand Down Expand Up @@ -1590,6 +1595,11 @@
"type": "number",
"format": "float",
"description": "A floating point number between 0 and 1 that expresses how similar the two faces are, where 1 is a perfect match."
},
"document_id": {
"type": "string",
"format": "uuid",
"description": "The UUID for the document containing the extracted face that was used for face matching."
}
}
}
Expand Down Expand Up @@ -1731,6 +1741,11 @@
"type": "number",
"format": "float",
"description": "A floating point number between 0 and 1 that expresses how similar the two faces are, where 1 is a perfect match."
},
"document_id": {
"type": "string",
"format": "uuid",
"description": "The UUID for the document containing the extracted face that was used for face matching."
}
}
}
Expand Down Expand Up @@ -2038,6 +2053,17 @@
"type": "object"
}
}
},
"barcode": {
"type": "object",
"properties": {
"result": {
"type": "string"
},
"properties": {
"type": "object"
}
}
}
}
}
Expand Down Expand Up @@ -2475,6 +2501,44 @@
}
}
}
},
"issuing_authority": {
"type": "object",
"description": "Asserts whether data on the document matches the issuing authority data.",
"properties": {
"result": {
"type": "string"
},
"breakdown": {
"type": "object",
"properties": {
"nfc_active_authentication": {
"type": "object",
"description": "Asserts whether the document NFC chip is original or cloned.",
"properties": {
"result": {
"type": "string"
},
"properties": {
"type": "object"
}
}
},
"nfc_passive_authentication": {
"type": "object",
"description": "Asserts whether the document NFC chip data was tampered.",
"properties": {
"result": {
"type": "string"
},
"properties": {
"type": "object"
}
}
}
}
}
}
}
}
},
Expand Down Expand Up @@ -2649,6 +2713,53 @@
}
}
},
"nfc": {
"type": "object",
"properties": {
"document_type": {
"type": "string"
},
"issuing_country": {
"type": "string"
},
"full_name": {
"type": "string"
},
"document_number": {
"type": "string"
},
"nationality": {
"type": "string"
},
"date_of_birth": {
"type": "string",
"format": "date"
},
"gender": {
"type": "string"
},
"date_of_expiry": {
"type": "string",
"format": "date"
},
"personal_number": {
"type": "string"
},
"place_of_birth": {
"type": "string"
},
"address": {
"type": "string"
},
"issuing_date": {
"type": "string",
"format": "date"
},
"issuing_authority": {
"type": "string"
}
}
},
"driving_licence_information": {
"type": "object",
"properties": {
Expand Down
2 changes: 1 addition & 1 deletion schemas/checks/check.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
items:
type: string
document_ids:
description: Optional. An array of document ids, for use with Document reports only. If omitted, the Document report will use the most recently uploaded document by default.
description: Optional. Array of strings describing which document to process in checks containing a Document report or a Facial Similarity report, or both. By default, the most recently uploaded document is used. `document_ids` is only usable with Document and Facial Similarity reports.
type: array
writeOnly: true
items:
Expand Down
33 changes: 32 additions & 1 deletion schemas/reports/document_breakdown.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,13 @@ properties:
type: string
properties:
type: object
barcode:
type: object
properties:
result:
type: string
properties:
type: object
image_integrity:
type: object
description: Asserts if the document is of sufficient quality to verify.
Expand Down Expand Up @@ -339,4 +346,28 @@ properties:
type: string
properties:
type: object

issuing_authority:
type: object
description: Asserts whether data on the document matches the issuing authority data.
properties:
result:
type: string
breakdown:
type: object
properties:
nfc_active_authentication:
type: object
description: Asserts whether the document NFC chip is original or cloned.
properties:
result:
type: string
properties:
type: object
nfc_passive_authentication:
type: object
description: Asserts whether the document NFC chip data was tampered.
properties:
result:
type: string
properties:
type: object
32 changes: 32 additions & 0 deletions schemas/reports/document_properties.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,38 @@ properties:
type: string
real_id_classification:
type: string
nfc:
type: object
properties:
document_type:
type: string
issuing_country:
type: string
full_name:
type: string
document_number:
type: string
nationality:
type: string
date_of_birth:
type: string
format: date
gender:
type: string
date_of_expiry:
type: string
format: date
personal_number:
type: string
place_of_birth:
type: string
address:
type: string
issuing_date:
type: string
format: date
issuing_authority:
type: string
driving_licence_information:
type: object
properties:
Expand Down
4 changes: 4 additions & 0 deletions schemas/reports/facial_similarity_photo_breakdown.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ properties:
type: number
format: float
description: A floating point number between 0 and 1 that expresses how similar the two faces are, where 1 is a perfect match.
document_id:
type: string
format: uuid
description: The UUID for the document containing the extracted face that was used for face matching.
image_integrity:
type: object
description: Asserts whether the quality and integrity of the uploaded files were sufficient to perform a face comparison.
Expand Down
4 changes: 4 additions & 0 deletions schemas/reports/facial_similarity_video_breakdown.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ properties:
type: number
format: float
description: A floating point number between 0 and 1 that expresses how similar the two faces are, where 1 is a perfect match.
document_id:
type: string
format: uuid
description: The UUID for the document containing the extracted face that was used for face matching.
image_integrity:
type: object
readOnly: true
Expand Down
4 changes: 4 additions & 0 deletions schemas/reports/photo_fully_auto_breakdown.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ properties:
type: number
format: float
description: A floating point number between 0 and 1 that expresses how similar the two faces are, where 1 is a perfect match.
document_id:
type: string
format: uuid
description: The UUID for the document containing the extracted face that was used for face matching.
image_integrity:
type: object
description: Asserts whether the quality and integrity of the uploaded files were sufficient to perform a face comparison.
Expand Down
2 changes: 1 addition & 1 deletion schemas/reports/report.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ allOf:
description: The name of the report type.
documents:
type: array
description: Array of objects with document ids that were used in the Onfido engine. [ONLY USED IN A DOCUMENT CHECK]
description: Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]
items:
$ref: report_document.yaml
breakdown:
Expand Down

0 comments on commit 07e5d5e

Please sign in to comment.