Verify Generic OTP

Verify a Generic OTP

POST

/

public

/

v1

/

submit

/

verify_otp

Authorizations

API Key

X-Stamp

string

header

required

Body

type · enum<string> · required

Enum options: ACTIVITY_TYPE_VERIFY_OTP

timestampMs · string · required

Timestamp (in milliseconds) of the request, used to verify liveness of user requests.

organizationId · string · required

Unique identifier for a given Organization.

parameters · object · required

parameters field

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:

activity · object · required

The activity object containing type, intent, and result

Show activity details

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

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/verify_otp \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "type": "ACTIVITY_TYPE_VERIFY_OTP",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "otpId": "<string>",
        "otpCode": "<string>",
        "expirationSeconds": "<string>"
    }
}'

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_VERIFY_OTP",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "verifyOtpIntent": {
            "otpId": "<string>",
            "otpCode": "<string>",
            "expirationSeconds": "<string>"
          }
        },
        "result": {
          "verifyOtpResult": {
            "verificationToken": "<string>"
          }
        }
      }
    }
  }
}