curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/init_otp_auth \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "type": "ACTIVITY_TYPE_INIT_OTP_AUTH_V2",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "otpType": "<string>",
        "contact": "<string>",
        "otpLength": 123,
        "emailCustomization": {
            "appName": "<string>",
            "logoUrl": "<string>",
            "magicLinkTemplate": "<string>",
            "templateVariables": "<string>",
            "templateId": "<string>"
        },
        "smsCustomization": {
            "template": "<string>"
        },
        "userIdentifier": "<string>",
        "sendFromEmailAddress": "<string>",
        "alphanumeric": true,
        "sendFromEmailSenderName": "<string>",
        "replyToEmailAddress": "<string>"
    }
}'

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_INIT_OTP_AUTH_V2",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "initOtpAuthIntentV2": {
            "otpType": "<string>",
            "contact": "<string>",
            "otpLength": 123,
            "emailCustomization": {
              "appName": "<string>",
              "logoUrl": "<string>",
              "magicLinkTemplate": "<string>",
              "templateVariables": "<string>",
              "templateId": "<string>"
            },
            "smsCustomization": {
              "template": "<string>"
            },
            "userIdentifier": "<string>",
            "sendFromEmailAddress": "<string>",
            "alphanumeric": true,
            "sendFromEmailSenderName": "<string>",
            "replyToEmailAddress": "<string>"
          }
        },
        "result": {
          "initOtpAuthResultV2": {
            "otpId": "<string>"
          }
        }
      }
    }
  }
}
POST
/
public
/
v1
/
submit
/
init_otp_auth

Authorizations

X-Stamp
string
header
required

Body

​
type
enum<string>
required

Enum options: ACTIVITY_TYPE_INIT_OTP_AUTH_V2

​
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

Response

A successful response returns the following fields:

​
activity
object
required

The activity object containing type, intent, and result

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/init_otp_auth \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "type": "ACTIVITY_TYPE_INIT_OTP_AUTH_V2",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "otpType": "<string>",
        "contact": "<string>",
        "otpLength": 123,
        "emailCustomization": {
            "appName": "<string>",
            "logoUrl": "<string>",
            "magicLinkTemplate": "<string>",
            "templateVariables": "<string>",
            "templateId": "<string>"
        },
        "smsCustomization": {
            "template": "<string>"
        },
        "userIdentifier": "<string>",
        "sendFromEmailAddress": "<string>",
        "alphanumeric": true,
        "sendFromEmailSenderName": "<string>",
        "replyToEmailAddress": "<string>"
    }
}'

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_INIT_OTP_AUTH_V2",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "initOtpAuthIntentV2": {
            "otpType": "<string>",
            "contact": "<string>",
            "otpLength": 123,
            "emailCustomization": {
              "appName": "<string>",
              "logoUrl": "<string>",
              "magicLinkTemplate": "<string>",
              "templateVariables": "<string>",
              "templateId": "<string>"
            },
            "smsCustomization": {
              "template": "<string>"
            },
            "userIdentifier": "<string>",
            "sendFromEmailAddress": "<string>",
            "alphanumeric": true,
            "sendFromEmailSenderName": "<string>",
            "replyToEmailAddress": "<string>"
          }
        },
        "result": {
          "initOtpAuthResultV2": {
            "otpId": "<string>"
          }
        }
      }
    }
  }
}