Skip to main content

Operations

The SDK provides methods for managing sessions and fingerprints.

Sessions​

Create a session​

const session = await client.createSession({
referenceId: 'user-12345',
redirectUrl: 'https://yourapp.com/done',
locale: Locale.EN,
});

Response:

{
"id": "550e8400-e29b-41d4-a716-446655440000",
"token": "eyJhbGciOiJIUzI1NiIs...",
"status": "created",
"referenceId": "user-12345",
"createdAt": "2025-01-15T10:30:00Z",
"expiresAt": "2025-01-15T11:00:00Z"
}

Get a session​

const session = await client.getSession('550e8400-e29b-41d4-a716-446655440000');
console.log(session.status); // 'completed'

Methods reference​

MethodDescriptionReturns
createSession(options)Create a new verification sessionPromise<Session>
getSession(id)Retrieve session by IDPromise<Session>
createFingerprint(data)Submit fingerprint dataPromise<Fingerprint>
getFingerprint(id)Retrieve fingerprint by IDPromise<Fingerprint>
getConfiguration()Get account configurationPromise<Configuration>
updateConfiguration(data)Update account configurationPromise<Configuration>

Session statuses​