Skip to main content
GET
/
users
/
{userId}
Get user
curl --request GET \
  --url https://api.authsignal.com/v1/users/{userId} \
  --header 'Authorization: Basic <encoded-value>'
{
  "isEnrolled": true,
  "email": "<string>",
  "phoneNumber": "<string>",
  "username": "<string>",
  "displayName": "<string>",
  "allowedVerificationMethods": [
    "SMS"
  ],
  "enrolledVerificationMethods": [
    "SMS"
  ],
  "defaultVerificationMethod": "SMS",
  "custom": {},
  "locale": "en"
}

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.

Response

OK

​
isEnrolled
boolean

True if the user is enrolled with at least one verification method and can be challenged.

​
email
string

The user's email address.

​
phoneNumber
string

The user's phone number in E.164 format.

​
username
string

The username used as the primary identifier for passkeys, e.g. an email address.

​
displayName
string

The display name used as an optional secondary identifier for passkeys, e.g. the user's full name.

​
allowedVerificationMethods
enum<string>[]

The list of verification methods which the user is permitted to enroll.

​
enrolledVerificationMethods
enum<string>[]

The list of verification methods which the user has enrolled.

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

A JSON object which can include any key/value pairs. Should be provided when using rules based on your own data points.

​
locale
string

The locale of the user.

Example:

"en"