POST
/
call
/
start

Body

application/json
channel
enum<string>

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

Available options:
WHATSAPP,
SMS
phoneNumber
string

The phone number of the user to be authenticated, this could be the current calls originating phone number.

referenceId
string

A reference identifier originating from customer experience/IVR system, this could be the call session id.

userId
string

The primary identifier for the user stored in Authsignal.

username
string

A username for example a user customer number or email.

Response

200 - application/json
channel
enum<string>
Available options:
WHATSAPP,
SMS
messageId
string

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