Installation
Script Tag Installation
There are two options for installing the Verisoul script in your HTML. You should place the script tag in the<head>
as early as possible to ensure the Verisoul object is available on the window before calling Verisoul functions.
Async Installation (Recommended)
The async installation provides better page load performance by loading the script asynchronously, preventing it from blocking the page render. This option includes a helper script that ensures the Verisoul object is always available on the window, eliminating the need to await the script load before calling Verisoul functions. The helper script is not required but will generally make the integration easier.Synchronous Installation
If you prefer a slightly simpler integration, you can use the basic script tag. Note that this will block page rendering until the script is loaded. The Verisoul object will be available on the window immediately after the script is loaded.Script Tag Parameters
Replace the following parameters in either installation method:{env}
: Use eitherprod
orsandbox
{project_id}
: Your project ID, which must match the environment
Content Security Policy (CSP)
If your application has a Content Security Policy, update it to include the following Verisoul domains:Want to serve the SDK from your own domain? Follow the steps in Custom Subdomain Setup.
Usage
Once installed, you can use the SDK to get the currentsession_id
when you need to make a prediction or reinitialize a session when an account logs out.
session()
If you are looking to get started quickly or to Pilot Verisoul, see account() for a simplified integration.
session_id
to uniquely identify each user session. The session_id
is required when you need to get a risk prediction from the backend API and must be passed from your client to the server.
You can get the current session_id
at any time by calling Verisoul.session()
. The function returns a promise that resolves once Verisoul collects a minimum amount of session information to make a prediction.
Important: Each session_id
expires after 24 hours and cannot be used to call the backend API after expiration. It is recommended to only get a session_id
right before you need to make a server-side request.
Example usage:
reinitialize()
Using the
reinitialize()
function is optional for most use cases.session_id
only be tied to one account. To avoid problems joining a session to an account, reinitialize the session once an account logs out.
Calling Verisoul.reinitialize()
generates a new session_id
, which ensures that if a user logs out of one account and into a different account, Verisoul will be able to delineate each account’s data cleanly.
Example usage:
account()
This function is intended only for customers piloting Verisoul. Do not use for long term production use or real-time fraud prevention.
account()
function provides a simplified way to send user account information to Verisoul directly from the client side. While easy to integrate, this method has important limitations:
- Offline analysis only: Data sent via
account()
is only visible in the Verisoul dashboard - No real-time decisions: Unlike the server-side API, this method doesn’t allow your application to receive and act on Verisoul’s risk scores in real-time
- Limited use case: Designed specifically for initial pilots and evaluation purposes
id
field is required.
Example usage:
Next Steps
- Learn about Backend Integration for API implementation
- See Integration Best Practices
- Explore Mobile Integration for native apps
- See the Web Sample App for a complete implementation