Sign in

v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-03-02333644.7 KB
Factors

Enroll an authentication factor

Create a new authentication factor. For OTP types (EMAIL_OTP, SMS_OTP), an otpCode is returned that must be delivered to the user. For PASSWORD type, provide the plaintext password in secret.

post/api/cis/v1/identities/{id}/factors

Request body

type'EMAIL_OTP' | 'SMS_OTP' | 'PASSWORD' | 'TOTP' required
handlestring

Email or phone for OTP types

secretstring password

Plaintext password (for PASSWORD type only)

Response

Factor enrolled

idstring uuid
identityIdstring uuid
type'EMAIL_OTP' | 'SMS_OTP' | 'PASSWORD' | 'TOTP'
status'PENDING' | 'VERIFIED' | 'REVOKED'
handlestring nullable
createdAtstring date-time
updatedAtstring date-time
otpCodestring

OTP code (only for EMAIL_OTP/SMS_OTP types)