SDK guide

SKOR currently provides a JavaScript SDK. More SDKs will be available soon. Use the SDK when you want an iframe-based integration where SKOR manages the tenant workflow and your application launches the profile session.

Installation

The JavaScript SDK is available by URL. Choose the URL that matches your credentials and environment.

Production
Sandbox

<script src="https://api.skortorent.com/sdk/skor.js"></script>

<script src="https://dev-api.skortorent.com/sdk/skor.js"></script>

To test in the sandbox, use https://dev-api.skortorent.com/sdk/skor.js together with sandbox credentials and the https://dev-api.skortorent.com/api/v1 API base URL. Do not mix sandbox tokens or credentials with the production SDK.

Initialize

After including the SDK, initialize it with your client_id.

const sdk = Skor({
  clientId: "YOUR_CLIENT_ID",
});

The SDK is initialized with your public client_id. Your client_secret is used only for server-side calls and must never be exposed in browser code. See the Authentication guide for how to generate a server access token.

Start a profile session

Starting a profile session is a two-part flow: your server mints a tenant onboarding token, and your browser launches the session with that token.

1. On your server — mint an onboarding token

Using your Bearer access token (see the Authentication guide):

Create the tenant with Create Tenant and keep the returned id (the tenantId).
Generate an onboarding token for that tenant with Generate Onboarding Token:

Production
Sandbox

curl -X POST "https://api.skortorent.com/api/v1/tenants/onboarding-token/{tenantId}" \
  -H "Authorization: Bearer $SKOR_ACCESS_TOKEN"

curl -X POST "https://dev-api.skortorent.com/api/v1/tenants/onboarding-token/{tenantId}" \
  -H "Authorization: Bearer $SKOR_ACCESS_TOKEN"

The response returns a short-lived, tenant-scoped token. Pass this token to your browser page.

2. In the browser — launch the session

Call startProfileSession with the onboarding token and the id of the container element that should host the session.

const profileSessionInstance = sdk.startProfileSession({
  token, // the onboarding token from your server
  containerId: "skor-container",
  height: "800px",
});

The SDK automatically tracks the session’s progress (via Tenant Profile Status) and drives the callbacks below. You do not need to call the status endpoint yourself.

`height`

The height property controls the height of the embedded iframe. It accepts either a CSS height value or a number:

CSS height values such as "500px", or "800px"
A number, which is treated as pixels, such as 600

If height is not provided, it defaults to 500px.

const profileSessionInstance = sdk.startProfileSession({
  token,
  containerId: "skor-container",
  height: "800px",
});

Callbacks

You can provide callback functions to handle events during the profile session.

`onLoad`

Triggered when the profile session loads successfully.

onLoad: () => {
  console.log("Profile Session loaded");
};

`onSkorAnalysisRunning`

Triggered when profile registration is complete and SKOR analysis is running. During this time, you may want to show a loader because the profile session UI cannot be shown until analysis is complete.

onSkorAnalysisRunning: () => {
  console.log("Skor Analysis is currently running");
};

`onCancel`

Triggered when the user cancels the profile session or when the cancel method is called.

onCancel: () => {
  console.log("Profile Session Cancelled");
};

`onError`

Triggered when an error occurs during the profile session.

onError: (error) => {
  console.log("Profile Session error", error);
};

`onProfileReady`

Triggered when the profile session is ready to be used.

onProfileReady: () => {
  console.log("Profile Session ready");
};

Review the Authentication guide before using the SDK in production.

Guides

SDK

API's Authentication

Modular API Guide

Modular API Reference

Property Management Guide

Property Management API Reference

Installation

Initialize

Start a profile session

1. On your server — mint an onboarding token

2. In the browser — launch the session

`height`

Callbacks

`onLoad`

`onSkorAnalysisRunning`

`onCancel`

`onError`

`onProfileReady`

​Installation

​Initialize

​Start a profile session

​1. On your server — mint an onboarding token

​2. In the browser — launch the session

​height

​Callbacks

​onLoad

​onSkorAnalysisRunning

​onCancel

​onError

​onProfileReady

Installation

Initialize

Start a profile session

1. On your server — mint an onboarding token

2. In the browser — launch the session

`height`

Callbacks

`onLoad`

`onSkorAnalysisRunning`

`onCancel`

`onError`

`onProfileReady`