@socure-inc/device-risk-sdk

Digital Intelligence Web SDK

The Digital Intelligence Web SDK is a part of the Socure family of fraud detection and prevention products. It collects device and behavioral data to create ways of uniquely identifying devices and users. The SDK is meant to be used in conjunction with ID+.

Detailed setup instructions can be found in the Socure Developer Hub.

Setup

Include the SDK in your application by first installing the dependency:

npm install --save @socure-inc/device-risk-sdk

Configuration and Usage

The SDK needs to be configured an initialized to be used.

Configuration

Configuration is done using the SigmaDeviceOptions object:

const sigmaDeviceOptions: SigmaDeviceOptions = {
  sdkKey: string;
  configBaseUrl?: string;
  useSocureGov?: boolean;
}

The configuration options are as follows:

• sdkKey: The SDK Key that can be found in the Socure dashboard developers section under the SDK section.

• configBaseUrl: Optional The base URL for the SDK to use when making requests. This needs to be configured when the SDK is being accessed through a proxy.

• useSocureGov: Optional A flag to enable the use of the Socure GovCloud environment. This should only be set to true if the SDK key is a GovCloud key. This option is ignored if configBaseUrl is set.

Usage

The SDK needs initialized to start collection. The initialization should only happen once within the application. Ideally this should be in a high level component within a web framework like React ensure it isn't continually re-initialized on state changes. Initialization can be done as follows:

SigmaDeviceManager.initialize(sigmaDeviceOptions);

Sessions

Once initialized the SDK will provide access to the generated session.

The getSessionToken method returns a Promise that will resolve to the sessionToken for use with the ID+ API. A sample of getting this sessionToken would look as follows:

SigmaDeviceManager.getSessionToken().then((sessionToken) => {
  console.log("sessionToken", sessionToken);
  // Logic to store this sessionToken
})

Once retrieved, this sessionToken should be recorded by your application for use in the ID+ API requests associated with this transaction. The sessionToken will be passed to ID+ in the deviceSessionId field.