iOS - UI Customization¶
The EnQualify SDK interface can be customized dynamically through the Backoffice. Visual parameters such as color, font, icon, and text are managed from the Backoffice panel without the need for code changes; the SDK automatically retrieves the updated settings every time it is started.
Info
UI customization parameters are automatically obtained by the SDK during the settingGetCompleted step. No code integration is required.
Customizable Fields¶
Colors¶
| Parameter | Description | Example |
|---|---|---|
primaryColor | Primary color — buttons, highlights, progress bar | #1A56DB |
secondaryColor | Secondary color — headings, icons | #0E3F9E |
backgroundColor | Screen background color | #FFFFFF |
textColor | General text color | #111928 |
errorColor | Error state color | #E02424 |
successColor | Success state color | #057A55 |
overlayColor | Camera overlay color and opacity | #000000 + %60 |
Typography¶
| Parameter | Description |
|---|---|
fontFamily | Font family to be used on all SDK screens |
titleFontSize | Title font size |
bodyFontSize | Body text font size |
buttonFontSize | Button text font size |
Note
If a custom font will be used, the relevant font files must be added to the application and defined in Info.plist. Otherwise, the SDK will revert to the system font.
Buttons and Shapes¶
| Parameter | Description |
|---|---|
buttonCornerRadius | Button corner rounding (pt) |
buttonBorderWidth | Button border thickness (pt) |
buttonBorderColor | Button border color |
cardCornerRadius | Corner rounding of card components |
Icons and Images¶
| Parameter | Description |
|---|---|
logoUrl | Application logo URL — displayed on waiting and completion screens |
successIconUrl | Success screen icon |
errorIconUrl | Error screen icon |
loadingAnimationUrl | Loading animation (in Lottie JSON format) |
Texts and Translation¶
All texts on SDK screens can be customized through the Backoffice. This allows supporting different languages without the need for code changes.
| Parameter | Description |
|---|---|
strings | Screen-based text definitions — in key-value format |
locale | Default language code (e.g., "TR", "EN") |
Info
The locale value can also be set with the locale parameter in BaseModel. If both are defined, the value in BaseModel takes precedence.
Screen-Based Customization¶
Each SDK screen can be configured independently in the Backoffice. The main customizable screens are:
| Screen | Customizable Elements |
|---|---|
| Welcome screen | Logo, title, description text, button color |
| ID scanning screen | Overlay color, guidance texts, frame color |
| Hologram control screen | Guidance texts, animation |
| Liveliness screen | Frame color, movement guidance texts |
| NFC reading screen | Guidance texts, icon |
| Waiting screen (VideoCall) | Logo, waiting text, animation |
| Meeting screen | Button icons, PiP size |
| Completion screen | Success/error icon, message text, button label |
Voice Guidance Customization¶
Voice guidance in SDK screens can be changed through the Backoffice. If you want to use a custom audio file, you have two methods available:
Through the Backoffice: Audio files are uploaded from the Backoffice panel, and the SDK downloads the updated files at each startup.
Through the application bundle: If you want to embed audio files into the application, you can simply add them to the bundle using the filenames recognized by the SDK. For details, see the Core Module → Audio Files Management page.
Customization Priority Order¶
If the same parameter is defined in multiple places, the SDK follows this priority order: