Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.turnkey.com/llms.txt

Use this file to discover all available pages before exploring further.

X-Auth-Proxy-Config-Id
string
required
Your Auth Proxy config ID, found in Dashboard → AUTH. See Auth Proxy reference for setup.
otpType
string
required
Enum to specify whether to send OTP code via SMS or email
contact
string
required
Email or phone number to send the OTP code to
emailCustomization
object

emailCustomization field

A successful response returns the following fields:
otpId
string
required
Unique identifier for an OTP flow.
otpEncryptionTargetBundle
string
required
Signed bundle containing a target encryption key to use when submitting OTP codes.
curl --request POST \
  --url https://authproxy.turnkey.com/v1/otp_init_v2 \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Auth-Proxy-Config-Id: <string> (see Authorizations)" \
  --data '{
    "otpType": "<string>",
    "contact": "<string>",
    "emailCustomization": {
        "templateId": "<string>"
    }
}'
{
  "otpId": "<string>",
  "otpEncryptionTargetBundle": "<string>"
}