OTP auth

Authenticate a user with an OTP code sent via email or SMS.

POST

/

public

/

v1

/

submit

/

otp_auth

Authorizations

API Key

X-Stamp · string · required

Cryptographically signed (stamped) request to be passed in as a header. For more info, see here.

WebAuthn (Passkey)

X-Stamp-WebAuthn · string · required

Cryptographically signed (stamped) request to be passed in as a header. For more info, see here.

Body

type · enum<string> · required

Enum options: ACTIVITY_TYPE_OTP_AUTH

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

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.targetPublicKey

string

required

Client-side public key generated by the user, to which the OTP bundle (credentials) will be encrypted.

parameters.apiKeyName

string

Optional human-readable name for an API Key. If none provided, default to OTP Auth - <Timestamp>

parameters.expirationSeconds

string

Expiration window (in seconds) indicating how long the API key is valid for. If not provided, a default of 15 minutes will be used.

parameters.invalidateExisting

boolean

Invalidate all other previously generated OTP Auth API keys

Response

A successful response returns the following fields:

activity · object · required

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.otpAuthIntent

object

required

The otpAuthIntent object

Show otpAuthIntent details

activity.intent.otpAuthIntent.otpId

string

required

ID representing the result of an init OTP activity.

activity.intent.otpAuthIntent.otpCode

string

required

OTP sent out to a user’s contact (email or SMS)

activity.intent.otpAuthIntent.targetPublicKey

string

required

Client-side public key generated by the user, to which the OTP bundle (credentials) will be encrypted.

activity.intent.otpAuthIntent.apiKeyName

string

Optional human-readable name for an API Key. If none provided, default to OTP Auth - <Timestamp>

activity.intent.otpAuthIntent.expirationSeconds

string

Expiration window (in seconds) indicating how long the API key is valid for. If not provided, a default of 15 minutes will be used.

activity.intent.otpAuthIntent.invalidateExisting

boolean

Invalidate all other previously generated OTP Auth API keys

activity.result

object

required

The result of the activity

Show result details

activity.result.otpAuthResult

object

required

The otpAuthResult object

Show otpAuthResult details

activity.result.otpAuthResult.userId

string

required

Unique identifier for the authenticating User.

activity.result.otpAuthResult.apiKeyId

string

Unique identifier for the created API key.

activity.result.otpAuthResult.credentialBundle

string

HPKE encrypted credential bundle

activity.votes

array

required

A list of objects representing a particular User’s approval or rejection of a Consensus request, including all relevant metadata.

activity.fingerprint

string

required

An artifact verifying a User’s action.

activity.canApprove

boolean

required

Whether the activity can be approved.

activity.canReject

boolean

required

Whether the activity can be rejected.

activity.createdAt

string

required

The creation timestamp.

activity.updatedAt

string

required

The last update timestamp.

cURL

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

import { Turnkey } from "@turnkey/sdk-server";

const turnkeyClient = new Turnkey({
  apiBaseUrl: "https://api.turnkey.com",
  apiPublicKey: process.env.API_PUBLIC_KEY!,
  apiPrivateKey: process.env.API_PRIVATE_KEY!,
  defaultOrganizationId: process.env.ORGANIZATION_ID!,
});

const response = await turnkeyClient.apiClient().otpAuth({
  otpId: "<string> (ID representing the result of an init OTP activity.)",
  otpCode: "<string> (OTP sent out to a user's contact (email or SMS))",
  targetPublicKey: "<string> (Client-side public key generated by the user, to which the OTP bundle (credentials) will be encrypted.)",
  apiKeyName: "<string> (Optional human-readable name for an API Key. If none provided, default to OTP Auth - <Timestamp>)",
  expirationSeconds: "<string> (Expiration window (in seconds) indicating how long the API key is valid for. If not provided, a default of 15 minutes will be used.)",
  invalidateExisting: true // Invalidate all other previously generated OTP Auth API keys
});

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_OTP_AUTH",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "otpAuthIntent": {
            "otpId": "<string>",
            "otpCode": "<string>",
            "targetPublicKey": "<string>",
            "apiKeyName": "<string>",
            "expirationSeconds": "<string>",
            "invalidateExisting": "<boolean>"
          }
        },
        "result": {
          "otpAuthResult": {
            "userId": "<string>",
            "apiKeyId": "<string>",
            "credentialBundle": "<string>"
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}