Perform Email Auth

Authenticate a user via Email

POST

/

public

/

v1

/

submit

/

email_auth

Authorizations

API Key

X-Stamp

string

header

required

Body

type · enum<string> · required

Enum options: ACTIVITY_TYPE_EMAIL_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

Show details

parameters.email

string

required

Email of the authenticating user.

parameters.targetPublicKey

string

required

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

parameters.apiKeyName

string

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

parameters.expirationSeconds

string

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

parameters.emailCustomization · object

emailCustomization field

Show details

parameters.emailCustomization.appName

string

The name of the application.

parameters.emailCustomization.logoUrl

string

A URL pointing to a logo in PNG format. Note this logo will be resized to fit into 340px x 124px.

parameters.emailCustomization.magicLinkTemplate

string

A template for the URL to be used in a magic link button, e.g. https://dapp.xyz/%s. The auth bundle will be interpolated into the %s.

parameters.emailCustomization.templateVariables

string

JSON object containing key/value pairs to be used with custom templates.

parameters.emailCustomization.templateId

string

Unique identifier for a given Email Template. If not specified, the default is the most recent Email Template.

parameters.invalidateExisting

boolean

Invalidate all other previously generated Email Auth API keys

parameters.sendFromEmailAddress

string

Optional custom email address from which to send the email

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

object

required

The emailAuthIntent object

Show emailAuthIntent details

activity.intent.emailAuthIntent.email

string

required

Email of the authenticating user.

activity.intent.emailAuthIntent.targetPublicKey

string

required

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

activity.intent.emailAuthIntent.apiKeyName

string

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

activity.intent.emailAuthIntent.expirationSeconds

string

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

activity.intent.emailAuthIntent.emailCustomization

object

emailCustomization field

Show emailCustomization details

activity.intent.emailAuthIntent.emailCustomization.appName

string

The name of the application.

activity.intent.emailAuthIntent.emailCustomization.logoUrl

string

A URL pointing to a logo in PNG format. Note this logo will be resized to fit into 340px x 124px.

activity.intent.emailAuthIntent.emailCustomization.magicLinkTemplate

string

A template for the URL to be used in a magic link button, e.g. https://dapp.xyz/%s. The auth bundle will be interpolated into the %s.

activity.intent.emailAuthIntent.emailCustomization.templateVariables

string

JSON object containing key/value pairs to be used with custom templates.

activity.intent.emailAuthIntent.emailCustomization.templateId

string

Unique identifier for a given Email Template. If not specified, the default is the most recent Email Template.

activity.intent.emailAuthIntent.invalidateExisting

boolean

Invalidate all other previously generated Email Auth API keys

activity.intent.emailAuthIntent.sendFromEmailAddress

string

Optional custom email address from which to send the email

activity.result

object

required

The result of the activity

Show result details

activity.result.emailAuthResult

object

required

The emailAuthResult object

Show emailAuthResult details

activity.result.emailAuthResult.userId

string

required

Unique identifier for the authenticating User.

activity.result.emailAuthResult.apiKeyId

string

required

Unique identifier for the created API key.

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/email_auth \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "type": "ACTIVITY_TYPE_EMAIL_AUTH_V2",
    "timestampMs": "<string> (e.g., 1745474677470)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "email": "<string>",
        "targetPublicKey": "<string>",
        "apiKeyName": "<string>",
        "expirationSeconds": "<string>",
        "emailCustomization": {
            "appName": "<string>",
            "logoUrl": "<string>",
            "magicLinkTemplate": "<string>",
            "templateVariables": "<string>",
            "templateId": "<string>"
        },
        "invalidateExisting": true,
        "sendFromEmailAddress": "<string>"
    }
}'

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_EMAIL_AUTH_V2",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g., 1745474677470)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "emailAuthIntent": {
            "email": "<string>",
            "targetPublicKey": "<string>",
            "apiKeyName": "<string>",
            "expirationSeconds": "<string>",
            "emailCustomization": {
              "appName": "<string>",
              "logoUrl": "<string>",
              "magicLinkTemplate": "<string>",
              "templateVariables": "<string>",
              "templateId": "<string>"
            },
            "invalidateExisting": true,
            "sendFromEmailAddress": "<string>"
          }
        },
        "result": {
          "emailAuthResult": {
            "userId": "<string>",
            "apiKeyId": "<string>"
          }
        }
      }
    }
  }
}