Skip to main content

SDK Configuration

Learn how to configure the GlamAR SDK to match your development environment, use case, and platform.

In Fynd Console, select your GlamAR account and open AR Try-On → SDK Configuration.

General settings​

Allowed Domains​

The Allowed Domains setting defines a list of trusted domains where the SDK is permitted to load and function. This acts as a security measure to prevent unauthorized usage of the SDK on unverified platforms. For embedded integrations, the SDK checks the configured domain list; GlamAR's public preview and Console flows are allowed separately.

The field accepts up to 500 characters. Web URLs are matched by hostname, not by scheme, port, or path.

For Web Platforms​

Enter one or more domain names where the SDK will be embedded.

  • Enter full URLs (for example, https://yourstore.com, https://test.myapp.com).
  • Separate multiple domains using commas (,).
  • Wildcards (for example, \*.example.com) are not supported.
Fynd Console General settings with example web domains
note

For local testing, add a development URL accepted by the field. A bare localhost value does not pass the current Console validation.

For Native Platforms (Android & iOS)​

For native mobile applications, enter the app bundle identifier instead of a domain name.

  • Android: Enter the application ID (for example, com.yourcompany.yourapp).
  • iOS: Enter the bundle identifier (for example, com.yourcompany.yourapp).
  • Separate multiple bundle identifiers using commas (,).

You can find your bundle identifier in build.gradle (Android) or Info.plist / Xcode project settings (iOS).

Native application identifiers in Fynd Console Allowed Domains

Preview on smartphone​

This option provides a QR code that lets you preview how your app will appear on a mobile device.

Usage:

  • Scan the QR code with your smartphone's camera to instantly open a live preview of the app.
  • Click on the Download button to share the QR code with others or embed in your testing documentation.

Purpose:
This feature helps you quickly validate mobile layouts, UI responsiveness, and device-specific behavior without deploying the app publicly.

Current smartphone preview instructions and Download button
Fynd Console smartphone preview QR code and Share link

The Share link is a unique URL that allows you or other users to preview your app in a browser.

Usage:

  • Open the link in your browser to test the app in a desktop or mobile view.
  • Use the copy icon beside the Share link to copy its URL.
  • Share the link with teammates, stakeholders, or testers for collaboration and feedback.
Fynd Console Share link guidance

Purpose:

  • Quick previews without installing the app.
  • Cross-platform testing (for example, testing browser compatibility).
  • Sharing the published experience with QA or design teams.

Use the inline preview to review unsaved form changes. The QR code and Share link open the published experience, not a separate draft deployment.

SDK version​

You can switch to a different SDK version based on your project requirements. From the dropdown list, select the version you want to use and click the Update version button to apply the change.

SDK version selection and Update version
note

The current Console version selector lists 3.0.0. Update version saves the current form as a draft, including other unsaved changes. Use Publish to apply it to the published configuration.

Best practice:

  • Always use the latest SDK version to benefit from the newest features, performance improvements, and security patches.
  • Review the Release page before updating to understand any breaking changes or new capabilities.

Language Support​

The SDK currently supports English as the default and only available language. Future updates may include additional language options to enhance accessibility for a broader audience.

The language selector is currently disabled.

English language selector

Try-on modes​

Choose how you can experience products virtually:

  • Live try-on: Uses the device's camera to overlay the selected product in real time, allowing you to see how it looks.
  • Model try-on: Displays the product on a pre-selected human model image, allowing you to preview the item without using your device's camera.

In Model try-on, you can choose from four modes:

  • Face Model: Displays the product on a human face image.
  • Hand Model: Displays the product on a hand image.
  • Finger Model: Displays the product on a finger image.
  • Hair Model: Displays the product on a hair image.
Live try-on and Model try-on switches

You can upload custom images for each mode, which will be shown during the product try-on experience.

Use Add URL or Upload File to add up to three images per tab. The uploader prevents removing its last remaining image. At least one of Live try-on or Model try-on must remain enabled.

You can also drag and drop files into the upload area. Use the trash icon beside an image to remove it when more than one image remains in that tab.

In an Add URL dialog, paste the image URL, then select Import; Cancel closes the dialog without importing. For model-image tabs, you can separate multiple URLs with spaces or newlines, within the tab's image limit. These upload actions also apply to the banner controls below.

Supported formats:

  • JPEG/JPG, PNG, WebP, BMP, JFIF, AVIF
  • Maximum file size: 5 MB per image
tip

Use high-quality, well-lit images with a neutral background for the most realistic try-on results.

Model try-on image tabs and upload controls

Watermark​

Displays a "Powered by GlamAR" watermark at the bottom of the screen. Enabled by default, this watermark can be removed with a Premium Plan.

The toggle is currently disabled in the Console; its help text identifies removal as a Premium plan capability.

Show watermark on images setting

Hero section​

Allows you to customize the banner image displayed in the SDK window. You can replace the default banner with any image that aligns with your brand or personal preference.

Usage:

  • Upload a new image file from one of the following methods:
    • Add URL: Paste the direct link to the image.
    • Upload file: Select an image from your device.
  • Supported aspect ratios: 1:1 and 16:9.
  • Supported formats: JPEG/JPG, PNG, WebP, BMP, JFIF, AVIF.
  • Maximum file size: 5 MB.

Select 1:1 to manage the mobile banner or 16:9 to manage the web banner. Each tab stores one image separately. You can also drag and drop an image into the upload area. Use the trash icon beside the current image to remove it before uploading a replacement.

Hero banner mobile and web image upload slots

Content​

Allows you to customize the text content displayed on the SDK introduction screen. You can update two text elements:

  • Header Text: The main title displayed at the top. (Maximum 40 characters)
  • Subtitle Text: The supporting text displayed beneath the header, typically used for a short description or tagline. (Maximum 100 characters)
Hero heading and subtitle fields

Appearance​

Typography​

Allows you to set a custom font for text displayed in the SDK window. Select your preferred font from the dropdown list. Currently supported fonts:

  • Inter
  • Poppins
  • Roboto
  • Open Sans
  • Lato
  • Montserrat
Default typography and theme selection

Choose Custom to upload a TTF font, up to 1 MB. Give it a name and select Add Font, then select Use to apply it. Cancel closes the naming dialog without adding the font. You can store up to three custom fonts, with one active at a time. The first upload becomes active automatically. Removing the last custom font switches typography back to Default. Select Default to return to the built-in font dropdown.

Custom font upload controls

Theme selection​

You can switch between built-in themes or create your own custom theme as per your choice.

  • Light Theme: Clean and minimal white interface.
  • Dark Theme: Sleek dark interface for immersive experiences.
  • Custom Theme: Define a personalized color scheme, ensuring the SDK matches your brand’s identity. Available options include:
    • Color scheme: Choose between Light or Dark as the base theme.
    • Primary Color: Sets the main accent color used across UI elements.
    • Icon Color: Defines the default color for icons in the interface.
    • Selection Color: Specifies the highlight color used when elements are selected.
Custom theme base scheme and brand color controls

Advance settings​

General Features​

The General Features section allows you to toggle on or off several common options in the try-on window. The available options are:

  • Show global cart: Display the global shopping cart button in the try-on window.
  • Show global wishlist: Display the global wishlist button in the try-on window.
  • Show global share: Display the global share option for quick content sharing.
  • 3D view: Enable or disable the 3D product view button in the try-on window.

Product Details​

The Product Details section allows you to toggle on or off various product-related options in the try-on window. The available options are:

  • Show add to cart: Display the Add to cart button for quick product purchasing in a try-on window.
  • Show wishlist: Display the wishlist option for saving products.
  • Show Price: Display the product price.

The cart and wishlist toggles only show their respective buttons. Connect your integration's cart and wishlist handlers to make those actions work.

General features and product-detail visibility controls

Others​

The Others section allows you to toggle several UI related options within the try-on window. These settings let you control which navigation and interface elements are available to users. The available options are:

  • Allow Back: Enable or disable the back navigation option in the try-on window.
  • Allow Close: Enable or disable the close button for exiting the try-on experience.
  • Allow Camera Switch: Enables users to switch between the front and rear cameras when accessing the try-on window through a mobile interface.
  • Allow Full-Screen: Allow the try-on window to expand to full-screen mode.
  • Allow Product Name: Display or hide the product name within the try-on window.
Navigation, camera switch, full-screen, and product-name controls

Category tools​

Select the category from the Tools dropdown. Back Camera is available under Settings for Make Up, Eyewear, Jewellery, Rings, Watches, Hair, and Nail. See Back Camera.

For each category with a Settings toggle, switch it on to show the settings button in the try-on window, then select the individual tool checkboxes you want to offer. Switching Settings off hides that button; it does not replace the separate Compare tool or Back Camera settings.

Make Up​

Compare tool​

The Compare tool lets you view a side-by-side comparison of two products directly within the try-on window. This helps in quickly evaluating differences in features, appearance, or specifications without switching screens.

Supported categories:

  • Make Up
  • Eyewear
  • Jewellery
  • Rings
  • Watches
  • Hair
  • Nail
Make Up comparison, settings, and Back Camera controls

Usage:

  • Enable the toggle to activate the Compare tool for the selected category, in this case, Make Up.
  • Click on the Publish button at the top-right corner of the window.
  • In the try-on window, click on the Compare button to generate a side-by-side comparison view.

Settings​

The Settings option provides two configurable tools to customize the makeup try-on experience:

  • Intensity tool: Adjusts the strength or opacity of the applied makeup, allowing for subtle or bold looks.
  • Pattern tool: Applies patterns or textures to the makeup for creative effects.

Supported category:

  • Make Up

Usage:

  • Enable the Settings toggle to access both the Intensity tool and Pattern tool.
  • Select the Intensity tool checkbox to enable the intensity slider in the try-on window, allowing users to adjust the makeup's opacity in real time.
  • Select the Pattern tool checkbox to apply available patterns to the makeup effect.
Back Camera​

Back Camera prefers the rear camera when the selected category starts. Switching it off prefers the front camera. Available on supported devices.

This setting does not add a camera-switch button. Use Advance settings → Allow Camera Switch to control that button separately.

Eyewear​

Compare tool​

See the Compare tool description for details. This tool is also available for the Eyewear category.

Settings​

The Settings option for Eyewear includes two tools:

  • Position adjustment tool: Allows movement of the eyewear overlay in the try-on window so it aligns correctly with the user's face.
  • Measurement tool: It calculates the pupillary distance (PD) to ensure the 3D eyewear model fits accurately in try-on mode.

Enable Settings, then select Position adjustment tool, Measurement tool, or both. The Measurement tool checkbox also reveals its instruction-banner and content controls in the Console.

Eyewear position adjustment and measurement tools
Back Camera​

Back Camera prefers the rear camera when the selected category starts. Switching it off prefers the front camera. Available on supported devices.

This setting does not add a camera-switch button. Use Advance settings → Allow Camera Switch to control that button separately.

Instructions screen​

The Instructions screen provides guidance to users during the PD measurement process. It contains two customizable sections:

A custom banner image displayed at the top of the instructions window. This allows you to add branding or visual context for your product or use case.

Eyewear measurement instruction banner upload

Image requirements:

  • Aspect ratios: 1:1 or 16:9
  • Formats: JPEG/JPG, PNG, WebP, BMP, JFIF, AVIF
  • Max file size: 5 MB

Upload methods:

  • Add URL: Click this button to add a direct link to the image.
  • Upload File: Click this button to select an image from your local storage.

The 1:1 and 16:9 tabs hold separate mobile and web banners. Each accepts one image, by URL, file selection, or drag and drop. Use the trash icon to remove the current image before adding another.

Content​

Four editable text fields to display instructions tailored to your use case or product:

  • Header Text: The main heading of the instructions screen.
  • Instruction 1: The first step or guideline.
  • Instruction 2: The second step or guideline.
  • Instruction 3: The third step or guideline.

Each field accepts up to 100 characters.

Eyewear measurement instruction text

Use these fields to provide clear, concise directions that help users complete the measurement process accurately.

tip

Keep instructions short, action-oriented, and relevant to the specific eyewear product being measured.

Jewellery​

Compare tool​

See the Compare tool description for details. This tool is also available for the Jewellery category.

Settings​

Position adjust tool​

Allows users to adjust the position of the 3D jewellery model in try-on mode. This ensures that the product aligns naturally with the user's face, neck, or ears depending on the jewellery type.

Jewellery position and camera settings

Usage:

  • Click on the Position adjustment tool checkbox.
  • Then click the Publish button on the top-right corner of the window.
  • Use the on-screen controls to fine-tune the placement of the jewellery model for a realistic preview.

The Settings toggle controls whether the settings button is shown.

Back Camera​

Back Camera prefers the rear camera when the selected category starts. Switching it off prefers the front camera. Available on supported devices.

This setting does not add a camera-switch button. Use Advance settings → Allow Camera Switch to control that button separately.

Rings​

Compare tool​

See the Compare tool description for details. This tool is also available for the Rings category.

Settings​

The Settings toggle allows you to enable or disable the settings icon in the try-on window. Once enabled, it provides access to the Position adjustment tool and Measurement tool.

Ring position and measurement tools
Position adjust tool​

Lets users adjust the position of the 3D ring model in try-on mode to ensure accurate alignment on the finger.

Measurement tool​

It measures ring fit and provides sizing guidance. The Measurement tool includes an Instructions screen for guiding users through the process.

Also set ringMeasurementFlow in Custom code to fingerOnScreen or existingRing. The category checkbox alone does not select a measurement flow.

A custom banner image displayed in the instructions window, useful for branding or providing visual guidance.

Ring measurement banner upload

Image requirements:

  • Aspect ratios: 1:1 or 16:9
  • Supported formats: JPEG/JPG, PNG, WebP, BMP, JFIF, AVIF
  • Maximum file size: 5 MB

Upload methods:

  • Add URL: Click this button to add a direct link to the image.
  • Upload File: Click this button to select an image from your local storage.

Select 1:1 for the mobile banner or 16:9 for the web banner. Each tab accepts one image and also supports drag and drop. The trash icon removes the selected banner so you can replace it.

Content​

Two editable text fields for displaying instructions:

  • Header Text: The main heading for the instructions window.
  • Sub Text: Supporting text to explain steps or provide additional guidance.

Both fields accept up to 100 characters. The Measurement tool checkbox reveals these instruction controls.

Ring measurement heading and sub text

Use these fields to provide clear, concise directions that help users complete the measurement process accurately.

Back Camera​

Back Camera prefers the rear camera when the selected category starts. Switching it off prefers the front camera. Available on supported devices.

This setting does not add a camera-switch button. Use Advance settings → Allow Camera Switch to control that button separately.

Watches​

Compare tool​

See the Compare tool description for details. This tool is also available for the Watches category.

Settings​

The Settings toggle allows you to enable or disable the settings button in the try-on window. Once enabled, it provides access to the Position adjustment tool.

Watches position and starting-camera controls
Position adjustment tool​

It enables precise adjustment of the 3D watch model in try-on mode. This ensures the product aligns naturally with the user's wrist for a realistic and accurate preview.

Usage:

  • Click on the Position adjustment tool checkbox.
  • Then click the Publish button at the top-right corner of the window.
  • Use the on-screen controls to reposition and align the watch model in real time.
Back Camera​

Back Camera prefers the rear camera when the selected category starts. Switching it off prefers the front camera. Available on supported devices.

This setting does not add a camera-switch button. Use Advance settings → Allow Camera Switch to control that button separately.

Home​

The Home category allows users to explore home decor products such as furniture, floor decor, wall decor, lighting, kitchen, and appliances in Augmented Reality (AR). This feature helps users visualize how products will look and fit within their own spaces.

Measure product​

The Measure product tool displays the configured product dimensions in the supported 3D viewing experience.

Home Measure product toggle

Usage:

  • Enable the Measure product toggle to activate this tool in the try-on window.
  • Then click the Publish button at the top-right corner of the window.
  • Use the dimension display to inspect the product measurements, and AR to preview the product in your space where supported.
note

This tool is specific to the Home category and is not available in other product types.

Hair and Nail​

The Hair and Nail categories use identical settings. Select and configure each category separately.

Compare tool​

See the Compare tool description for details. This tool is also available for the Hair and Nail categories.

Instructions screen​

The Instructions screen provides guidance to users through try-on the process. It contains two customizable sections:

A custom banner image displayed at the top of the instructions window. This allows you to add branding or visual context for your product or use case.

Hair instruction banner image controls, also available separately for Nail

Image requirements:

  • Aspect ratios: 1:1 or 16:9
  • Formats: JPEG/JPG, PNG, WebP, BMP, JFIF, AVIF
  • Max file size: 5 MB

Upload methods:

  • Add URL: Click this button to add a direct link to the image.
  • Upload File: Click this button to select an image from your local storage.

Select 1:1 for the mobile banner or 16:9 for the web banner. Each tab stores one image separately, also accepts drag and drop, and provides a trash icon to remove an uploaded image.

Content​

Four editable text fields to display instructions tailored to your use case or product:

  • Header Text: The main heading of the instructions screen.
  • Instruction 1: The first step or guideline.
  • Instruction 2: The second step or guideline.
  • Instruction 3: The third step or guideline.

Each field accepts up to 100 characters.

Hair instruction heading and three steps, also configured separately for Nail

Settings​

The Settings option allows you to control additional tools displayed within the try-on window. When enabled, a settings button appears in the try-on window, and it provides users access to configurable controls during their try-on session.

Intensity tool​

Enable the Intensity tool to display a slider within the try-on window. This slider lets users to adjust the intensity of the applied hair color or nail render in real time.

  • Increasing intensity makes the applied shade appear more vibrant.
  • Reducing intensity softens the visual effect for a more subtle look.

Disable this option if you prefer to maintain a fixed render strength without user control.

Pattern tool​

Enable the Pattern tool to allow users to switch between available hair or nail patterns (if configured). This is useful for showcasing variations such as textures, gradients, or design styles within the same product category.

When disabled, users will only see the default applied pattern.

Back Camera​

Back Camera prefers the rear camera when the selected category starts. Switching it off prefers the front camera. Available on supported devices.

This setting does not add a camera-switch button. Use Advance settings → Allow Camera Switch to control that button separately.

Hair intensity, pattern, and Back Camera controls

Custom code​

The Custom code tab is designed for advanced customization of the SDK's user interface and layout. It provides a built-in code editor where you can edit JSON configuration to tailor the UI experience beyond the predefined options available in other configuration tabs.

Use the copy icon in the editor header to copy the configuration. Keep the content valid, non-empty JSON; invalid or empty configuration is rejected when saving.

Parameter details​

The defaults below describe behavior when a key is omitted, not the values already saved for your account.

KeyTypeDefaultDescription
allowToastBooleantrueControls whether toast notifications are displayed inside the try-on window.
openLiveOnInitBooleanfalseIf set to true, the live try-on window opens automatically on initialization.
retakeRedirectStringhomeAfter clicking retake, redirects the user to the desired destination. Valid values are camera or home.
ringMeasurementFlowString—Enables Ring Measurement and selects its experience. Use fingerOnScreen to measure a finger against on-screen guides or existingRing to measure an existing ring against an on-screen guide. Missing, unsupported, and differently cased values disable the feature.
vto.allowShaderFinderBooleanfalseEnables or disables the Shade Finder feature for AR Try-On. Set this to true when the configured try-on category supports Shade Finder.
captureIQ.enabledBooleanRoute-dependentAn explicit false disables all CaptureIQ routes. Each route must also be true to use CaptureIQ; an omitted global value does not block an explicitly enabled route.
captureIQ.routes.eyePdBooleanfalseEnables or disables the CaptureIQ scan flow for EyePD.
captureIQ.routes.skinGptBooleanfalseEnables or disables the CaptureIQ scan flow for SkinGPT.
captureIQ.routes.nailColorBooleanfalseEnables or disables the CaptureIQ scan flow for nail color.
captureIQ.routes.shadeFinderBooleanfalseEnables or disables the CaptureIQ scan flow for Shade Finder.
captureIQ.routes.skinAnalysisBooleanfalseEnables or disables the CaptureIQ scan flow for Skin Analysis.
captureIQ.routes.eyewearRecommendationBooleanfalseEnables or disables the CaptureIQ scan flow for eyewear recommendation.
captureIQ.retakeRedirectStringFalls back to retakeRedirect, then homeControls whether retake takes the user to home or camera after a CaptureIQ scan flow. Valid values are camera or home.
ar.disableZoomBooleantrueDisables zoom in the 3D model viewer and uses fixed AR scale. Set to false to allow zoom and automatic AR scaling.
ar.camera.pitchLimit.enableBooleanNo custom limitApplies custom vertical camera-orbit limits when true and at least one numeric limit is supplied.
ar.camera.pitchLimit.topDownFloatNo custom top limitMinimum polar angle in degrees from above the model. Finite values are clamped to 0–179.
ar.camera.pitchLimit.bottomUpFloatNo custom bottom limitDegrees to exclude from below the model. Values are clamped to 0–179; the maximum polar angle is 180 minus this value.
popUpOverridesObject{ quit: false, result: false, restart: false }Contains toggles to enable or disable specific pop-up dialogs.
popUpOverrides.quitBooleanfalseControls the display of the quit confirmation pop-up.
popUpOverrides.resultBooleanfalseControls the display of the results pop-up after a try-on session.
popUpOverrides.restartBooleanfalseControls the display of the restart pop-up when restarting the try-on flow.
allowEyePdToastBooleantrueControls the display of the pd popup at the beginning of try-on flow.
screenOverridesObject{...}Overrides entire UI screens, enabling or disabling them.
screenOverrides.heroScreenBooleanfalseControls visibility of the hero screen in the flow.
screenOverrides.domainBlockBooleanfalseDisplays or hides the domain restriction/block screen.
screenOverrides.billingBlockBooleanfalseDisplays or hides the billing-related restriction screen.
screenOverrides.cameraFailedBooleanfalseDisplays or hides the camera failure error screen.
screenOverrides.cameraAccessDeniedBooleanfalseDisplays or hides the “Camera Access Denied” error screen.
screenOverrides.somethingWentWrongBooleanfalseDisplays or hides the generic error/fallback screen.
allowBottomSheetBooleanAllowedEnables or disables the bottom sheet UI element in the try-on window.
  • Boolean values can be set to true or false. retakeRedirect and captureIQ.retakeRedirect accept camera or home.
  • vto.allowShaderFinder enables the Shade Finder entry points, while captureIQ.routes.shadeFinder controls whether Shade Finder uses the CaptureIQ scan flow.
  • screenOverrides and popUpOverrides are nested objects: you can selectively override only the screens or pop-ups you need.
  • For screenOverrides and popUpOverrides, true suppresses the built-in UI and emits the corresponding override event. Your integration must handle the event. These flags do not bypass domain, billing, or camera restrictions.
  • Automatic live entry and some public experience overrides can keep retakes in the camera flow. Console previews and public experiences can retain their own screen and popup behavior.
Fynd Console Custom code editor and SDK preview

Saving and publishing changes​

Once all SDK configuration updates are complete, you can choose how to save your changes:

  • Reset to Default: Click Reset To Default to discard unsaved changes and reload the last saved draft. It does not restore factory defaults or revert the published configuration.
  • Save a draft: Click the Save button to save the current configuration as a draft. Drafts allow you to store settings without making them live, so you can revisit and refine them later.
  • Publish: Click the Publish button to apply and save all changes. Publishing also updates the saved draft; you do not need to Save first. Reopen the SDK experience to verify the published settings.
Reset To Default, Save, and Publish actions
tip

Use save draft method while experimenting with configurations, and only publish once you're confident that the settings are ready for production.

Configuration workflow​

  1. Set the General settings, including allowed domains and try-on modes.
  2. Configure the Hero section, Appearance, Advance settings, and Category tools for your experience.
  3. Add Custom code if needed, then follow Saving and publishing changes to apply your configuration.