Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.authsignal.com/llms.txt

Use this file to discover all available pages before exploring further.

The Call Connect SDK makes it easier to interact with our REST API from your server-side code.

​
Installation

npm install @authsignal/node

​
Initialization

Initialize the Authsignal Call Connect client by providing your Call Connect API secret key and the Call Connect API URL for your region. These values can be found in the Authsignal Portal under Settings -> Call Connect. 
import { CallConnect } from "@authsignal/node";

const callConnect = new CallConnect({
  apiSecretKey: "YOUR_CALL_CONNECT_API_SECRET_KEY",
  apiUrl: "YOUR_CALL_CONNECT_API_URL",
});

​
Regions

The API URLs for each region are defined below.
RegionAPI URL
US (Oregon)https://us-connect.authsignal.com
AU (Sydney)https://au-connect.authsignal.com
EU (Ireland)https://eu-connect.authsignal.com
CA (Montreal)https://ca-connect.authsignal.com

​
Usage

​
Start call

API schema

Start a Call Connect authentication session, triggering a user verification challenge based on the configured channels. 
const request = {
  referenceId: "12aec191-69cf-419c-92d9-81e7a3b017ff",
  phoneNumber: "+64271234567",
};

const response = await callConnect.startCall(request);

​
Finish call

API schema

Finish an existing Call Connect authentication session. 
const request = {
  referenceId: "12aec191-69cf-419c-92d9-81e7a3b017ff",
  state: CallState.CHALLENGE_SUCCEEDED,
};

const response = await callConnect.finishCall(request);