Skip to content

Users

Register users and manage sessions, profiles, and account recovery.

Fields

idstringUnique identifier of the resource.
emailstring
statusenuminactive · active · suspended · pendingDeletion · deleting
userNamestring
firstNamestring
lastNamestring
birthDatestring
documentTypeenumKind of identity or tax document.nationalId · passport · foreignId · taxId ·
See all 25 fields
genderenummale · female · other ·
documentNumberstringNational identity or tax document number.
phonestring
avatarUrlstring
addressstring
countryCodestringISO 3166-1 alpha-2 country code, for example PE.
isProfileCompleteboolean
isConfirmedboolean
isEmailConfirmedboolean
isPhoneNumberConfirmedboolean
isTwoFactorEnabledboolean
isActiveboolean
createdOnstringTimestamp when the resource was created, in ISO 8601.
rolesarray<string>
hasPasswordboolean
loginProvidersarray<string>
deletionScheduledOnstring

Operations

MethodEndpointOperation
POST/v1/usersRegister user
POST/v1/users/login-linkRequest login code
POST/v1/users/recovery-passwordRequest a password reset
POST/v1/users/reset-passwordReset a user password
GET/v1/users/meGet the current user
PUT/v1/users/meUpdate the current user
POST/v1/users/me/deletionSchedule the account for deletion
POST/v1/users/me/two-factorEnable two-factor authentication
GET/v1/users/me/passkeysList the passkeys of the current user
GET/v1/users/me/two-factorGet two-factor status
PUT/v1/users/me/passwordUpdate the current user's password
DELETE/v1/users/me/deletionCancel a scheduled account deletion
DELETE/v1/users/me/two-factorDisable two-factor authentication
POST/v1/users/me/two-factor/enrollmentStart authenticator enrollment
POST/v1/users/me/two-factor/recovery-codesGenerate new recovery codes
DELETE/v1/users/me/passkeys/{passkeyId}Delete a passkey of the current user
DELETE/v1/users/me/two-factor/remembered-devicesForget the devices that skip two-factor verification

Last updated: