Skip to main content
POST
/
call
/
start
Start a Call Connect authentication session.
curl --request POST \
  --url https://us-connect.authsignal.com/call/start \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "referenceId": "<string>",
  "phoneNumber": "<string>",
  "userId": "<string>",
  "username": "<string>",
  "email": "[email protected]",
  "channel": "WHATSAPP",
  "locale": "en"
}
'
{
  "messageId": "ef6b3212-6121-4a9e-92ef-09d819e36e93",
  "channel": "SMS"
}

Authorizations

​
Authorization
string
header
required

Use your Call Connect API secret key as the username and leave the password empty. The secret key can be found in the Call Connect section of the Authsignal Portal settings.

Body

application/json
​
referenceId
string
required

A reference identifier originating from customer experience/IVR system. This could be the call session ID.

​
phoneNumber
string
required

The phone number of the user to be authenticated. This could be the current call's originating phone number.

​
userId
string

The primary identifier for the user stored in Authsignal.

​
username
string

A username, for example a user customer number or email.

​
email
string<email>

An email address for the user to be authenticated.

​
channel
enum<string>

The channel to be used for the caller authentication link to be sent to the user.

Available options:
WHATSAPP,
SMS
​
locale
string

The user's locale in BCP 47 format. Used to localize SMS messages.

Example:

"en"

Response

OK

​
messageId
string

The ID of the channel's delivered message, use this as an audit trail to track the message delivery.

​
channel
enum<string>
Available options:
WHATSAPP,
SMS