",
requestId: requestIdTf.text,
contractTemplateId: Int(contarctTempleteIdTF.text ?? ""),
signContarctParam: contarctParametersTF.text ?? nil,
exitStep: selectedExitStep
)
let enrollVC = Enroll.initViewController(
enrollInitModel: enrollInitModel,
presenterVC: self
)
self.present(enrollVC, animated: true)
} catch {
print("Error initializing EnrollInitModel: \(error)")
}
```
***
## 5. Values Description
#### 5.1. EnrollInitModel Parameters
| Keys | Values |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `tenantId` | **Required**. Write your organization tenant id. |
| `tenantSecret` | **Required**. Write your organization tenant secret. |
| `enrollMode` | **Required**. Mode of the SDK. (See Enroll Modes). |
| `enrollEnviroment` | **Required**. Select the EnrollEnvironment: `EnrollEnvironment.STAGING` for staging and `EnrollEnvironment.PRODUCTION` for production. |
| `enrollCallback` | **Required**. Callback function to receive success and error response. |
| `localizationLanguage` | \\Required\. Select your language code: \LocalizationEnum.EN\ for English, and \LocalizationEnum.AR\ for Arabic.\
Default value is \English\.\
|
| `googleApiKey` | **Optional**. Google API Key to view the user's current location on the map. |
| `applicantId` | **Optional**. Write your Application ID (Required for `auth`, `update`, and `signContract`). |
| `levelOffTrustId` | **Optional**. Write your Organization's level of trust (Required for `auth`). |
| `skipTutorial` | **Optional**. Choose to ignore the tutorial or not. |
| `enrollColors` | **Optional**. Collection of app colors you can override: `primary`, `secondary`, `background`, `successColor`, `warningColor`, `errorColor`, `textColor`. |
| `enrollTheme` | **Optional**. Custom theme configuration with icons and colors. (See App Theme Configuration). |
| `customFontName` | **Optional**. Font resource to set your font family. |
| `correlationId` | **Optional**. Correlation ID to connect your User ID with our Request ID. |
| `contractTemplateId` | **Optional**. The ID of the contract to be signed (Required for `signContract`). |
| `signContarctParam` | **Optional**. Extra contract parameters for `signContract`. |
| `enrollForcedDocumentType` | \\Optional\. Accepts values from the \EnrollForcedDocumentType\ enum:\
- \passport\ → The user must enroll using a passport.\
- \nationalId\ → The user must enroll using a national ID.\
- \default\ → Keeps the normal flow with standard document selection screen.\
|
| `requestId` | **Optional**. Write your request ID to continue a previously initiated request (runaway) instead of starting from the beginning. |
### 5.2.EnrollColors
Define custom colors for UI components inside the framework.
| Keys | Values |
| ------------------ | ----------------------------------------------------- |
| primary | The Primary color used for all buttons and main items |
| secondary | Used for the minor views and items |
| appBackgroundColor | Used for the main background |
| textColor | Used for the text and content color |
| errorColor | Used for the error color |
| successColor | Used for the successful color |
| warningColor | Used for the warning color |
| appWhite | The main white color |
| appBlack | The main black color |
***
***
## 6. Step Types
The SDK supports the following step types defined in the `StepType` enumeration:
```swift
enum StepType {
case phoneOtp = 3
case personalConfirmation = 1
case smileLiveness = 2
case emailOtp = 4
case saveMobileDevice = 5
case deviceLocation = 6
case password = 8
case securityQuestions = 7
case amlCheck = 9
case termsAndConditions = 10
case electronicSignature = 12
case ntraCheck = 13
case csoCheck = 14
}
```
#### Step Type Details
| Step Type | Value | Description |
| ---------------------- | ----- | ---------------------------------------------------- |
| `personalConfirmation` | 1 | Personal confirmation step for identity verification |
| `smileLiveness` | 2 | Smile liveness detection to verify user is alive |
| `phoneOtp` | 3 | One-Time Password verification via phone |
| `emailOtp` | 4 | One-Time Password verification via email |
| `saveMobileDevice` | 5 | Option to save the current mobile device |
| `deviceLocation` | 6 | Device location verification step |
| `securityQuestions` | 7 | Security questions for additional verification |
| `password` | 8 | Password creation or verification step |
| `amlCheck` | 9 | Anti-Money Laundering compliance check |
| `termsAndConditions` | 10 | Terms and Conditions acceptance |
| `electronicSignature` | 12 | Electronic signature step |
| `ntraCheck` | 13 | NTRA (National Telecom Regulatory Authority) check |
| `csoCheck` | 14 | CSO (Central Security Organization) check |
***
## 7. ENROLL MODES
The SDK supports **4 modes** defined in the `EnrollMode` enum:
```swift
enum EnrollMode {
onboarding,
auth,
update,
signContract
}
```
### Mode Details
| Mode | Description | Requirements |
| -------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| `onboarding` | Registering a new user in the system. | `tenantId`, `tenantSecret` (required). |
| `auth` | Verifying the identity of an existing user. | `tenantId`, `tenantSecret`, **`applicantId`**, **`levelOffTrustId`** (all required). |
| `update` | Updating or re-verifying the identity of an existing user. | `tenantId`, `tenantSecret`, `applicantId` (required). |
| `signContract` | Signing contract templates by a user. | `tenantId`, `tenantSecret`,**`contractTemplateId,`** `applicantId`(required). Optional: `signContarctParam`. |
## 8- Security Notes
* Never hardcode `tenantSecret`, `levelOfTrustToken`, or API keys inside the mobile application. Use a secure storage mechanism (e.g., Keychain on iOS, Keystore on Android).
* Regularly update the SDK to the latest stable version for security patches.
* Rooted devices are blocked by default for security reasons.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://lumin-soft.gitbook.io/ekyc/integration-guide/mobile-plugin/enroll-ios-framework.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
