-
Notifications
You must be signed in to change notification settings - Fork 47
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Onfido Product Support
committed
Jun 25, 2024
1 parent
84b2fc2
commit 1276211
Showing
6 changed files
with
149 additions
and
118 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,53 +1,6 @@ | ||
| ONFIDO ANDROID SDK LICENSE | ||
|
|
||
| Please see the terms of your Onfido Services Agreement which you are bound by with respect to your use of the Onfido SDK. | ||
| To the extent the Onfido SDK includes copies or substantial portions of software licenced under third party terms and conditions this will be set out in https://documentation.onfido.com/sdk/android/#licensing. | ||
|
|
||
| ONFIDO ANDROID SDK LICENSE | ||
|
|
||
| 1. INTERPRETATION | ||
|
|
||
| 1.1 The definitions and rules of interpretation in this paragraph apply in this license. | ||
|
|
||
| Licensee: any natural or legal person downloading the Software from this repository. | ||
|
|
||
| Maintenance Release: a release of the Software that corrects faults, adds functionality or otherwise amends or upgrades the Software. | ||
|
|
||
| Software: The Onfido Android SDK which provides a drop-in set of screens and tools for Android applications to take document and face captures and initialise identity verification checks. | ||
|
|
||
| Source Code Materials: the source code of the Software, and all technical information and documentation required from Onfido to enable the Licensee to integrate the Software into the App. | ||
|
|
||
| Territory: Worldwide. | ||
|
|
||
| 2. LICENCE | ||
|
|
||
| 2.1 Onfido grants to the Licensee a limited scope, non-exclusive, non-transferable, irrevocable license to use the Software in the Territory, provided that: | ||
|
|
||
| 2.2.1 use of the Software will be restricted to use of the Software in object code form for the purpose of testing its document and facial recognition features and potential compatibility with an App; | ||
|
|
||
| 2.2.2 the Licensee may not use the Software other than as specified in paragraph 2.2.1 without the prior written consent of Onfido; | ||
|
|
||
| 2.2.3 the Licensee will not make backup copies of the Software; | ||
|
|
||
| 2.2.4 the Licensee has no right (and will not permit any third party) to copy, adapt, reverse engineer, decompile, disassemble, modify, adapt or make error corrections to the Software in whole or in part except for any part that is under a license that so permits; | ||
|
|
||
| 2.3 The Licensee will not use any information in relation to the integration or use of the Software to create any software whose expression is the same as or substantially similar to that of the Software nor use such information in any manner which would be restricted by any copyright subsisting in it; | ||
|
|
||
| 2.4 The Licensee will not: (1) sub-license, assign or novate the benefit or burden of this license in whole or in part; (2) allow the Software to become the subject of any charge, lien or encumbrance; or (3) deal in any other manner with any or all of its rights and obligations under this Agreement, without the prior written consent of Onfido; | ||
|
|
||
| 2.5 The Licensee will notify Onfido in writing as soon as it becomes aware of any, or suspects any unauthorized use of the Software by any person; | ||
|
|
||
| 3. MAINTENANCE | ||
|
|
||
| 3.1 Onfido will not directly provide the Licensee with any Maintenance Releases generally made available to its Clients. Maintenance releases may be made available in the repository. | ||
|
|
||
| 4. USE OF THE SOFTWARE | ||
|
|
||
| 4.1 The Licensee will only use the Software for the permitted purposes under this License. | ||
|
|
||
| 4.2 Onfido does not: (1) provide any warranties in relation to the performance of any third party software and will not be liable in the case of a fault caused in relation to the Software that arises from any other third party software, or any actions of the Licensee or a third party; (2) warrant that the use of the Software will be uninterrupted or error-free. | ||
|
|
||
| 4.3 In the event of detection of a fault or defect, the Licensee can provide information that may be necessary to assist Onfido in resolving such fault or defect, including a documented example of any fault or defect, or sufficient information to enable Onfido to re-create the fault or defect. | ||
|
|
||
| 5. INTELLECTUAL PROPERTY RIGHTS | ||
| The Licensee acknowledges that all Intellectual Property Rights in the Source Code Materials, the Software and any Maintenance Releases belong and will belong to Onfido, and the Licensee will have no rights in or to the Software other than the right to use it in accordance with the terms of this license. | ||
|
|
||
| 6. DURATION AND TERMINATION | ||
| This License will terminate on termination of the Order Form or in accordance with the terms of the Agreement, upon which (1) all rights granted to the Licensee under this license will cease; (2) the Licensee will immediately pay to Onfido any sums due to Onfido under this license (if any); and (3) the Licensee will immediately destroy or return to Onfido (at Onfido's option) all copies of the Software and related documents then in its possession, custody or control and, in the case of destruction, certify to Onfido that it has done so. | ||
| In the event of any inconsistency between the Onfido Services Agreement and any third party terms and conditions, the third party terms and conditions shall take precedence over the rights and restrictions granted in the Onfido Services Agreement solely in respect of such third party dependencies set out inside the .aar file, namely on the res/raw/onfido_licenses.json. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| ## Overview | ||
|
|
||
| [Onfido Studio](https://developers.onfido.com/guide/onfido-studio-product) is a drag and drop interface enabling you to build an optimised route to verify each end user, by defining and configuring different paths, as well as incorporating a combination of signals, in a single identity verification flow. | ||
| [Onfido Studio](https://documentation.onfido.com/getting-started/onfido-studio-product) is a drag and drop interface enabling you to build an optimised route to verify each end user, by defining and configuring different paths, as well as incorporating a combination of signals, in a single identity verification flow. | ||
|
|
||
| ## Integrating with Android SDK | ||
|
|
||
|
|
@@ -77,8 +77,8 @@ for more information. | |
|
|
||
| ### 2. Build the configuration object | ||
|
|
||
| To initialise the SDK, you must provide a workflowRunId, obtained by [creating a workflow run](https://documentation.onfido.com/#create-workflow-run), and an sdkToken, | ||
| obtained by [generating an SDK token](https://documentation.onfido.com/#generate-sdk-token). | ||
| To initialise the SDK, you must provide a workflowRunId, obtained by [creating a workflow run](https://documentation.onfido.com/api/latest/#create-workflow-run), and an sdkToken, | ||
| obtained by [generating an SDK token](https://documentation.onfido.com/api/latest/#generate-sdk-token). | ||
|
|
||
| ```kotlin | ||
| const val REQUEST_CODE = 0x05 | ||
|
|
@@ -125,7 +125,7 @@ override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) | |
|
|
||
| | ATTRIBUTE | NOTES | | ||
| |-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | onUserCompleted | The end user completed all interactive tasks in the workflow. If you have configured [webhooks](https://documentation.onfido.com/#webhooks), a notification will be sent to your backend confirming the workflow run has finished. You do not need to create a check using your backend as this is handled directly by the Workflow. | | ||
| | onUserCompleted | The end user completed all interactive tasks in the workflow. If you have configured [webhooks](https://documentation.onfido.com/api/latest/#webhooks), a notification will be sent to your backend confirming the workflow run has finished. You do not need to create a check using your backend as this is handled directly by the Workflow. | | ||
| | onUserExited | The flow was exited prematurely by the user. The reason can be an ExitCode e.g. `USER_CONSENT_DENIED` | | ||
| | onException | In case of an unexpected error, the onException method will be invoked with a relevant error message in the `WorkflowException` object. Error messages are not in a presentable format to the end user and are not localised. | | ||
|
|
||
|
|
@@ -151,9 +151,11 @@ override fun onException(exception: OnfidoWorkflow.WorkflowException) { | |
| is WorkflowUnsupportedTaskException -> | ||
| // This happens when you are using an older version of the Android SDK. You can fix this by updating the SDK | ||
| is WorkflowHttpException -> | ||
| // This happens when the SDK receives an error from an API call see [https://documentation.onfido.com/#errors](https://documentation.onfido.com/#errors) for more information | ||
| // This happens when the SDK receives an error from an API call see [https://documentation.onfido.com/api/latest/#errors](https://documentation.onfido.com/api/latest/#errors) for more information | ||
| is WorkflowUnknownException -> | ||
| // This happens when an unexpected error occurs. Please contact [[email protected]](mailto:[email protected]?Subject=ISSUE%3A) when this happens | ||
| is WorkflowAbandonedException -> | ||
| // This happens when workflow run is abandoned. In this case a new workflow run has to be created | ||
| else -> | ||
| // Necessary because of Kotlin | ||
| } | ||
|
|
@@ -164,8 +166,8 @@ override fun onException(exception: OnfidoWorkflow.WorkflowException) { | |
| ## Customizing the SDK | ||
|
|
||
| Studio uses the same appearance and localization objects as a standard integration. You can see how | ||
| to create them here: [Appearance](https://github.com/onfido/onfido-android-sdk#ui-customization) | ||
| and [Localization](https://github.com/onfido/onfido-android-sdk#localization). | ||
| to create them here: [Appearance](https://documentation.onfido.com/sdk/android/#ui-customization) | ||
| and [Localization](https://documentation.onfido.com/sdk/android/#language-localization). | ||
|
|
||
| Note: For localisation you need to use `withLocale(locale: Locale)` method of | ||
| the `WorkflowConfig.Builder` to set the preferred locale. | ||
Oops, something went wrong.