TypeScript server

The @turnkey/sdk-server package exposes functionality that lets developers build server-side functionality for applications that interact with the Turnkey API.

Overview

It exposes a ready-made API client class which manages the process of constructing requests to the Turnkey API and authenticating them with a valid API key. Furthermore, it exposes API proxies that forward requests from your application’s client that need to be signed by parent organizations API key.

Use the @turnkey/sdk-server package to handle server-side interactions for applications that interact with the Turnkey API.

Installation

NPM

npm install @turnkey/sdk-server

yarn add @turnkey/sdk-server

Initializing

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

const turnkey = new Turnkey({
  defaultOrganizationId: process.env.TURNKEY_ORGANIZATION_ID,
  apiBaseUrl: "https://api.turnkey.com",
  apiPrivateKey: process.env.TURNKEY_API_PRIVATE_KEY,
  apiPublicKey: process.env.TURNKEY_API_PUBLIC_KEY,
});

Parameters

config · TurnkeySDKServerConfig · required

An object containing configuration settings for the Server Client.

defaultOrganizationId · string · required

The root organization that requests will be made from unless otherwise specified

apiBaseUrl · string · required

The base URL that API requests will be sent to (use https://api.turnkey.com when making requests to Turnkey’s API)

apiPrivateKey · string

The API Private Key to sign requests with (this will normally be the API Private Key to your root organization)

apiPublicKey · string

The API Public Key associated with the configured API Private Key above

Creating clients

Calls to Turnkey’s API must be signed with a valid credential (often referred to in the docs as stamping) from the user initiating the API call. When using the Server SDK, the user initiating the API call is normally your root organization, and the API call is authenticated with the API keypair you create on the Turnkey dashboard.

apiClient()

The apiClient method returns an instance of the TurnkeyApiClient which will sign requests with the injected apiPrivateKey, and apiPublicKey credentials.

const apiClient = turnkey.apiClient();
const walletsResponse = await apiClient.getWallets();

// this will sign the request with the configured api credentials

Creating API proxies

There are certain actions that are initiated by users, but require the activity to be signed by the root organization itself. Examples of this include the initial creation of the user subOrganization or sending an email to a user with a login credential as part of an emailAuth flow.

These can be implemented in your backend by creating an apiClient and handling requests from your browser application at different routes, but we have also provided a convenience method for doing this by having allowing a single apiProxy to handle requests at a single route and automatically sign specific user actions with the root organization’s credentials.

expressProxyHandler()

The expressProxyHandler() method creates a proxy handler designed as a middleware for Express applications. It provides an API endpoint that forwards requests to the Turnkey API server.

const turnkeyProxyHandler = turnkey.expressProxyHandler({
  allowedMethods: ["createSubOrganization", "emailAuth", "getSubOrgIds"],
});

app.post("/apiProxy", turnkeyProxyHandler);

// this will sign requests made with the client-side `serverSign` function with the root organization's API key for the allowedMethods in the config

2. nextProxyHandler()

The nextProxyHandler() method creates a proxy handler designed as a middleware for Next.js applications. It provides an API endpoint that forwards requests to the Turnkey API server.

// Configure the Next.js handler with allowed methods
const turnkeyProxyHandler = turnkey.nextProxyHandler({
  allowedMethods: ["createSubOrganization", "emailAuth", "getSubOrgIds"],
});

export default turnkeyProxyHandler;

// this will sign requests made with the client-side `serverSign` function with the root organization's API key for the allowedMethods in the config

TurnkeyServerClient

The @turnkey/sdk-server exposes NextJS Server Actions. These server actions can be used to facilitate implementing common authentication flows.

sendOtp()

Initiate an OTP authentication flow for either an EMAIL or SMS.

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

const turnkey = new Turnkey({
  apiBaseUrl: "https://api.turnkey.com",
  defaultOrganizationId: process.env.NEXT_PUBLIC_ORGANIZATION_ID!,
});

const indexedDbClient = turnkey.indexedDbClient();

const initAuthResponse = await server.sendOtp({
  suborgID: suborgId!,
  otpType,
  contact: value,
  userIdentifier: await indexedDbClient.getPublicKey(),
  ...(emailCustomization && { emailCustomization }),
  ...(sendFromEmailAddress && { sendFromEmailAddress }),
  ...(customSmsMessage && { customSmsMessage }),
  otpLength: 6,
  alphanumeric: true,
});

if (initAuthResponse?.otpId) {
  // Proceed to verifyOtp
} else {
  // Handle error
}

Parameters

request · SendOtpRequest · required

An object containing the parameters to initiate an EMAIL or SMS OTP authentication flow.

suborgID · string · required

The ID of the sub organization for the given request.

otpType · string · required

The type of OTP request, either EMAIL or SMS.

contact · string · required

The contact information (email or phone number) where the OTP will be sent.

userIdentifier · string · required

The public key or other identifier used for rate limiting and logging.

customSmsMessage · string

Use to customize the SMS message.

emailCustomization · EmailCustomization

Use to customize the OTP email content.

sendFromEmailAddress · string

Provide a custom email address which will be used as the sender.

otpLength · number

Optionally specify the OTP length.

alphanumeric · boolean

Optionally specify whether to use alphanumeric codes. Defaults to true.

verifyOtp()

Verify the OTP Code sent to the user via EMAIL or SMS.

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

const turnkey = new Turnkey({
  apiBaseUrl: "https://api.turnkey.com",
  defaultOrganizationId: process.env.NEXT_PUBLIC_ORGANIZATION_ID!,
});

const indexedDbClient = turnkey.indexedDbClient();

const verifyResponse = await server.verifyOtp({
  otpId,
  otpCode,
  sessionLengthSeconds,
});

if (verifyResponse?.verificationToken) {
  const sessionResponse = await server.createOtpSession({
    suborgID: suborgId,
    verificationToken: verifyResponse.verificationToken,
    publicKey: await indexedDbClient.getPublicKey(),
    sessionLengthSeconds,
  });

  if (sessionResponse?.token) {
    await indexedDbClient.loginWithSession(sessionResponse);
    await onValidateSuccess();
  } else {
    // Handle session creation error
  }
} else {
  // Handle verification failure
}

Parameters

request · VerifyOtpRequest · required

An object containing the parameters to verify an OTP authentication attempt.

otpId · string · required

The ID returned by sendOtp() representing the OTP attempt.

otpCode · string · required

The OTP code entered by the user.

sessionLengthSeconds · number

Optional. The session lifetime in seconds. Defaults to 900 seconds (15 minutes).

createOauthSession()

Complete an OAuth authentication flow after obtaining an OIDC token from the OAuth provider. This creates a Turnkey session bound to the provided public key.

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

const turnkey = new Turnkey({
  apiBaseUrl: "https://api.turnkey.com",
  defaultOrganizationId: process.env.NEXT_PUBLIC_ORGANIZATION_ID!,
});

const indexedDbClient = turnkey.indexedDbClient();

const oauthSession = await server.createOauthSession({
  suborgID: suborgId!,
  oidcToken: credential,
  publicKey: await indexedDbClient.getPublicKey(),
  sessionLengthSeconds: authConfig.sessionLengthSeconds,
});

if (oauthSession?.session) {
  await indexedDbClient.loginWithSession(oauthSession);
  await onAuthSuccess();
} else {
  // Handle failure
}

Parameters

request · CreateOauthSessionRequest · required

An object containing the parameters to create a Turnkey session via OIDC.

suborgID · string · required

The ID of the sub organization for the authenticated user.

oidcToken · string · required

The OIDC token received from the third-party provider.

publicKey · string · required

The public key to bind the session to (used for stamping requests).

sessionLengthSeconds · number

Optional. Session lifetime in seconds. Defaults to 900 seconds (15 minutes).

sendCredential()

Send a login credential to a user’s email address.

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

const sendCredentialResponse = await server.sendCredential({
  email,
  targetPublicKey: authIframeClient?.iframePublicKey!,
  organizationId: suborgId!,
  ...(apiKeyName && { apiKeyName }),
  ...(sendFromEmailAddress && { sendFromEmailAddress }),
  ...(sessionLengthSeconds && { sessionLengthSeconds }),
  ...(invalidateExisting && { invalidateExisting }),
  ...(emailCustomization && { emailCustomization }),
  ...(sendFromEmailAddress && { sendFromEmailAddress }),
});

Parameters

request · InitEmailAuthRequest · required

An object containing the parameters to send a login credential via email.

email · string · required

The email address provided by the user.

targetPublicKey · string · required

The public key of the target user.

organizationId · string · required

The ID of the sub organization for the given request.

apiKeyName · string

The name of the API Key.

userIdentifier · string

IP Address, iframePublicKey, or other unique identifier used for rate limiting.

sessionLengthSeconds · number

Specify the length of the session in seconds. Defaults to 900 seconds or 15 minutes.

invalidateExisting · boolean

Invalidate all pre-existing sessions. Defaults to false.

emailCustomization · EmailCustomization

An option to customize the email.

sendFromEmailAddress · string

Provide a custom email address which will be used as the sender of the email.