Sign in

v1

latestOpenAPI 3.1.02026-07-268342124.0 KB
call-connect-api

Start a Call Connect authentication session.

Start a Call Connect authentication session, triggering a user verification challenge based on the configured channels.

post/call/start

Request body

referenceIdstring required

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

phoneNumberstring

The phone number of the user to be authenticated. This could be the current call's originating phone number. Either in a E.164 format, or optionally a local format as long as the country field is provided too. Required when using the SMS or WHATSAPP channel.

userIdstring

The primary identifier for the user stored in Authsignal.

usernamestring

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

emailstring email

An email address for the user to be authenticated.

channel'WHATSAPP' | 'SMS' | 'EMAIL'

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

localestring

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

countrystring

Optional - used if phoneNumber is provided in a non-E.164 format the country can be provided separately and Authsignal will automatically determine the E.164 formatted phone number.

actionCodestring

The action code for the authentication session. Defaults to call.

Example request

{
  "locale": "en",
  "country": "USA"
}

Response

OK

messageIdstring

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

channel'WHATSAPP' | 'SMS' | 'EMAIL'
emailstring

The email address the authentication request was sent to. Present when the channel is EMAIL.

phoneNumberstring

The phone number the authentication request was sent to. Present when the channel is SMS or WHATSAPP.

Example response

{
  "messageId": "ef6b3212-6121-4a9e-92ef-09d819e36e93",
  "channel": "SMS"
}