Client ID

What is the Client ID?

The clientId is an opaque identifier for a single end user of your app. It must be included on all API requests.

Requirements

• Included on all requests to the Clips API.
• Stable across devices and sessions for the same user.
• Does not contain PII; treat it as an opaque, non‑guessable identifier.

How to generate a Client ID

We don't prescribe exactly how

• Your client ID should be at least 8 characters long

Why stability matters

• Analytics: Enables accurate engagement metrics (plays, adds, shares) per user over time.
• Billing: Allows correct attribution of usage to your account and to specific end users.
• Policy: Supports enforcement (e.g., music rights checks) consistently for the same user.

Examples

1. Same user, multiple devices

   • Today the user signs in on their phone and selects a clip.
   • Later they open your app on a tablet and add the same clip to a video.
   • Both devices should send the same clientId, so usage appears under a single user.

2. Same user, multiple sessions

   • The user previews music today and returns next week to publish content.
   • Both sessions should send the same clientId so we see a single, continuous journey.

3. Guest user upgrading to an account

   • A guest user tries the app, then creates an account.
   • Migrate the guest clientId to the account’s persistent clientId to retain history.

Implementation tips

• Generate a UUID v4 for each real user identity in your system and persist it server‑side.
• Reuse that UUID across platforms (mobile, web) when the user is recognized.
• For anonymous users, create a temporary clientId and promote it when they sign in.