Skip to main content

Redirect or embed

Integrate Player into your frontend application​

Before integrating with Player, ensure that all prerequisites are fulfilled as described in the Quickstart guide.

To run flows natively inside your mobile app instead, see the Mobile SDK overview.

Integration method​

Integration methodDescription
Redirect integrationRedirect users to the IDnow-hosted Player URL for a full-screen verification experience with guaranteed camera/microphone access (if permission is given by user).
Embedded integrationNot generally available. Contact your Account Manager for more information.

Integration steps​

  1. Create a session via API
  2. Obtain playerUrl from the API response
  3. redirect the user to the playerUrl

Create a session​

Call the API to create a session.

info

For complete API documentation, request examples, and implementation details, see Create session.

Handling redirect URLs​

To automatically redirected the user after the session completes, pass an optional redirectUrl when you Create a session. The backend will only accept and store this redirectUrl after validating that it matches one of the OAuth client’s configured Allowed redirect URLs. If it’s not on the allowlist, the request is rejected.

You may also pass an optional state string (max 2048 characters) alongside redirectUrl. The state value is opaque to the platform and is echoed back in the session response. Use it to carry CSRF tokens or client-side state through the redirect, so you can verify the response belongs to the session you started.

Obtain playerUrl​

When you create a flow session via the API, the response provides a playerUrl that includes a token as a query parameter. Treat the token as opaque: do not parse, change or store it separately from the playerUrl. The Player uses it to authenticate the user and to end access when the session expires.

{
  "playerUrl": "https://player.eu.platform.idnow.io/?token=eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..."
}

URL structure​

The playerUrl already includes a token in query parameter and can be used directly by the frontend.

https://player.eu.platform.idnow.io/?token=[token]

Token lifetime​

The token lifetime is always synchronized with the Session lifetime

By default, it is set to 24 hours. If the Session lifetime will be configured shorter or longer, the token will expire accordingly.

Token validation​

The Player rejects a token that is missing, invalid or expired (UNAUTHORIZED), and a token for a session that no longer exists (NOT_FOUND). In either case, create a new session and redirect the user to its new playerUrl.

Choose integration method​

Redirect integration​

This is the simplest and most reliable integration method where the user is directed to the IDnow-hosted Player.

Process:

  1. Create a flow session via API call
  2. Read the playerUrl from the API response
  3. Redirect the user to playerUrl
  4. User completes verification
  5. Monitor completion via webhooks or polling

Web browser:

// Web browser
// playerUrl is returned by the API and already contains ?token=<sdkToken>
window.location.href = playerUrl;

Mobile app (iOS)

// playerURL is returned by the API and already contains ?token=<sdkToken>
let playerURL = "<PLAYER_URL_FROM_API>"
if let url = URL(string: playerURL) {
    UIApplication.shared.open(url)
}

Mobile app (Android):

// playerURL is returned by the API and already contains ?token=<sdkToken>
String playerURL = "<PLAYER_URL_FROM_API>";
Intent intent = new Intent(Intent.ACTION_VIEW, Uri.parse(playerURL));
startActivity(intent);

Advantages:

  • Full screen experience for users
  • No iframe restrictions
  • Camera/microphone access guaranteed
  • Handles all verification types seamlessly

Use when:

  • You want the simplest integration
  • User experience is the priority
  • You don't need to maintain UI context during verification

Embedded integration​

info

Embedded integration is not yet generally available — contact your Account Manager for more information.