Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.authsignal.com/llms.txt

Use this file to discover all available pages before exploring further.

Sent when an action is about to transition to CHALLENGE_SUCCEEDED. Run additional checks against your own systems and gate the final outcome. This webhook is synchronous, so a non-2xx response or a timeout blocks the transition. There are no automatic retries, but the user can retry by re-running the verification. Set verificationWebhookUrl on the action configuration in the Authsignal Portal, or via the Create / Update Action Configuration endpoints.

​
Payload

​
userId
string
required
The ID of the user that the action belongs to.
​
action
string
required
The action code for the action that is about to succeed.
​
idempotencyKey
string
required
The idempotency key of the action that triggered the webhook.
​
verifiedAt
string
required
The time the verification completed in ISO 8601 format.
​
state
string
required
The pending action state. For action.verify this is always CHALLENGE_SUCCEEDED.
​
verificationMethod
string
required
The verification method that completed the challenge.
​
userAuthenticatorId
string
The ID of the user authenticator that completed the challenge, when available.
{
  "version": 1,
  "id": "ffffffff-ffff-ffff-ffff-ffffffffffff",
  "source": "https://authsignal.com",
  "time": "2024-01-01T01:23:45.678Z",
  "tenantId": "dddddddd-dddd-dddd-dddd-dddddddddddd",
  "type": "action.verify",
  "data": {
    "userId": "11111111-1111-1111-1111-111111111111",
    "verificationMethod": "PUSH",
    "action": "signIn",
    "idempotencyKey": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "verifiedAt": "2024-01-01T01:23:45.678Z",
    "state": "CHALLENGE_SUCCEEDED",
    "userAuthenticatorId": "cccccccc-cccc-cccc-cccc-cccccccccccc"
  }
}