Skip to content

Commit

Permalink
Merge pull request #24 from onfido/update-to-v3.5
Browse files Browse the repository at this point in the history 
Update to v3.5.0
  • Loading branch information
@ra-ul
ra-ul authored Nov 17, 2022
2 parents aa2e12f + 5328c7c commit 4d1f097
Show file tree
Hide file tree
Showing 4 changed files with 110 additions and 57 deletions.
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.4.0
version: 3.5.0
license:
name: MIT
servers:
- url: https://api.{region}.onfido.com/v3.4
- url: https://api.{region}.onfido.com/v3.5
variables:
region:
enum:
Expand Down
125 changes: 72 additions & 53 deletions output.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,17 @@
"info": {
"title": "Onfido API",
"description": "The Onfido API is used to submit check requests.",
"version": "3.4.0",
"version": "3.5.0",
"license": {
"name": "MIT"
}
},
"servers": [
{
"url": "https://api.{region}.onfido.com/v3.4",
"url": "https://api.{region}.onfido.com/v3.5",
"variables": {
"region": {
"enum": [
"eu",
"us",
"ca"
],
"enum": ["eu", "us", "ca"],
"default": "eu"
}
}
Expand Down Expand Up @@ -438,11 +434,7 @@
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"type",
"file",
"applicant_id"
],
"required": ["type", "file", "applicant_id"],
"properties": {
"applicant_id": {
"type": "string",
Expand Down Expand Up @@ -659,10 +651,7 @@
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"applicant_id",
"file"
],
"required": ["applicant_id", "file"],
"properties": {
"applicant_id": {
"type": "string"
Expand Down Expand Up @@ -743,7 +732,7 @@
"schema": {
"type": "string"
}
}
}
],
"responses": {
"200": {
Expand Down Expand Up @@ -1342,9 +1331,7 @@
"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": [
"id"
],
"required": ["id"],
"properties": {
"id": {
"type": "string",
Expand All @@ -1370,9 +1357,7 @@
{
"properties": {
"name": {
"enum": [
"facial_similarity_photo"
]
"enum": ["facial_similarity_photo"]
},
"breakdown": {
"type": "object",
Expand Down Expand Up @@ -1515,9 +1500,7 @@
{
"properties": {
"name": {
"enum": [
"known_faces"
]
"enum": ["known_faces"]
},
"breakdown": {
"type": "object",
Expand Down Expand Up @@ -1580,9 +1563,7 @@
{
"properties": {
"name": {
"enum": [
"photo_fully_auto"
]
"enum": ["photo_fully_auto"]
},
"breakdown": {
"type": "object",
Expand Down Expand Up @@ -1725,9 +1706,7 @@
{
"properties": {
"name": {
"enum": [
"facial_similarity_video"
]
"enum": ["facial_similarity_video"]
},
"breakdown": {
"type": "object",
Expand Down Expand Up @@ -2486,10 +2465,37 @@
},
"compromised_document": {
"type": "object",
"description": "Asserts whether the image of the document has been found in our internal database of compromised documents.",
"description": "Asserts whether the image of the document has been found in our internal database or if it was used in a suspicious way.",
"properties": {
"result": {
"type": "string"
},
"breakdown": {
"type": "object",
"properties": {
"document_database": {
"type": "object",
"properties": {
"result": {
"type": "string"
},
"properties": {
"type": "object"
}
}
},
"repeat_attempts": {
"type": "object",
"properties": {
"result": {
"type": "string"
},
"properties": {
"type": "object"
}
}
}
}
}
}
},
Expand Down Expand Up @@ -2886,9 +2892,7 @@
{
"properties": {
"name": {
"enum": [
"proof_of_address"
]
"enum": ["proof_of_address"]
},
"breakdown": {
"type": "object",
Expand Down Expand Up @@ -3037,9 +3041,7 @@
{
"properties": {
"name": {
"enum": [
"watchlist_enhanced"
]
"enum": ["watchlist_enhanced"]
},
"breakdown": {
"type": "object",
Expand Down Expand Up @@ -3154,9 +3156,7 @@
{
"properties": {
"name": {
"enum": [
"right_to_work"
]
"enum": ["right_to_work"]
},
"breakdown": {
"type": "object",
Expand Down Expand Up @@ -3663,6 +3663,33 @@
"properties": {
"result": {
"type": "string"
},
"breakdown": {
"type": "object",
"properties": {
"document_database": {
"type": "object",
"properties": {
"result": {
"type": "string"
},
"properties": {
"type": "object"
}
}
},
"repeat_attempts": {
"type": "object",
"properties": {
"result": {
"type": "string"
},
"properties": {
"type": "object"
}
}
}
}
}
}
},
Expand Down Expand Up @@ -3803,9 +3830,7 @@
{
"properties": {
"name": {
"enum": [
"identity_enhanced"
]
"enum": ["identity_enhanced"]
},
"breakdown": {
"type": "object",
Expand Down Expand Up @@ -4047,10 +4072,7 @@
"application/json": {
"schema": {
"type": "object",
"required": [
"applicant_id",
"workflow_id"
],
"required": ["applicant_id", "workflow_id"],
"properties": {
"workflow_id": {
"type": "string",
Expand Down Expand Up @@ -4449,9 +4471,7 @@
"application/json": {
"schema": {
"type": "object",
"required": [
"url"
],
"required": ["url"],
"properties": {
"id": {
"type": "string",
Expand Down Expand Up @@ -5112,4 +5132,3 @@
}
}
}

19 changes: 18 additions & 1 deletion schemas/reports/document_breakdown.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -326,10 +326,27 @@ properties:
type: string
compromised_document:
type: object
description: Asserts whether the image of the document has been found in our internal database of compromised documents.
description: Asserts whether the image of the document has been found in our internal database or if it was used in a suspicious way.
properties:
result:
type: string
breakdown:
type: object
properties:
document_database:
type: object
properties:
result:
type: string
properties:
type: object
repeat_attempts:
type: object
properties:
result:
type: string
properties:
type: object
age_validation:
type: object
description: Asserts whether the age calculated from the document’s date of birth data point is greater than or equal to the minimum accepted age.
Expand Down
19 changes: 18 additions & 1 deletion schemas/reports/right_to_work_breakdown.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -319,10 +319,27 @@ properties:
type: string
compromised_document:
type: object
description: Asserts whether the image of the document has been found in our internal database of compromised documents.
description: Asserts whether the image of the document has been found in our internal database or if it was used in a suspicious way.
properties:
result:
type: string
breakdown:
type: object
properties:
document_database:
type: object
properties:
result:
type: string
properties:
type: object
repeat_attempts:
type: object
properties:
result:
type: string
properties:
type: object
age_validation:
type: object
description: Asserts whether the age calculated from the document’s date of birth data point is greater than or equal to the minimum accepted age.
Expand Down

0 comments on commit 4d1f097

Please sign in to comment.