Server API
Get User
Server API
Get User
Retrieve information about a user.
GET
/
users
/
{userId}
Path Parameters
userId
string
requiredThe ID of the user.
Response
200 - application/json
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.
Available options:
SMS, AUTHENTICATOR_APP, EMAIL_MAGIC_LINK, EMAIL_OTP, PUSH, SECURITY_KEY, PASSKEY, VERIFF, IPROOV, PALM_BIOMETRICS_RR, IDVERSE enrolledVerificationMethods
enum<string>[]
The list of verification methods which the user has enrolled.
Available options:
SMS, AUTHENTICATOR_APP, EMAIL_MAGIC_LINK, EMAIL_OTP, PUSH, SECURITY_KEY, PASSKEY, VERIFF, IPROOV, PALM_BIOMETRICS_RR, IDVERSE defaultVerificationMethod
enum<string>
Available options:
SMS, AUTHENTICATOR_APP, EMAIL_MAGIC_LINK, EMAIL_OTP, PUSH, 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.
Was this page helpful?