Server API
Get User
Server API
Get User
A user is considered to be enrolled if they have set up at least one authenticator which can be used to issue a challenge.
GET
/
users
/
{userId}
Path Parameters
userId
string
requiredThe ID of the user.
Response
200 - application/json
email
string
The user's email address.
phoneNumber
string
The user's phone number in E.164 format.
isEnrolled
boolean
True if the user is enrolled with at least one verification method and can be challenged.
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 Was this page helpful?