Last updated: 2026-01-25

We are excited to announce the upcoming launch of the new version of our single sign on (SSO) service. This migration guide is specifically for customers with their own applications using our SSO. Follow the steps below to ensure a smooth transition.

Updated Endpoints

Please update your application to use the following new endpoints:

• Authentication
  • From: /authentication/v1/authenticate
  • To: /sso/v2/authorize
• Token management
  • From: /authentication/v1/tokens
  • To: /sso/v2/token
• User information
  • From: /authentication/v1/users
  • To: /sso/v2/userinfo
• Logout
  • From: /authentication/v1/logout
  • To: /sso/v2/logout
• Session tracker
  • From: /authentication/v1/sessionTracker/oasm.js
  • To: /sso/sessionTracker/oasm.js

Authorisation request parameters

When making an authorization request to /sso/v2/authorize, please include the following parameters:

• scope: Specifies the access privileges. For OpenID Connect, use:
  • openid: Indicates the use of the OpenID Connect protocol to verify the user's identity.
  • profile: Requests additional profile information such as name and preferred_username (email).
• login_hint: (Recommended) Customizes the login prompt UI based on the CSS/JS styling set up at the indicated entity id.

Scope parameter: Use space-separated values (e.g., scope=openid profile) to request OpenID Connect and profile information.
Consent requirement: Users must consent during login if the profile scope requests Personal Identifiable Information like name and username (email).

User info response parameters

When making a user information request to /sso/v2/userinfo, please note the change in the attached_to response parameter:

• Previous format:

{
  "attached_to":[
    {
      "id":"/PSPName",
      "type":"[name: PSP, value: 0]"
    },
    {
      "path":"/PSPName/DivisionName/MerchantName",
      "type":"[name: Merchant, value: 0]"
    }
  ]
}

• Updated format:

{
  "attached_to":[
    {
      "entityId":"[entity id]",
      "entityType":"PSP",
      "path":"/PSPName"
    },
    {
      "entityId":"[entity id]",
      "entityType":"MERCHANT",
      "path":"/PSPName/DivisionName/MerchantName"
    }
  ]
}