Authmatech Web SDK Reference (authmatech-sdk-web)

The Authmatech Web SDK (authmatech-sdk-web) runs silent mobile verification in the mobile browser. It is client-side only — you give it a transaction id and a check URL, it runs the silent network check, and your backend completes the verification with the server-side API key. The SDK never holds your API key. For the end-to-end integration (including your backend), see Web verification.

The Web SDK is built for mobile browsers on a mobile-data connection. Desktop browsers and Wi-Fi/VPN connections can’t complete the silent check — plan a fallback, such as manual entry or retrying on mobile data.

Install

npm install authmatech-sdk-web
# or: yarn add authmatech-sdk-web

Current version: 1.0.3. The page must be served over HTTPS.

Usage

ES module (Webpack, Rollup, Vite, etc.)

import { initAuthmatechCheck } from 'authmatech-sdk-web';

// 1) A transaction id for this verification.
//    Format: prefix-<UUIDv4>. The prefix is provided by Authmatech.
const transactionId = 'prefix-550e8400-e29b-41d4-a716-446655440000';

// 2) Run the silent check. checkUrl is provided by Authmatech.
initAuthmatechCheck({
  transactionId,
  checkUrl: 'https://web.authmatech.com/verify',
});

UMD bundle (`<script>` tag)

<script src="https://cdn.jsdelivr.net/npm/authmatech-sdk-web/dist/authmatech-sdk-web.umd.min.js"></script>
<script>
  AuthmatechSDKWeb.initAuthmatechCheck({
    transactionId: 'prefix-550e8400-e29b-41d4-a716-446655440000',
    checkUrl: 'https://web.authmatech.com/verify',
  });
</script>

API

`initAuthmatechCheck(config)`

Runs the silent verification check for the given transaction over the device’s mobile-data connection.

string

required

The transaction id for this verification, in the format prefix-<UUIDv4>. The prefix is provided by Authmatech for your account; generate the UUID per verification.

string

required

The verification URL for your account, provided by Authmatech. Must use https.

The call throws if:

transactionId is missing or empty.
checkUrl is missing, invalid, or not using the https protocol.

The SDK stores no personal data and keeps nothing in local storage. It does not return the confirmed number to the browser — your backend resolves the result by transaction id (next section).

Completing the verification

The Web SDK runs the silent check; your backend turns it into a verdict. Call POST /v1/api/verify/{transactionId} with the same transactionId and the X-API-KEY + X-CLIENT-ID headers:

curl -X POST "https://service.authmatech.com/v1/api/verify/prefix-550e8400-e29b-41d4-a716-446655440000" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "X-CLIENT-ID: YOUR_CLIENT_ID" \
  -H "Content-Type: application/json" \
  -d '{ "mobileNumber": "+962791234567", "serviceType": "LOGIN" }'

{ "success": true, "messages": [{ "type": "SUCCESS", "httpStatus": "OK" }], "data": { "validNumber": true } }

Web verification guide

The full browser + backend flow, end to end.

API: verify (Web)

Resolve a verification by transaction id.

Get started

Core concepts

Guides

SDKs

Support

Authmatech Web SDK Reference (authmatech-sdk-web)

Install

Usage

ES module (Webpack, Rollup, Vite, etc.)

UMD bundle (`<script>` tag)

API

`initAuthmatechCheck(config)`

Completing the verification

Web verification guide

API: verify (Web)

​Install

​Usage

​ES module (Webpack, Rollup, Vite, etc.)

​UMD bundle (<script> tag)

​API

​initAuthmatechCheck(config)

​Completing the verification

​Related

Web verification guide

API: verify (Web)

Install

Usage

ES module (Webpack, Rollup, Vite, etc.)

UMD bundle (`<script>` tag)

API

`initAuthmatechCheck(config)`

Completing the verification

Related