Commit 3d3cebed authored by Javohir Savriy's avatar Javohir Savriy
Browse files

Update README.md

parent f06dd578
......@@ -18,7 +18,7 @@
### 1.1 Before you begin
Install or update Xcode to its latest version.
The SDK supports iOS 12+. The SDK has been built on Xcode 14.1 using Swift 5.8
The SDK supports iOS 13+. The SDK has been built on Xcode 14.1 using Swift 5.8
### 1.2 Add the SDK dependency
......@@ -40,7 +40,7 @@ dependencies: [
The SDK is available on Cocoapods and you can include it in your projects by adding the following to your Podfile:
```ruby
pod 'MyIdSDK', '~> 2.3.6'
pod 'MyIdSDK', '~> 2.3.7'
```
Run `pod install` to get the SDK.
......@@ -76,7 +76,7 @@ class ViewController : UIViewController {
config.clientHashId = /* Your Client Hash ID */
config.passportData = passportData
config.dateOfBirth = dateOfBirth
config.buildMode = MyIdBuildMode.PRODUCTION
config.environment = .production
MyIdClient.start(withConfig: config, withDelegate: self)
}
......@@ -112,22 +112,20 @@ extension ViewController: MyIdClientDelegate {
Option | Notes | Default
--- | --- | ---
`clientId` | Client ID | Provided by MyID sales team. Mandatory, if using entryType = MyIdEntryType.AUTH
`clientHash` | Client Hash | Provided by MyID sales team. Mandatory, if using entryType = MyIdEntryType.AUTH
`clientHashId` | Client Hash ID | Provided by MyID sales team. Mandatory, if using entryType = MyIdEntryType.AUTH
`clientId` | Client ID | Provided by MyID sales team. Mandatory, if using entryType = MyIdEntryType.identification
`clientHash` | Client Hash | Provided by MyID sales team. Mandatory, if using entryType = MyIdEntryType.identification
`clientHashId` | Client Hash ID | Provided by MyID sales team. Mandatory, if using entryType = MyIdEntryType.identification
`passportData` | Passport serial number or PINFL data | Optional
`dateOfBirth` | Date of birth in. Format: `dd.MM.yyyy` | Optional
`minAge` | To set a specific minimum age to use MyID service | 16
`sdkHash` | 32 characters long string (Note 1.2) | Optional
`externalId` | 36 characters long. Should match with UUID4 regex (Note 1.3) | Optional
`threshold` | The value can be in the range of `0.55` - `0.99` | 0.55
`buildMode` | Build mode (Note 1.4) | MyIdBuildMode.PRODUCTION
`entryType` | Customizing the SDK Entry types (Note 1.5) | MyIdEntryType.AUTH
`residency` | To set a specific resident type | MyIdResidentType.RESIDENT
`locale` | To set a specific locale | MyIdLocale.UZ
`cameraShape` | To set a specific camera shape (Note 1.6) | MyIdCameraShape.CIRCLE
`resolution` | To set a specific camera resolution | MyIdResolution.RESOLUTION_480
`withPhoto` | Return SDK face image | false
`environment` | Environment mode (Note 1.4) | MyIdEnvironment.production
`entryType` | Customizing the SDK entry types (Note 1.5) | MyIdEntryType.identification
`residency` | To set a specific residency type | MyIdResidency.resident
`locale` | To set a specific locale | MyIdLocale.uzbek
`cameraShape` | To set a specific camera shape (Note 1.6) | MyIdCameraShape.circle
**Note 1.1.** You can customize the screen for entering passport data and date of birth in your
application, in which case you can pass these parameters during initialization to the SDK, otherwise
......@@ -137,26 +135,20 @@ the SDK requires the input of passport data and date of birth for user identific
provided, we will continue showing the credentials screen.
**Note 1.3.** If the `externalId` is not empty, has a length of 36 characters and corresponds to the
regular expression UUID4, we will not display a [recommendation](images/screen01.jpg) screen. If a certain number of unsuccessful identification attempts (currently set to 5) occur in MyID within one hour and the `externalId` is not empty, SDK returns to the parent app error message or TTL as `message` in `MyIdException`.
regular expression UUID4, we will not display a [recommendation](images/screen01.jpg) screen. If a certain number of unsuccessful identification attempts (currently set to 5) occur in MyID within one hour and the `externalId` is not empty, SDK returns to the parent app error message as `message` in `MyIdException`.
TTL error example:
**Note 1.4.** `MyIdEnvironment` contains **debug** and **production** modes.
```json
{"ttl": 362}
```
**Note 1.4.** `MyIdBuildMode` contains **DEBUG** and **PRODUCTION** modes.
- **DEBUG** is used to sandbox.
- **PRODUCTION** is used to production.
- **debug** is used to sandbox.
- **production** is used to production.
**Note 1.5.** `MyIdEntryType` contains **AUTH** and **FACE** types.
**Note 1.5.** `MyIdEntryType` contains **identification** and **faceDetection** types.
- **AUTH** is used to identify the user through the MyID services.
- **FACE** is used to detect a face and returns a picture (bitmap).
- **identification** is used to identify the user through the MyID services.
- **faceDetection** is used to detect a face and returns a picture (bitmap).
**Note 1.6.** `MyIdCameraShape` contains **[CIRCLE](images/screen03.jpg)**
and **[ELLIPSE](images/screen04.jpg)** types.
**Note 1.6.** `MyIdCameraShape` contains **[circle](images/screen03.jpg)**
and **[ellipse](images/screen04.jpg)** types.
### 2.2 MyIdClientDelegate
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment