Skip to main content
GET
/
users
/
{userId}
/
actions
Query actions
curl --request GET \
  --url https://api.authsignal.com/v1/users/{userId}/actions \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "actionCode": "<string>",
    "idempotencyKey": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "state": "ALLOW",
    "stateUpdatedAt": "2023-11-07T05:31:56Z",
    "verificationMethod": "SMS",
    "verifiedByAuthenticatorId": "<string>",
    "userAgent": "<string>",
    "ipAddress": "<string>",
    "countryCode": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Use your Authsignal secret key as the username and leave the password empty. The secret key can be found in the API Keys section of the Authsignal Portal settings page.

Path Parameters

​
userId
string
required

The ID of the user.

Query Parameters

​
codes
string

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

​
fromDate
string

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

​
actionCode
string

The action code.

​
idempotencyKey
string

The idempotency key for the user action.

​
createdAt
string<date-time>

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

​
updatedAt
string<date-time>

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

​
state
enum<string>

The current state of the action.

Available options:
ALLOW,
BLOCK,
CHALLENGE_REQUIRED,
CHALLENGE_FAILED,
CHALLENGE_SUCCEEDED,
REVIEW_REQUIRED,
REVIEW_FAILED,
REVIEW_SUCCEEDED
​
stateUpdatedAt
string<date-time>

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

​
verificationMethod
enum<string>
Available options:
SMS,
AUTHENTICATOR_APP,
EMAIL_MAGIC_LINK,
EMAIL_OTP,
PUSH,
DEVICE,
SECURITY_KEY,
PASSKEY,
VERIFF,
IPROOV,
PALM_BIOMETRICS_RR,
IDVERSE
​
verifiedByAuthenticatorId
string

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

​
userAgent
string

The user agent provided when the action was tracked.

​
ipAddress
string

The IP address provided when the action was tracked.

​
countryCode
string

The country code derived from the IP address if provided.