The parameters object containing the specific intent data for this activity.
Show details
parameters.otpId
string
required
ID representing the result of an init OTP activity.
parameters.otpCode
string
required
OTP sent out to a user’s contact (email or SMS)
parameters.expirationSeconds
string
Expiration window (in seconds) indicating how long the verification token is valid for. If not provided, a default of 1 hour will be used. Maximum value is 86400 seconds (24 hours)
Response
A successful response returns the following fields:
The activity object containing type, intent, and result
Show activity details
activity.id
string
required
Unique identifier for a given Activity object.
activity.organizationId
string
required
Unique identifier for a given Organization.
activity.status
string
required
The activity status
activity.type
string
required
The activity type
activity.intent
object
required
The intent of the activity
Show intent details
activity.intent.verifyOtpIntent
object
required
The verifyOtpIntent object
Show verifyOtpIntent details
activity.intent.verifyOtpIntent.otpId
string
required
ID representing the result of an init OTP activity.
activity.intent.verifyOtpIntent.otpCode
string
required
OTP sent out to a user’s contact (email or SMS)
activity.intent.verifyOtpIntent.expirationSeconds
string
Expiration window (in seconds) indicating how long the verification token is valid for. If not provided, a default of 1 hour will be used. Maximum value is 86400 seconds (24 hours)
activity.result
object
required
The result of the activity
Show result details
activity.result.verifyOtpResult
object
required
The verifyOtpResult object
Show verifyOtpResult details
activity.result.verifyOtpResult.verificationToken
string
required
Signed JWT containing a unique id, expiry, verification type, contact. Verification status of a user is updated when the token is consumed (in OTP_LOGIN requests)
activity.votes
array
required
A list of objects representing a particular User’s approval or rejection of a Consensus request, including all relevant metadata.