-
Notifications
You must be signed in to change notification settings - Fork 144
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
1 parent
b8099af
commit f27b5ca
Showing
49 changed files
with
5,549 additions
and
2,504 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 |
---|---|---|
|
@@ -10,10 +10,44 @@ This project adheres to the Node [default version scheme](https://docs.npmjs.com | |
|
||
### Changed | ||
|
||
## [13.6.1] - 2023-10-24 | ||
## [13.8.2] - 2024-01-23 | ||
|
||
### Changed | ||
|
||
## [13.8.1] - 2024-01-17 | ||
|
||
### Fixed | ||
|
||
- Removed check for audio permission in webview. | ||
|
||
## [13.8.0] - 2024-01-02 | ||
|
||
### Changed | ||
|
||
- Removed migrate_locales scripts. | ||
- Removed performance benchmark | ||
|
||
### Fixed | ||
|
||
- Fix validation for Indonesia ID number | ||
- Fix National ID Number semantic type and display | ||
|
||
## [13.7.0] - 2023-11-08 | ||
|
||
### Added | ||
|
||
- Added `permissions_unavailable` error type to the `onError` callback | ||
|
||
### Changed | ||
|
||
- Update camera icon for Document upload | ||
|
||
### Fixed | ||
|
||
- Disable Picture-in-Picture tooltip during Face capture | ||
|
||
## [13.6.1] - 2023-10-24 | ||
|
||
### Fixed | ||
|
||
- Fix disabled submit button in country selection in PoA step | ||
|
@@ -1652,7 +1686,11 @@ Install with `npm install [email protected]` | |
|
||
- NPM (commonjs2) style of importing the library now works | ||
|
||
[next-version]: https://github.com/onfido/onfido-sdk-ui/compare/13.6.1...development | ||
[next-version]: https://github.com/onfido/onfido-sdk-ui/compare/13.8.2...development | ||
[13.8.2]: https://github.com/onfido/onfido-sdk-ui/compare/13.8.1...13.8.2 | ||
[13.8.1]: https://github.com/onfido/onfido-sdk-ui/compare/13.8.0...13.8.1 | ||
[13.8.0]: https://github.com/onfido/onfido-sdk-ui/compare/13.7.0...13.8.0 | ||
[13.7.0]: https://github.com/onfido/onfido-sdk-ui/compare/13.6.1...13.7.0 | ||
[13.6.1]: https://github.com/onfido/onfido-sdk-ui/compare/13.6.0...13.6.1 | ||
[13.6.0]: https://github.com/onfido/onfido-sdk-ui/compare/13.5.1...13.6.0 | ||
[13.5.1]: https://github.com/onfido/onfido-sdk-ui/compare/13.5.0...13.5.1 | ||
|
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 |
---|---|---|
|
@@ -12,13 +12,14 @@ | |
- [Removing the SDK](#removing-the-sdk) | ||
- [Initialization options](#initialization-options) | ||
- [Customizing the SDK](#customizing-the-sdk) | ||
- [Creating checks](#creating-checks) | ||
- [Generating verification reports](#generating-verification-reports) | ||
- [User Analytics](#user-analytics) | ||
- [Premium Enterprise Features](#premium-enterprise-features) | ||
- [Going live](#going-live) | ||
- [Accessibility](#accessibility) | ||
- [TypeScript](#typescript) | ||
- [More information](#more-information) | ||
- [Raise support issue](#support) | ||
|
||
## Overview | ||
|
||
|
@@ -31,7 +32,7 @@ The SDK offers a number of benefits to help you create the best identity verific | |
- Advanced image quality detection technology to ensure the quality of the captured images meets the requirement of the Onfido identity verification process, guaranteeing the best success rate | ||
- Direct image upload to the Onfido service, to simplify integration | ||
|
||
⚠️ Note: the SDK is only responsible for capturing photos, videos, and motion captures. You still need to access the [Onfido API](https://documentation.onfido.com/) to manage applicants and perform checks. | ||
⚠️ Note: The SDK is only responsible for capturing and uploading document photos, live selfies, live videos and motion captures. You still need to access the [Onfido API](https://documentation.onfido.com/) to manage applicants and [Onfido Studio](https://developers.onfido.com/guide/onfido-studio-product) to build verification workflows. | ||
|
||
![Various views from the SDK](demo/screenshots.jpg) | ||
|
||
|
@@ -307,6 +308,17 @@ Callback that fires when an error occurs. The callback returns the following err | |
} | ||
``` | ||
|
||
- `permissions_unavailable` | ||
|
||
`permissions_unavailable` will be returned if the SDK was unable to access or request the necessary permissions. This may occur when the web SDK is loaded within a webview or other custom browsers. | ||
|
||
```javascript | ||
{ | ||
type: "permissions_unavailable", | ||
message: "Unable to retrieve or access required user permissions" | ||
} | ||
``` | ||
|
||
### `onUserExit {Function} optional` | ||
|
||
Callback that fires when the user abandons the flow without completing it. | ||
|
@@ -864,25 +876,17 @@ onfidoOut.setOptions({ isModalOpen:true }); | |
|
||
The new options will be shallowly merged with the previous one, so you can only pass the differences to a get a new flow. | ||
|
||
## Creating checks | ||
## Generating verification reports | ||
|
||
The SDK is responsible for the capture of identity documents and selfie photos, videos, and motion captures. It doesn't perform any checks against the [Onfido API](https://documentation.onfido.com/). You need to access the Onfido API in order to manage applicants and perform checks. | ||
While the SDK is responsible for capturing and uploading document photos, live selfies, live videos and motion captures, identity verification reports themselves are generated based on workflows created using [Onfido Studio](https://developers.onfido.com/guide/onfido-studio-product). | ||
|
||
### 1. Creating a check | ||
For a step-by-step walkthrough of creating an identity verification using Onfido Studio and our SDKs, please refer to our [Quick Start Guide](https://developers.onfido.com/guide/quick-start-guide). | ||
|
||
For a walkthrough of how to create a document and facial similarity check using the Web SDK read our [Web SDK Quick Start guide](https://developers.onfido.com/guide/web-sdk-quick-start). | ||
Alternatively, you can [create checks](https://documentation.onfido.com/#create-check) and [retrieve report results](https://documentation.onfido.com/#retrieve-report) manually using the Onfido API. You can also configure [webhooks](https://documentation.onfido.com/#webhooks) to be notified asynchronously of report results. | ||
|
||
For further details on how to [create a check](https://documentation.onfido.com/#create-check) with the Onfido API. | ||
**Note**: If you are currently using API `v2` for API calls, please refer to [this migration guide](https://developers.onfido.com/guide/api-v2-to-v3-migration-guide) for more information. | ||
|
||
Note: If you are testing with a sandbox token, please be aware that the results are pre-determined. You can learn more about [sandbox responses](https://documentation.onfido.com/#pre-determined-responses). | ||
|
||
Note: If you are currently using API `v2` please refer to [this migration guide](https://developers.onfido.com/guide/api-v2-to-v3-migration-guide) for more information. | ||
|
||
### 2. Setting up webhooks | ||
|
||
Reports may not always return actual [results](https://documentation.onfido.com/#results) straightaway. | ||
|
||
You can [set up webhooks](https://developers.onfido.com/guide/get-started-integrating#set-up-a-webhook) to be notified upon completion of a check or report, or both. | ||
**Note**: If you are testing with a sandbox token, please be aware that report results are pre-determined. You can learn more about sandbox responses [here](https://documentation.onfido.com/#pre-determined-responses). | ||
|
||
## User Analytics | ||
|
||
|
@@ -1049,7 +1053,11 @@ If embedded inside a cross-origin iframe, the SDK may fail to access the camera | |
|
||
Onfido Web SDK versions <13.0.0 have a parameter named `uploadFallback` that can be set on both the document step and the face step. This parameter allowed clients to present end-users with a file input capability during the SDK flow. This client-side optional parameter has been removed in Web SDK 13 and above to enhance security which means users will not have the option to upload files during the SDK flow. However, file upload can be enabled as an option for end-users as a backend configuration if requested through the Onfido Support Team. | ||
|
||
### Support | ||
#### Permissions issues when using the web SDK in a webview | ||
|
||
For recommendations and code samples on how to embed the Onfido web SDK in a webview, please refer to the guide [Using the Onfido web SDK in a webview](https://developers.onfido.com/guide/sdk-webview-guide) available on Developer Hub. | ||
|
||
## Support | ||
|
||
Should you encounter any technical issues during integration, please contact Onfido's Customer Support team via [email](mailto:[email protected]), including the word ISSUE: at the start of the subject line. | ||
|
||
|
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 |
---|---|---|
|
@@ -8997,7 +8997,7 @@ | |
"path": "node_modules/socket.io-client", | ||
"licenseFile": "node_modules/socket.io-client/LICENSE" | ||
}, | ||
"socket.io-parser@4.0.5": { | ||
"socket.io-parser@4.2.4": { | ||
"licenses": "MIT", | ||
"repository": "https://github.com/socketio/socket.io-parser", | ||
"path": "node_modules/socket.io-parser", | ||
|
@@ -10300,7 +10300,7 @@ | |
"path": "node_modules/wildcard", | ||
"licenseFile": "node_modules/wildcard/README.md" | ||
}, | ||
"[email protected].3": { | ||
"[email protected].4": { | ||
"licenses": "MIT", | ||
"repository": "https://github.com/jonschlinkert/word-wrap", | ||
"publisher": "Jon Schlinkert", | ||
|
Oops, something went wrong.