Skip to content

Interface: ActionEventOptions

Properties

correlationId

• Optional correlationId: string

Any ID that could help relate the action with external context or session


claimedUserId

• Optional claimedUserId: string

User ID of the not yet authenticated user, used to enhance risk and trust assessments. Should not contain any sensitive data in plain text. Once the user is authenticated, prefer reporting the successful login result via drs.reportActionResult() when the original action token is available. Otherwise, drs.setAuthenticatedUser() can be used as a fallback.


claimedUserIdType

• Optional claimedUserIdType: string (enum) One of: ['email', 'phone_number', 'account_id', 'ssn', 'national_id', 'passport_number', 'drivers_license_number', 'other']. Specifies the type of value provided in the claimedUserId field. This is especially important when claimedUserId contains a hashed value. The claimedUserIdType can be included only when claimedUserId is provided.


transactionData

• Optional transactionData: TransactionData

A transaction data-points object for transaction-monitoring


customAttributes

• Optional customAttributes: Record<string, string | number | bool>

Custom attributes add context to an action but must match the schema defined in the Portal. Invalid attributes are ignored.


authContext

• Optional authContext: AuthContext

Authentication context of a user who was already fully authenticated outside this SDK (for example, they logged in on a different site or through an external identity flow before reaching this action). Providing it indicates that the user is authenticated, so authContext.userId is required. The user is also set for subsequent events in the device session, the same as drs.setAuthenticatedUser(). We recommend using it only when the login happened outside the current flow. If the user authenticates within the flow, report the user via drs.reportActionResult() instead.