Skip to content
This repository was archived by the owner on Nov 16, 2021. It is now read-only.

Commit 9421491

Browse files
author
Engineering at Onfido
committed
New client release: 2.0.0
1 parent 17cb78b commit 9421491

76 files changed

Lines changed: 8214 additions & 4027 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

LICENSE

Lines changed: 21 additions & 201 deletions
Original file line numberDiff line numberDiff line change
@@ -1,201 +1,21 @@
1-
Apache License
2-
Version 2.0, January 2004
3-
http://www.apache.org/licenses/
4-
5-
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6-
7-
1. Definitions.
8-
9-
"License" shall mean the terms and conditions for use, reproduction,
10-
and distribution as defined by Sections 1 through 9 of this document.
11-
12-
"Licensor" shall mean the copyright owner or entity authorized by
13-
the copyright owner that is granting the License.
14-
15-
"Legal Entity" shall mean the union of the acting entity and all
16-
other entities that control, are controlled by, or are under common
17-
control with that entity. For the purposes of this definition,
18-
"control" means (i) the power, direct or indirect, to cause the
19-
direction or management of such entity, whether by contract or
20-
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21-
outstanding shares, or (iii) beneficial ownership of such entity.
22-
23-
"You" (or "Your") shall mean an individual or Legal Entity
24-
exercising permissions granted by this License.
25-
26-
"Source" form shall mean the preferred form for making modifications,
27-
including but not limited to software source code, documentation
28-
source, and configuration files.
29-
30-
"Object" form shall mean any form resulting from mechanical
31-
transformation or translation of a Source form, including but
32-
not limited to compiled object code, generated documentation,
33-
and conversions to other media types.
34-
35-
"Work" shall mean the work of authorship, whether in Source or
36-
Object form, made available under the License, as indicated by a
37-
copyright notice that is included in or attached to the work
38-
(an example is provided in the Appendix below).
39-
40-
"Derivative Works" shall mean any work, whether in Source or Object
41-
form, that is based on (or derived from) the Work and for which the
42-
editorial revisions, annotations, elaborations, or other modifications
43-
represent, as a whole, an original work of authorship. For the purposes
44-
of this License, Derivative Works shall not include works that remain
45-
separable from, or merely link (or bind by name) to the interfaces of,
46-
the Work and Derivative Works thereof.
47-
48-
"Contribution" shall mean any work of authorship, including
49-
the original version of the Work and any modifications or additions
50-
to that Work or Derivative Works thereof, that is intentionally
51-
submitted to Licensor for inclusion in the Work by the copyright owner
52-
or by an individual or Legal Entity authorized to submit on behalf of
53-
the copyright owner. For the purposes of this definition, "submitted"
54-
means any form of electronic, verbal, or written communication sent
55-
to the Licensor or its representatives, including but not limited to
56-
communication on electronic mailing lists, source code control systems,
57-
and issue tracking systems that are managed by, or on behalf of, the
58-
Licensor for the purpose of discussing and improving the Work, but
59-
excluding communication that is conspicuously marked or otherwise
60-
designated in writing by the copyright owner as "Not a Contribution."
61-
62-
"Contributor" shall mean Licensor and any individual or Legal Entity
63-
on behalf of whom a Contribution has been received by Licensor and
64-
subsequently incorporated within the Work.
65-
66-
2. Grant of Copyright License. Subject to the terms and conditions of
67-
this License, each Contributor hereby grants to You a perpetual,
68-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69-
copyright license to reproduce, prepare Derivative Works of,
70-
publicly display, publicly perform, sublicense, and distribute the
71-
Work and such Derivative Works in Source or Object form.
72-
73-
3. Grant of Patent License. Subject to the terms and conditions of
74-
this License, each Contributor hereby grants to You a perpetual,
75-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76-
(except as stated in this section) patent license to make, have made,
77-
use, offer to sell, sell, import, and otherwise transfer the Work,
78-
where such license applies only to those patent claims licensable
79-
by such Contributor that are necessarily infringed by their
80-
Contribution(s) alone or by combination of their Contribution(s)
81-
with the Work to which such Contribution(s) was submitted. If You
82-
institute patent litigation against any entity (including a
83-
cross-claim or counterclaim in a lawsuit) alleging that the Work
84-
or a Contribution incorporated within the Work constitutes direct
85-
or contributory patent infringement, then any patent licenses
86-
granted to You under this License for that Work shall terminate
87-
as of the date such litigation is filed.
88-
89-
4. Redistribution. You may reproduce and distribute copies of the
90-
Work or Derivative Works thereof in any medium, with or without
91-
modifications, and in Source or Object form, provided that You
92-
meet the following conditions:
93-
94-
(a) You must give any other recipients of the Work or
95-
Derivative Works a copy of this License; and
96-
97-
(b) You must cause any modified files to carry prominent notices
98-
stating that You changed the files; and
99-
100-
(c) You must retain, in the Source form of any Derivative Works
101-
that You distribute, all copyright, patent, trademark, and
102-
attribution notices from the Source form of the Work,
103-
excluding those notices that do not pertain to any part of
104-
the Derivative Works; and
105-
106-
(d) If the Work includes a "NOTICE" text file as part of its
107-
distribution, then any Derivative Works that You distribute must
108-
include a readable copy of the attribution notices contained
109-
within such NOTICE file, excluding those notices that do not
110-
pertain to any part of the Derivative Works, in at least one
111-
of the following places: within a NOTICE text file distributed
112-
as part of the Derivative Works; within the Source form or
113-
documentation, if provided along with the Derivative Works; or,
114-
within a display generated by the Derivative Works, if and
115-
wherever such third-party notices normally appear. The contents
116-
of the NOTICE file are for informational purposes only and
117-
do not modify the License. You may add Your own attribution
118-
notices within Derivative Works that You distribute, alongside
119-
or as an addendum to the NOTICE text from the Work, provided
120-
that such additional attribution notices cannot be construed
121-
as modifying the License.
122-
123-
You may add Your own copyright statement to Your modifications and
124-
may provide additional or different license terms and conditions
125-
for use, reproduction, or distribution of Your modifications, or
126-
for any such Derivative Works as a whole, provided Your use,
127-
reproduction, and distribution of the Work otherwise complies with
128-
the conditions stated in this License.
129-
130-
5. Submission of Contributions. Unless You explicitly state otherwise,
131-
any Contribution intentionally submitted for inclusion in the Work
132-
by You to the Licensor shall be under the terms and conditions of
133-
this License, without any additional terms or conditions.
134-
Notwithstanding the above, nothing herein shall supersede or modify
135-
the terms of any separate license agreement you may have executed
136-
with Licensor regarding such Contributions.
137-
138-
6. Trademarks. This License does not grant permission to use the trade
139-
names, trademarks, service marks, or product names of the Licensor,
140-
except as required for reasonable and customary use in describing the
141-
origin of the Work and reproducing the content of the NOTICE file.
142-
143-
7. Disclaimer of Warranty. Unless required by applicable law or
144-
agreed to in writing, Licensor provides the Work (and each
145-
Contributor provides its Contributions) on an "AS IS" BASIS,
146-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147-
implied, including, without limitation, any warranties or conditions
148-
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149-
PARTICULAR PURPOSE. You are solely responsible for determining the
150-
appropriateness of using or redistributing the Work and assume any
151-
risks associated with Your exercise of permissions under this License.
152-
153-
8. Limitation of Liability. In no event and under no legal theory,
154-
whether in tort (including negligence), contract, or otherwise,
155-
unless required by applicable law (such as deliberate and grossly
156-
negligent acts) or agreed to in writing, shall any Contributor be
157-
liable to You for damages, including any direct, indirect, special,
158-
incidental, or consequential damages of any character arising as a
159-
result of this License or out of the use or inability to use the
160-
Work (including but not limited to damages for loss of goodwill,
161-
work stoppage, computer failure or malfunction, or any and all
162-
other commercial damages or losses), even if such Contributor
163-
has been advised of the possibility of such damages.
164-
165-
9. Accepting Warranty or Additional Liability. While redistributing
166-
the Work or Derivative Works thereof, You may choose to offer,
167-
and charge a fee for, acceptance of support, warranty, indemnity,
168-
or other liability obligations and/or rights consistent with this
169-
License. However, in accepting such obligations, You may act only
170-
on Your own behalf and on Your sole responsibility, not on behalf
171-
of any other Contributor, and only if You agree to indemnify,
172-
defend, and hold each Contributor harmless for any liability
173-
incurred by, or claims asserted against, such Contributor by reason
174-
of your accepting any such warranty or additional liability.
175-
176-
END OF TERMS AND CONDITIONS
177-
178-
APPENDIX: How to apply the Apache License to your work.
179-
180-
To apply the Apache License to your work, attach the following
181-
boilerplate notice, with the fields enclosed by brackets "{}"
182-
replaced with your own identifying information. (Don't include
183-
the brackets!) The text should be enclosed in the appropriate
184-
comment syntax for the file format. We also recommend that a
185-
file or class name and description of purpose be included on the
186-
same "printed page" as the copyright notice for easier
187-
identification within third-party archives.
188-
189-
Copyright {yyyy} {name of copyright owner}
190-
191-
Licensed under the Apache License, Version 2.0 (the "License");
192-
you may not use this file except in compliance with the License.
193-
You may obtain a copy of the License at
194-
195-
http://www.apache.org/licenses/LICENSE-2.0
196-
197-
Unless required by applicable law or agreed to in writing, software
198-
distributed under the License is distributed on an "AS IS" BASIS,
199-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200-
See the License for the specific language governing permissions and
201-
limitations under the License.
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2019 Onfido
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

README.md

Lines changed: 43 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
# onfido
22
The Onfido API is used to submit check requests.
33

4-
This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
4+
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
55

66
- API version: 2.0.0
7-
- Package version: 1.6.0
8-
- Build date: 2019-02-05T13:51:16.261Z
9-
- Build package: class io.swagger.codegen.languages.PythonClientCodegen
7+
- Package version: 2.0.0
8+
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
109

1110
## Requirements.
1211

@@ -24,7 +23,7 @@ pip install git+https://github.com/onfido/api-python-client.git
2423

2524
Then import the package:
2625
```python
27-
import onfido
26+
import onfido
2827
```
2928

3029
### Setuptools
@@ -46,26 +45,23 @@ import onfido
4645
Please follow the [installation procedure](#installation--usage) and then run the following:
4746

4847
```python
49-
from __future__ import print_function
50-
import time
48+
import sys
5149
import onfido
52-
from onfido.rest import ApiException
50+
import datetime
5351
from pprint import pprint
52+
from onfido.rest import ApiException
5453

55-
# Configure API key authorization: Token
56-
onfido.configuration.api_key['Authorization'] = 'token=' + 'YOUR_API_KEY'
57-
onfido.configuration.api_key_prefix['Authorization'] = 'Token'
54+
configuration = onfido.Configuration()
55+
configuration.api_key['Authorization'] = 'token=' + 'YOUR API TOKEN'
56+
configuration.api_key_prefix['Authorization'] = 'Token'
5857

5958
# Limit the at-rest region, if needed (optional, see https://documentation.onfido.com/#regions)
60-
onfido.configuration.region = 'YOUR_REGION'
59+
# configuration.host = configuration.get_host_from_settings(1, {'region': 'us'})
6160

62-
# create an instance of the API class
63-
api_instance = onfido.DefaultApi()
61+
api = onfido.DefaultApi(onfido.ApiClient(configuration))
6462

65-
# setting applicant details
66-
applicant = onfido.Applicant()
67-
applicant.first_name = 'John'
68-
applicant.last_name = 'Smith'
63+
# Setting applicant details
64+
applicant = onfido.Applicant(first_name='John', last_name='Smith')
6965
applicant.dob = datetime.date(1980, 1, 22)
7066
applicant.country = 'GBR'
7167

@@ -76,23 +72,18 @@ address.town = 'London'
7672
address.postcode = 'SW4 6EH'
7773
address.country = 'GBR'
7874

79-
applicant.addresses = [address]
80-
81-
# setting check request details
82-
check = onfido.CheckCreationRequest()
83-
check.type = 'express'
75+
applicant.addresses = [address];
8476

85-
report = onfido.Report()
86-
report.name = 'identity'
87-
88-
check.reports = [report]
77+
# Setting check details
78+
check = onfido.Check(type='express')
79+
report = onfido.Report(name='identity')
80+
check.reports = [report];
8981

9082
try:
91-
# Create Applicant
92-
api_response = api_instance.create_applicant(data=applicant)
93-
applicant_id = api_response.id
94-
api_response = api_instance.create_check(applicant_id, data=check)
95-
pprint(api_response)
83+
applicant_data = api.create_applicant(applicant)
84+
applicant_id = applicant_data.id
85+
check_data = api.create_check(applicant_id, check)
86+
pprint(check_data)
9687
except ApiException as e:
9788
pprint(e.body)
9889

@@ -116,15 +107,13 @@ Class | Method | HTTP request | Description
116107
*DefaultApi* | [**find_check**](docs/DefaultApi.md#find_check) | **GET** /applicants/{applicant_id}/checks/{check_id} | Retrieve a Check
117108
*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.
118109
*DefaultApi* | [**find_live_photo**](docs/DefaultApi.md#find_live_photo) | **GET** /live_photos/{live_photo_id} | Retrieve live photo
119-
*DefaultApi* | [**find_live_video**](docs/DefaultApi.md#find_live_video) | **GET** /live_videos/{live_video_id} | Retrieve live video
120110
*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.
121111
*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
122112
*DefaultApi* | [**find_webhook**](docs/DefaultApi.md#find_webhook) | **GET** /webhooks/{webhook_id} | Retrieve a Webhook
123113
*DefaultApi* | [**list_applicants**](docs/DefaultApi.md#list_applicants) | **GET** /applicants | List Applicants
124114
*DefaultApi* | [**list_checks**](docs/DefaultApi.md#list_checks) | **GET** /applicants/{applicant_id}/checks | Retrieve Checks
125115
*DefaultApi* | [**list_documents**](docs/DefaultApi.md#list_documents) | **GET** /applicants/{applicant_id}/documents | List documents
126116
*DefaultApi* | [**list_live_photos**](docs/DefaultApi.md#list_live_photos) | **GET** /live_photos | List live photos
127-
*DefaultApi* | [**list_live_videos**](docs/DefaultApi.md#list_live_videos) | **GET** /live_videos | List live videos
128117
*DefaultApi* | [**list_report_type_groups**](docs/DefaultApi.md#list_report_type_groups) | **GET** /report_type_groups | Retrieve all report type groups
129118
*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.
130119
*DefaultApi* | [**list_webhooks**](docs/DefaultApi.md#list_webhooks) | **GET** /webhooks | List webhooks
@@ -142,7 +131,8 @@ Class | Method | HTTP request | Description
142131
- [Applicant](docs/Applicant.md)
143132
- [ApplicantsList](docs/ApplicantsList.md)
144133
- [Check](docs/Check.md)
145-
- [CheckCreationRequest](docs/CheckCreationRequest.md)
134+
- [CheckCommon](docs/CheckCommon.md)
135+
- [CheckWithReportIds](docs/CheckWithReportIds.md)
146136
- [ChecksList](docs/ChecksList.md)
147137
- [Document](docs/Document.md)
148138
- [DocumentsList](docs/DocumentsList.md)
@@ -152,14 +142,29 @@ Class | Method | HTTP request | Description
152142
- [IdNumber](docs/IdNumber.md)
153143
- [LivePhoto](docs/LivePhoto.md)
154144
- [LivePhotosList](docs/LivePhotosList.md)
155-
- [LiveVideo](docs/LiveVideo.md)
156-
- [LiveVideosList](docs/LiveVideosList.md)
157145
- [Report](docs/Report.md)
146+
- [ReportDocument](docs/ReportDocument.md)
147+
- [ReportOption](docs/ReportOption.md)
158148
- [ReportType](docs/ReportType.md)
159149
- [ReportTypeGroup](docs/ReportTypeGroup.md)
160150
- [ReportTypeGroupsList](docs/ReportTypeGroupsList.md)
161-
- [ReportTypeOption](docs/ReportTypeOption.md)
162151
- [ReportsList](docs/ReportsList.md)
163152
- [Webhook](docs/Webhook.md)
164153
- [WebhooksList](docs/WebhooksList.md)
165154

155+
156+
## Documentation For Authorization
157+
158+
159+
## Token
160+
161+
- **Type**: API key
162+
- **API key parameter name**: Authorization
163+
- **Location**: HTTP header
164+
165+
166+
## Author
167+
168+
169+
170+

docs/Address.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ Name | Type | Description | Notes
1111
**town** | **str** | The town of the applicant’s address | [optional]
1212
**postcode** | **str** | The postcode or ZIP of the applicant’s address | [optional]
1313
**country** | **str** | The 3 character ISO country code of this address. For example, GBR is the country code for the United Kingdom | [optional]
14-
**id** | **str** | | [optional]
1514
**start_date** | **date** | The date the applicant started living at this address | [optional]
1615
**end_date** | **date** | The date the applicant left this address. If current residence, leave null | [optional]
1716
**state** | **str** | The address state. US states must use the USPS abbreviation (see also ISO 3166-2:US), for example AK, CA, or TX. | [optional]

0 commit comments

Comments
 (0)