---
source_url: "https://developer.transmitsecurity.com/sdk-ref/authnsdk/overview"
title: Overview
mirrored_at: 2026-08-14T01:09:34.970Z
host: developer.transmitsecurity.com
cited_in_42a: true
mirror_canonical: "https://index.42a.ai/developer.transmitsecurity.com/sdk-ref/authnsdk/overview"
---

> **Original source:** https://developer.transmitsecurity.com/sdk-ref/authnsdk/overview

The Authentication module is a part of a client-side JavaScript SDK. It allows you to easily log in users with biometrics based on the [WebAuthn APIs](https://developer.transmitsecurity.com/openapi/user/backend-webauthn.openapi). The SDK does all the heavy lifting to provide secure WebAuthn authentication while leaving you the flexibility to control the authentication logic and user experience.

## Benefits

The SDK offers many advantages over the APIs, including:

-   Journey orchestration to support decisions and complex flows
-   Client-side WebAuthn calls, along with data processing before and after
-   Simplifies calls to Mosaic, reducing unnecessary complexity

## Installation

Load the SDK:

npm install @transmitsecurity/platform-web-sdk@^2

## Initialization

To initialize, use the following code:

// Import Authentication module
import { webauthn, initialize } from '@transmitsecurity/platform-web-sdk';
// Initialize SDK
// If SDK was loaded via script tag, use window.tsPlatform.initialize({ ... })
initialize({
  clientId: 'your-client-id',
  webauthn: {
    serverPath: 'https://api.transmitsecurity.io' // Required: Set serverPath based on your region or custom domain
  }
});

Customizations:

Name

Type

Description

`serverPath`

`string`

(Required) The Authentication module should be configured to work with your region or custom domain by setting `serverPath` to:  
\- `https://api.transmitsecurity.io` (for US)  
\- `https://api.eu.transmitsecurity.io` (for EU)  
\- `https://api.ca.transmitsecurity.io` (for Canada)  
\- `https://api.au.transmitsecurity.io` (for Australia)  
\- `https://api.gasne1-ts01.transmitsecurity.io` (for Japan)  
\- `https://api.sbx.transmitsecurity.io` (for sandbox)  
\- `https://<your_custom_domain>` (for custom domain)  
For the SDK modules to work properly together, the regions must match.

`webauthnApiPaths?`

[`WebauthnApis`](https://developer.transmitsecurity.com/sdk-ref/authnsdk/interfaces/webauthnapis)

Override endpoints when using a proxy server in case the proxy server implements its own paths.

## Next steps

-   [Web quickstart](https://developer.transmitsecurity.com/guides/webauthn/quick_start_sdk)
-   [Module reference](https://developer.transmitsecurity.com/sdk-ref/authnsdk/modules)