Quickstart flow

This guide shows you how to implement the most simple consent banner with the Usercentrics App CMP.
It covers only the default setup needed to display a banner and collect your first user consent.

The App SDK architecture includes the following two components:

• Usercentrics Core: Contains all core functionality to collect, document and manage consent. If you want to build your own banner UI, that’s the only module you need.

• UsercentricsUI: This component builds on the top of Usercentrics Core to provide a pre-built consent banner solution. Use it for a quick but still customizable solution.

⚠️ Note: This Quickstart flow uses the pre-built banner of the UsercentricsUI component.
To build your own CMP banner use Usercentrics Core .

Quickstart flow

Follow these steps to implement your first (most basic) banner and capture a consent:

Configure the Admin Interface

1. Sign up or log in

   • Create a free trial for Usercentrics App CMP or log in to your Usercentrics account.

2. Create an app configuration

   • Create an app configuration and select the relevant legal framework.

   • (Optional) Create rulesets if you want to customize the banner for specific regions.

   • Copy your Settings ID (or Ruleset ID) - you’ll need this for SDK initialization.

3. (Optional) Link published apps & run scans

   • Connect your published app(s) and have your app scanned for integrated SDKs. You can do this under Configurations - <your configuration> - Service Settings - DPS Scanner.

4. Add DPSs/vendors manually

   • Under Configurations - <your configuration> - Service Settings, select the services/vendors you are using in your code.
     Typically, data processing services are SDKs loaded by your application, collecting information about the user. To make them appear on the banner, you must select them under Service Settings, and map them to the categories to which they belong (Marketing/Functional/Essential).

Implement the SDK in your app

1. Import the SDK

   • iOS: CocoaPods or Swift Package Manager

   • Android: Gradle or Maven

   • Cross-platform: Flutter, React Native, Unity, or Cocos2d (with limitations)

2. Initialize the SDK

   • Add your Settings ID (or Ruleset ID).

   • Use default initialization settings.

   • Call the initialization method.

3. Display the banner

   • Ensure the banner triggers at app launch.

4. Handle consent

   • User choices are automatically collected and stored.

   • Consent strings (e.g., TCF) are generated by default.

   • (Optional) Use consent mediation (or GCM) to forward consent to third-party SDKs.

   • Apply consent to appropriate vendors/DPSs adequately.

5. Test your integration

   • Run your app.

   • Confirm the banner displays at launch.

   • Verify that consents are recorded and consent strings are created.

Outcome

By completing these steps, you will:

• Have the App CMP banner running in your app.

• Successfully capture your first user consent.

Important: Always have your setup reviewed and verified by your Data Protection Officer (DPO) or legal team.

Example implementation

Looking for a working example?
Check our sample apps for iOS, Android, and cross-platform setups.

Next steps

• Customize the banner to match your brand.

• Explore advanced features such as cross-device consent sharing or WebView continuity.

• Use the Analytics dashboard to monitor opt-in rates and user interactions.