Customization
The Vrtx Mobile SDK supports controlled customization so clients can align the SDK experience with their brand, language, and app experience while keeping regulatory, compliance, and security controls enforced by Vrtx.
Customization is managed through an approved configuration model. The client prepares the required brand and experience inputs, and Vrtx reviews, approves, and uploads the configuration to the SDK.
Customization approval required
SDK customization is prepared by the client, but it must be reviewed and approved by Vrtx before it is uploaded to the SDK. This approval process is required to maintain regulatory compliance, product consistency, and approved financial service flows.
Customization Model
Customization covers presentation and configuration only. Financial logic, compliance processing, risk controls, and mandatory user journey requirements remain managed by Vrtx.
Client Responsibility: Prepare brand assets, colors, font name, language preferences, and supported experience requirements.
Customization Capabilities
Branding
Configure approved brand elements such as primary colors, secondary colors, and logo usage within SDK standards.
Language & Localization
Configure the SDK display language, including support for English and Arabic.
Font Customization
Use the same font family as your host app by providing the font name. The SDK automatically applies the provided font family when it is available in the host app.
Business Configuration
Retrieve approved business configuration values through the business configurations API.
Font Customization
Font customization allows the SDK to visually match the host app more closely. Instead of manually styling each SDK screen, the SDK applies the font used by the host app automatically where supported.
Font family auto-applies from the host app
The font family provided by the host app should automatically reflect in the SDK. You only need to provide the font name used by your app, and the SDK applies it when the font is available and registered in the host application.
Getting Business Configuration
Clients can retrieve their approved business configuration using the business configurations API. By default, all SDKs will have the default themes.
/businesses/configurationsThis API returns the typed business configurations for the authenticated business. The business ID is extracted from the authentication token, and the response may include configuration values such as allowed card types and SDK theme settings.
For the full API reference, see the API references
Customization Approval Flow
Prepare Requirements
The client prepares the required brand assets, color values, font name, language preferences, and supported flow configuration requests.
Submit to Vrtx
The client shares the customization package with Vrtx for review.
Vrtx Review & Approval
Vrtx reviews the requested customization against product, compliance, regulatory, security, and SDK standards.
Upload to SDK
Once approved, Vrtx uploads and enables the configuration in the SDK.
Why Vrtx approval is required
Because the SDK includes regulated financial journeys, customization cannot be applied directly by the client. Vrtx must approve and upload changes to ensure mandatory steps, compliance controls, and audit requirements remain intact.
What Can Be Customized
| Area | What Can Be Customized | Approval Required |
|---|---|---|
| Branding | Approved logo usage, primary colors, secondary colors, and visual identity elements | Yes |
| Theme | Supported light or dark mode configuration | Yes |
| Language | English or Arabic display language | Yes |
| Font family | Font name or font family used by the host app, when available and supported | Yes |
| UI styling | Supported styling changes within SDK design standards | Yes |
| Flow configuration | Supported screen or journey configuration within compliance boundaries | Yes |
| Business configuration | Approved configuration values returned through /businesses/configurations | Yes |
What Cannot Be Customized
| Area | Reason |
|---|---|
| Compliance logic | Regulatory and compliance decisioning must remain consistent |
| Mandatory onboarding steps | Required verification and KYC steps cannot be skipped |
| Risk and screening controls | Risk rules must be applied uniformly across clients |
| Financial logic | Wallet, ledger, transaction, and card logic is managed by Vrtx |
| Backend processing | Processing, settlement, and record updates remain controlled by Vrtx |
| Audit and security controls | Sessions, records, and audit trails must follow Vrtx standards |
What Vrtx Guarantees
Regardless of how the SDK is configured, the following controls are always enforced by Vrtx.
Compliance Integrity
Regulatory and compliance flows remain intact regardless of UI configuration.
Mandatory Journey Steps
Required onboarding, verification, and security steps cannot be skipped or removed.
Consistent Risk Controls
Risk and screening controls are applied consistently across all clients.
Security & Audit Readiness
Session handling, data processing, and audit trails follow Vrtx security standards.