Skip to main content

Create UWL Session

Create a New UWL Session​

Use the BlockID SDK to create a new UWL session as part of your passwordless login experience. The BlockID mobile application will interact with your UWL session and return the information needed to process and complete the login request.

Parameters​

  • dns (required): Your BlockID tenant domain as shown in the dashboard
  • communityName (required): Your BlockID tenant community as shown in the dashboard
  • licenseKey (required): BlockID license key as shown in the dashboard
  • authType: Set to null
  • scopes: Enter a scope to use, such as device_info, or else enter null
  • metadata : Used to transmit supplemental information if desired, else enter null:
    • The purpose of the uwl session (eg: authentication, hotel-checkin)
    • IP of the requesting web page
    • DNS of the requesting web page
    • Additional information to be presented as required by your authenticator app

Scopes​

Setting a scope allows you to specify which response parameters you wish to see, rather than the entire response object. Responses will only be shown for the scopes listed. To see the entire response, set scopes to null.

Available scopes:

  • firstname
  • lastname
  • ial
  • aal
  • ppt
  • dl
  • scep_creds
  • location
  • deviceid
  • device_info
  • dl_front_image
  • dl_back_image
  • ppt_image
  • liveid
  • nationalid_front_image
  • nationalid_back_image

Request Format​

  • Set tenant info and create a new UWL session
const BIDSessions = require('blockid-nodejs-helpers/BIDSessions');

let createdSessionResponse = await BIDSessions.createNewSession({ "dns": "<dns>", "communityName": "<communityName>", "licenseKey": "<licenseKey>" }, "<authType>", "<scopes>", "<metadata>");

Example UWL Request​

Example - Start UWL Session​

const BIDSessions = require('blockid-nodejs-helpers/BIDSessions');

// Optional: Define metadata. Users can pass "null" if defining metadata is not desired 
let metadata = { "purpose" : "authentication" };

let createdSessionResponse = await BIDSessions.createNewSession({ "dns": "blockid-trial.1kosmos.net", "communityName": "devx", "licenseKey": "0005c9f8-1918-40be-aa00-e319043f7xxx" }, null, null, metadata);

Example Server Response​

The SDK will return an immediate response from our API. The responses are the same across each SDK and are JSON formatted. Possible response codes you might receive include:

Server Responses​

200 OK
{
  message: null,
  sessionId: "b0ad6ca2-b148-4e1e-a857-3d7eb9978ce3",
  status: true,
  url: "https://blockid-trial.1kosmos.net/sessions"
}

A new UWL session was created

When a session is created using the SDK, a unique session ID and URL endpoint are created, and a polling service starts looking for a response. The session will remain valid for 120 seconds. If the polling service does not receive a response within that timeframe, the session will expire and close.

To authenticate the request using the BlockID mobile application you will need to encode the session information in a QR code, such as the one in the image below.