Illuminate Support

Illuminate is a product digitization platform introduced by Digimarc in 2023. Digital watermarks configured in Illuminate can be read by the Mobile SDK but are encrypted and must be passed to the platform before data can be retrieved. This communication is handled automatically by the SDK but requires an authorized Account ID and Mobile API key as well as one or more requested fields to be successful. These items, as well as other options, can be specified in the IlluminateSessionParams class.

For information about getting and using a Mobile API key, including the base URL and available endpoints, see Using the Illuminate APIs in the Illuminate Account Administrator's Guide.

To download the guide:

1. Log in to the  Digimarc Illuminate Platform (https://digimarc.app) using a user account with the Account Administrator role.
2. Click the Help icon (  ), click User Guides, and click Account Administrator.

Compatible Fields

If configured in Illuminate, the redirectUrl field returns a URL associated with the digital watermark that was read. You can also get custom attributes. See the Mobile API reference documentation for a complete list of available fields.