Track Action
Record authentication events performed by users and initiate challenges via the Authsignal pre-built UI or Authsignal client SDKs.
Path Parameters
The ID of the user.
A short human-readable code which defines the action that the user is performing, e.g. signIn. This value will be displayed in the Authsignal Portal and can be used to configure rules for authentication events with differing risk profiles. Values are validated with the following regex: ^[a-zA-Z0-9_-]{(1, 64)}$.
Body
The URL which the pre-built UI will redirect back to after the user exits the Authsignal pre-built UI. Only required when using the pre-built UI in redirect mode.
If set to true, the user will be shown the authentication settings screen after completing a challenge. Use this flag to allow users to manage their own authenticators through Authsignal's pre-built UI.
The user's email address.
The user's phone number in E.164 format.
The user's IP address. Should be provided when using rules based on location or other IP-derived features.
The user agent identifying a browser or app. Should be provided when using rules based on device.
An ID which identifies the user's device. Should be provided when using rules based on device.
The scopes granted to the pre-built UI and the token which can be passed to client SDKs. By default the only scope is read:authenticators.
A JSON object which can include any key/value pairs. Should be provided when using rules based on custom data points from your own app.
Response
The current state of the action.
ALLOW, BLOCK, CHALLENGE_REQUIRED, CHALLENGE_FAILED, CHALLENGE_SUCCEEDED, REVIEW_REQUIRED, REVIEW_FAILED, REVIEW_SUCCEEDED The URL for initiating a challenge using Authsignal's pre-built UI. You can redirect to this URL if the state determines that a challenge is required, or if you want to allow the user to enroll or to manage their existing authenticator settings.
A short-lived token which can be passed to Authsignal's client SDKs (e.g. when using passkeys) or to authenticate to Authsignal's client API.
True if the user is enrolled with at least one verification method and can be challenged.
A unique key which identifies a particular action. This key can be used to determine if the user has successfully completed a challenge.
The list of verification methods which the user is permitted to enroll.
SMS, AUTHENTICATOR_APP, EMAIL_MAGIC_LINK, EMAIL_OTP, PUSH, SECURITY_KEY, PASSKEY, VERIFF, IPROOV, PALM_BIOMETRICS_RR, IDVERSE The list of verification methods which the user has enrolled.
SMS, AUTHENTICATOR_APP, EMAIL_MAGIC_LINK, EMAIL_OTP, PUSH, SECURITY_KEY, PASSKEY, VERIFF, IPROOV, PALM_BIOMETRICS_RR, IDVERSE SMS, AUTHENTICATOR_APP, EMAIL_MAGIC_LINK, EMAIL_OTP, PUSH, SECURITY_KEY, PASSKEY, VERIFF, IPROOV, PALM_BIOMETRICS_RR, IDVERSE The IDs of the triggered rules.
Was this page helpful?