SSO Widgets

Embed the SSO Widgets

The SSO widget are embedded onto your site using an iFrame that is used by an applicant to create credentials or by a customer to log in. The widget UIs allow for various customer journeys. A user can be trying to create credentials in either of the following scenarios:

• At a purchase checkout, indicated by checkout.
  During a purchase checkout journey, page titles are displayed and if the user tries to create an account with a username that is already taken, the alert message will display a link to be redirected to the log in page
  
• Not at a purchase checkout, indicated by nocheckout.
  During a non-purchase checkout journey, page titles are not displayed and if the user tries to create an account with a username that is already taken, the alert message will only warn the user, but it will not provide an option to log in.
  

The journey type is specified by the context optional parameter provided in the iFrame query string. By default, the user is in a purchase checkout journey unless nocheckout is assigned to context.

The widgets both accept the following parameters in the iFrame source url:

When the user successfully creates credentials or logs in, the widget posts serialized data back to the redirect_uri provided in the query string. The data returned by the widget must be deserialized before usage.

1var payload = JsonConvert.DeserializeObject<Object>(formData["payload"])

Create Credentials Widget

To embed the create credentials iFrame, copy the code and paste it into your website when required in the journey.

1  <iframe src="https://id.newdaytechnology.com/[brand]/credentials?sessionId=<sessionId>&redirect_uri=<redirect_uri>&token=<jwt-token>"></iframe>

Successful response

When credentials are successfully created, the widget posts back the following data to the redirect_uri provided in the query string:

1{
2 "data": {
3 "idToken": "{{id_token}}"
4 },
5 "isSuccessful": true,
6 "message": null,
7 "errorMessages": {
8   "status": null,
9   "errors": []
10  }
11}

Unsuccessful response - Token expired

The widget does not handle errors related to invalid tokens. It provides the option to post back the below data and redirect the user to the redirect_uri present in the query string. A refreshed token can be retrieved from the Refresh Token endpoint. The widget can then be re-called by passing the refresh token in the URL parameters:

1<iframe src="https://id.newdaytechnology.com/[brand]/credentials?sessionId=<sessionId>&redirect_uri=<redirect_uri>&token=<refresh-token>"></iframe>

1{
2   "status": 401,
3   "errorMessage": "Token expired"
4}}

Log in Widget

To embed the create log in iFrame, copy the code and paste it into your website where you want your customers to log in to their customer credit account.

1  <iframe src="https://id.newdaytechnology.com/[brand]/login?sessionId=<sessionId>&redirect_uri=<redirect_uri>"></iframe>

Successful response

When a user successfully logs in, the widget posts the below data back to the redirect_uri provided in the query string:

1{
2  "hashedUserId": "{{hashed_user_id}}",
3   "identityToken": “",
4   "expiresIn": 600,
5   "tokenType": "Bearer",
6   "refreshToken": "{{refresh_token}}",
7   "correlationId": "string",
8   "isAccountLocked": false,
9   "remainingAttempts": null,
10   "success": true
11}

Unsuccessful response - Account locked

Users can attempt to log in with incorrect credentials up to 5 times before their account is locked. The widget does not handle errors due to the account being locked. However, it can optionally post back the below data and redirect the user to the redirect_uri provided in the query string:

1{
2   "status": 403,
3   "errorMessage": "User account locked."
4}

Customisation

The following elements can be configured in the widgets by NewDay to match your site:

The below elements are not currently configurable:

• Titles copy (e.g. Username, Passcode etc)
• Hint copy (‘This is your username you use to log in’)
• Prompt copy within the input fields (‘enter your username)
• Error messages based on API responses (e.g. Unauthorised user)
• Help copy (‘Do you already have NewPay?’)
• Retrieval copy (‘Trouble logging in?’)