Skip to main content

OTPCreateParms

The OTP to create.

Properties

NameTypeDescriptionNotes
applicationIdStringUnique identifier of the Identity as a Service Authentication API application
clientIpStringProvided client IP address.[optional]
deliverOTPBooleanWhether to deliver the OTP. If not specified, this defaults to true.[optional]
otpDeliveryTypeOtpDeliveryTypeEnumDefines how a user receives their one-time passcode (Email, Text message (SMS), or Voice message (VOICE)).[optional]
returnOTPBooleanWhether to return the OTP. If not specified, this defaults to false.[optional]
transactionDetailsList<TransactionDetail>Defines transaction details to be associated with the OTP.[optional]
userIdStringUser ID (containing the user ID or a user alias) of the Identity as a Service user the OTP is being created for.

OtpDeliveryTypeEnum

NameValue
EMAIL"EMAIL"
SMS"SMS"
VOICE"VOICE"