users
Get user
Retrieve information about a user.
get/users/{userId}
Path parameters
userIdstring required
The ID of the user.
Response
OK
isEnrolledboolean
True if the user is enrolled with at least one verification method and can be challenged.
emailstring
The user's email address.
phoneNumberstring
The user's phone number in E.164 format.
usernamestring
The username used as the primary identifier for passkeys, e.g. an email address.
displayNamestring
The display name used as an optional secondary identifier for passkeys, e.g. the user's full name.
allowedVerificationMethodsVerificationMethod[]
The list of verification methods which the user is permitted to enroll.
enrolledVerificationMethodsVerificationMethod[]
The list of verification methods which the user has enrolled.
defaultVerificationMethod'SMS' | 'AUTHENTICATOR_APP' | 'EMAIL_MAGIC_LINK' | 'EMAIL_OTP' | 'PUSH' | 'DEVICE' | 'SECURITY_KEY' | 'PASSKEY' | 'VERIFF' | 'IPROOV' | 'PALM_BIOMETRICS_RR' | 'IDVERSE'
customobject
A JSON object which can include any key/value pairs. Should be provided when using rules based on your own data points.
localestring
The locale of the user in BCP 47 format. Used to localize the pre-built UI, email, and SMS messages.
Example response
{
"locale": "es"
}