Skip to main content
POST
/
call
/
finish
Finish a Call Connect Authentication Session
curl --request POST \
  --url https://us-connect.authsignal.com/call/finish \
  --header 'Content-Type: application/json' \
  --data '{
  "referenceId": "<string>",
  "userId": "<string>",
  "state": "CHALLENGE_SUCCEEDED",
  "payload": {}
}'
{
  "success": "true"
}

Body

application/json
​
referenceId
string
required

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

​
userId
string
required

The primary identifier for the user stored in Authsignal.

​
state
enum<string>
required

The state of the call connect session.

Available options:
CHALLENGE_SUCCEEDED,
CHALLENGE_FAILED
​
payload
object

Any metadata that you want to pass along to the webhook.

Response

OK

​
success
string
Example:

"true"

⌘I