Sign in

v1

latestOpenAPI 3.1.02026-07-268342124.0 KB
users
actions
query

Query actions

Query actions for a user.

get/users/{userId}/actions

Path parameters

userIdstring required

The ID of the user.

Query parameters

codesstring

A comma-separated list of action codes to include in your query. If omitted, all action codes will be included.

fromDatestring

If provided, the query will include actions from this date. Must be specified in ISO 8601 format - e.g. 2020-01-01T00:00:00Z. The default and maximum value is 30 days ago.

Response

OK

actionCodestring

The action code.

idempotencyKeystring

The idempotency key for the user action.

createdAtstring date-time

The time in ISO 8061 format when the action was first created.

updatedAtstring date-time

The time in ISO 8061 format when the action was last updated.

state'ALLOW' | 'BLOCK' | 'CHALLENGE_REQUIRED' | 'CHALLENGE_FAILED' | 'CHALLENGE_SUCCEEDED' | 'REVIEW_REQUIRED' | 'REVIEW_FAILED' | 'REVIEW_SUCCEEDED'

The current state of the action.

stateUpdatedAtstring date-time

The time in ISO 8061 format when the state of the action was last updated.

verificationMethod'SMS' | 'AUTHENTICATOR_APP' | 'EMAIL_MAGIC_LINK' | 'EMAIL_OTP' | 'PUSH' | 'DEVICE' | 'SECURITY_KEY' | 'PASSKEY' | 'VERIFF' | 'IPROOV' | 'PALM_BIOMETRICS_RR' | 'IDVERSE'
verifiedByAuthenticatorIdstring

The ID of the authenticator which was used to complete the challenge associated with the action.

userAgentstring

The user agent provided when the action was tracked.

ipAddressstring

The IP address provided when the action was tracked.

countryCodestring

The country code derived from the IP address if provided.