Skip to content

Users authentication

There are two supported authentication methods. Choose the one that best fits your integration.

Quick Summary

  • Method A (recommended): Pre-registration + Seamless Login

    • Create/sync users via our Registration API when they register/login on your platform.
    • Establish a session via Seamless Login when opening the iframe.
  • Method B (legacy): Seamless Login only

    • Always perform Seamless Login when opening the iframe. If the user does not exist yet, we automatically create them.

How to Choose

  • Choose Method A if you want to:

    • have users in our system before their first iframe visit;
    • assign them to bonus campaigns/segments in advance;
    • maintain complete user visibility and accurate analytics from day one.
  • Choose Method B if you need:

    • a quick start/POC with minimal changes to your current flows;
    • no requirement to see users in our system before their first iframe login.

Purpose

Pre-sync your users with our system and then establish a session when opening the iframe.

What you do

  • On user registration/login in your platform, call our Registration API: registration-API

  • Whenever the user opens the iframe, establish a session with Seamless Login: seamless-login

What you get

  • Users exist in our system in advance.
  • You can include them in bonus campaigns and segments before their first iframe visit.
  • Fast and secure session setup when interacting with the iframe.

Note

If a user was not pre-registered, Seamless Login will still create them automatically. However, we strongly recommend calling the Registration API during your platform’s registration/login flow to enable early user visibility and pre-targeting in campaigns.

Method B (legacy): Seamless Login only

Purpose

Minimize integration steps: establish the session on iframe entry and create the user if needed.

What you do

How it works

  • If the user already exists, a session is established.
  • If not, the user is automatically created at the time of iframe login + establishing session

Limitations

  • The user appears in our system only after their first iframe login.
  • You cannot pre-assign such users to campaigns before their first visit.

FAQs

  • Is pre-registration (Registration API) mandatory?

    • No. Users are still created during Seamless Login. Without pre-registration, however, you lose early visibility and the ability to include users in campaigns beforehand.
  • What’s the difference between “Registration” and “Login” here?

    • Registration (Registration API): Create/sync the user record in our system when they register/login on your platform.
    • Login (Seamless Login): Establish the session when opening the iframe (and auto-create the user if missing).
  • Can I mix methods?

    • Yes. The recommended flow is to always pre-register users and still perform Seamless Login whenever the iframe is opened.

Implementation Checklist

  • On your platform’s registration/login event → call registration-API.
  • On iframe open → perform seamless-login.

Method B (legacy):

  • On iframe open → perform seamless-login. The user will be auto-created if they don’t exist yet.