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 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "referenceId": "<string>",
  "state": "CHALLENGE_SUCCEEDED",
  "userId": "<string>",
  "payload": {}
}
'
{
  "success": true
}

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.

​
state
enum<string>
required

The state of the call connect session.

Available options:
CHALLENGE_SUCCEEDED,
CHALLENGE_FAILED
​
userId
string

The primary identifier for the user stored in Authsignal.

​
payload
object

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

Response

OK

​
success
boolean
Example:

true