You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 16, 2021. It is now read-only.
*DefaultApi* | [**cancel_report**](docs/DefaultApi.md#cancel_report) | **POST** /checks/{check_id}/reports/{report_id}/cancel | This endpoint is for cancelling individual paused reports.
88
+
*DefaultApi* | [**cancel_report**](docs/DefaultApi.md#cancel_report) | **POST** /reports/{report_id}/cancel | This endpoint is for cancelling individual paused reports.
*DefaultApi* | [**download_document**](docs/DefaultApi.md#download_document) | **GET** /applicants/{applicant_id}/documents/{document_id}/download | Download a documents raw data
94
+
*DefaultApi* | [**download_document**](docs/DefaultApi.md#download_document) | **GET** /documents/{document_id}/download | Download a documents raw data
89
95
*DefaultApi* | [**download_live_photo**](docs/DefaultApi.md#download_live_photo) | **GET** /live_photos/{live_photo_id}/download | Download live photo
90
96
*DefaultApi* | [**download_live_video**](docs/DefaultApi.md#download_live_video) | **GET** /live_videos/{live_video_id}/download | Download live video
91
97
*DefaultApi* | [**edit_webhook**](docs/DefaultApi.md#edit_webhook) | **PUT** /webhooks/{webhook_id} | Edit a webhook
92
98
*DefaultApi* | [**find_addresses**](docs/DefaultApi.md#find_addresses) | **GET** /addresses/pick | Search for addresses by postcode
*DefaultApi* | [**find_check**](docs/DefaultApi.md#find_check) | **GET** /applicants/{applicant_id}/checks/{check_id} | Retrieve a Check
95
-
*DefaultApi* | [**find_document**](docs/DefaultApi.md#find_document) | **GET** /applicants/{applicant_id}/documents/{document_id} | A single document can be retrieved by calling this endpoint with the document’s unique identifier.
100
+
*DefaultApi* | [**find_check**](docs/DefaultApi.md#find_check) | **GET** /checks/{check_id} | Retrieve a Check
101
+
*DefaultApi* | [**find_document**](docs/DefaultApi.md#find_document) | **GET** /documents/{document_id} | A single document can be retrieved by calling this endpoint with the document’s unique identifier.
96
102
*DefaultApi* | [**find_live_photo**](docs/DefaultApi.md#find_live_photo) | **GET** /live_photos/{live_photo_id} | Retrieve live photo
97
103
*DefaultApi* | [**find_live_video**](docs/DefaultApi.md#find_live_video) | **GET** /live_videos/{live_video_id} | Retrieve live video
98
-
*DefaultApi* | [**find_report**](docs/DefaultApi.md#find_report) | **GET** /checks/{check_id}/reports/{report_id} | A single report can be retrieved using this endpoint with the corresponding unique identifier.
99
-
*DefaultApi* | [**find_report_type_group**](docs/DefaultApi.md#find_report_type_group) | **GET** /report_type_groups/{report_type_group_id} | Retrieve single report type group object
104
+
*DefaultApi* | [**find_report**](docs/DefaultApi.md#find_report) | **GET** /reports/{report_id} | A single report can be retrieved using this endpoint with the corresponding unique identifier.
100
105
*DefaultApi* | [**find_webhook**](docs/DefaultApi.md#find_webhook) | **GET** /webhooks/{webhook_id} | Retrieve a Webhook
*DefaultApi* | [**list_documents**](docs/DefaultApi.md#list_documents) | **GET** /documents | List documents
105
110
*DefaultApi* | [**list_live_photos**](docs/DefaultApi.md#list_live_photos) | **GET** /live_photos | List live photos
106
111
*DefaultApi* | [**list_live_videos**](docs/DefaultApi.md#list_live_videos) | **GET** /live_videos | List live videos
107
-
*DefaultApi* | [**list_report_type_groups**](docs/DefaultApi.md#list_report_type_groups) | **GET** /report_type_groups | Retrieve all report type groups
108
-
*DefaultApi* | [**list_reports**](docs/DefaultApi.md#list_reports) | **GET** /checks/{check_id}/reports | All the reports belonging to a particular check can be listed from this endpoint.
112
+
*DefaultApi* | [**list_reports**](docs/DefaultApi.md#list_reports) | **GET** /reports | All the reports belonging to a particular check can be listed from this endpoint.
109
113
*DefaultApi* | [**list_webhooks**](docs/DefaultApi.md#list_webhooks) | **GET** /webhooks | List webhooks
*DefaultApi* | [**resume_check**](docs/DefaultApi.md#resume_check) | **POST** /checks/{check_id}/resume | Resume a Check
112
-
*DefaultApi* | [**resume_report**](docs/DefaultApi.md#resume_report) | **POST** /checks/{check_id}/reports/{report_id}/resume | This endpoint is for resuming individual paused reports.
116
+
*DefaultApi* | [**resume_report**](docs/DefaultApi.md#resume_report) | **POST** /reports/{report_id}/resume | This endpoint is for resuming individual paused reports.
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
Copy file name to clipboardExpand all lines: docs/Applicant.md
+2-13Lines changed: 2 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,22 +8,11 @@ Name | Type | Description | Notes
8
8
**delete_at** | **datetime** | The date and time when this applicant is scheduled to be deleted. Read-only. | [optional]
9
9
**href** | **str** | The uri of this resource. Read-only. | [optional]
10
10
**sandbox** | **bool** | Read-only. | [optional]
11
-
**title** | **str** | The applicant’s title | [optional]
12
11
**first_name** | **str** | The applicant’s first name | [optional]
13
-
**middle_name** | **str** | The applicant’s middle name(s) or initial | [optional]
14
12
**last_name** | **str** | The applicant’s surname | [optional]
15
-
**email** | **str** | The applicant’s email address. Required if doing a US check or a standard UK check. | [optional]
16
-
**gender** | **str** | The applicant’s gender. Valid values are male and female. | [optional]
13
+
**email** | **str** | The applicant’s email address. Required if doing a US check, or a UK check for which `applicant_provides_data` is `true`. | [optional]
17
14
**dob** | **date** | The applicant’s date of birth | [optional]
18
-
**telephone** | **str** | The applicant’s landline phone number | [optional]
19
-
**mobile** | **str** | The applicant’s mobile phone number | [optional]
20
-
**country** | **str** | The country where this applicant will be checked. This must be a three-letter ISO code e.g. GBR or USA | [optional]
21
-
**nationality** | **str** | The applicant's nationality. This must be a three-letter ISO code e.g. GBR or USA | [optional]
22
-
**mothers_maiden_name** | **str** | The applicant’s mothers maiden name | [optional]
23
-
**country_of_birth** | **str** | The applicant’s country of birth | [optional]
24
-
**town_of_birth** | **str** | The applicant’s town of birth | [optional]
25
-
**previous_last_name** | **str** | The applicant’s previous last name | [optional]
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
Copy file name to clipboardExpand all lines: docs/Check.md
+8-9Lines changed: 8 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,17 +9,16 @@ Name | Type | Description | Notes
9
9
**status** | **str** | The current state of the check in the checking process. Read-only. | [optional]
10
10
**result** | **str** | The overall result of the check, based on the results of the constituent reports. Read-only. | [optional]
11
11
**download_uri** | **str** | A link to a PDF output of the check results. Append `.pdf` to get the pdf file. Read-only. | [optional]
12
-
**form_uri** | **str** | A link to the applicant form, if the check is of type `standard`. Read-only. | [optional]
13
-
**redirect_uri** | **str** | For `standard`checks, redirect to this URI when the applicant has submitted their data. Read-only. | [optional]
12
+
**form_uri** | **str** | A link to the applicant form, if `applicant_provides_data`is `true`. Read-only. | [optional]
13
+
**redirect_uri** | **str** | For checks where `applicant_provides_data`is `true`, redirect to this URI when the applicant has submitted their data. Read-only. | [optional]
14
14
**results_uri** | **str** | A link to the corresponding results page on the Onfido dashboard. | [optional]
15
-
**type** | **str** | The type of the check, `standard` or `express`. |
16
-
**report_type_groups** | **list[str]** | Array containing ids of the Report type groups being requested for. Write-only. | [optional]
15
+
**report_names** | **list[str]** | An array of report names (strings). |[optional]
16
+
**applicant_id** | **str** | The ID of the applicant to do the check on. | [optional]
17
17
**tags** | **list[str]** | Array of tags being assigned to this check. | [optional]
18
-
**suppress_form_emails** | **bool** | For standard checks, applicant form will not be automatically sent if this is set to true. You can manually send the form at any time after the check has been created, using the link found in the form_uri attribute of the check object. Write-only. Defaults to false. | [optional]
19
-
**charge_applicant_for_check** | **bool** | For standard checks, applicants will be presented with a mandatory payment screen before they can submit the applicant form, if this is set to true. In this case, your account will not be charged. Write-only. Defaults to false. | [optional]
20
-
**brand_id** | **str** | ID of the brand under which the check should be conducted. Write-only. | [optional]
21
-
**asynchronous** | **bool** | If this is set to true, we will queue checks for processing and return a response immediately. You can configure webhooks to notify you when the report is complete. Write-only. Defaults to false. | [optional]
22
-
**reports** | [**list[Report]**](Report.md) | An array of reports. | [optional]
18
+
**applicant_provides_data** | **bool** | Send an applicant form to applicant to complete to proceed with check. Defaults to false. | [optional]
19
+
**suppress_form_emails** | **bool** | For checks where `applicant_provides_data` is `true`, applicant form will not be automatically sent if `suppress_form_emails` is set to `true`. You can manually send the form at any time after the check has been created, using the link found in the form_uri attribute of the check object. Write-only. Defaults to false. | [optional]
20
+
**asynchronous** | **bool** | Defaults to `true`. Write-only. If set to `false`, you will only receive a response when all reports in your check have completed. | [optional]
21
+
**report_ids** | **list[str]** | An array of report ids. | [optional]
23
22
24
23
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
0 commit comments