Perform Email Auth

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: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_EMAIL_AUTH_V2",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "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": "<boolean>",
        "sendFromEmailAddress": "<string>",
        "sendFromEmailSenderName": "<string>",
        "replyToEmailAddress": "<string>"
    }
}'

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_EMAIL_AUTH_V2",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "emailAuthIntentV2": {
            "email": "<string>",
            "targetPublicKey": "<string>",
            "apiKeyName": "<string>",
            "expirationSeconds": "<string>",
            "emailCustomization": {
              "appName": "<string>",
              "logoUrl": "<string>",
              "magicLinkTemplate": "<string>",
              "templateVariables": "<string>",
              "templateId": "<string>"
            },
            "invalidateExisting": "<boolean>",
            "sendFromEmailAddress": "<string>",
            "sendFromEmailSenderName": "<string>",
            "replyToEmailAddress": "<string>"
          }
        },
        "result": {
          "emailAuthResult": {
            "userId": "<string>",
            "apiKeyId": "<string>"
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}

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: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_EMAIL_AUTH_V2",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "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": "<boolean>",
        "sendFromEmailAddress": "<string>",
        "sendFromEmailSenderName": "<string>",
        "replyToEmailAddress": "<string>"
    }
}'

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_EMAIL_AUTH_V2",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "emailAuthIntentV2": {
            "email": "<string>",
            "targetPublicKey": "<string>",
            "apiKeyName": "<string>",
            "expirationSeconds": "<string>",
            "emailCustomization": {
              "appName": "<string>",
              "logoUrl": "<string>",
              "magicLinkTemplate": "<string>",
              "templateVariables": "<string>",
              "templateId": "<string>"
            },
            "invalidateExisting": "<boolean>",
            "sendFromEmailAddress": "<string>",
            "sendFromEmailSenderName": "<string>",
            "replyToEmailAddress": "<string>"
          }
        },
        "result": {
          "emailAuthResult": {
            "userId": "<string>",
            "apiKeyId": "<string>"
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}

POST

public

submit

email_auth

Authorizations

X-Stamp

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_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

The parameters object containing the specific intent data for this activity.

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

parameters.sendFromEmailSenderName

string

Optional custom sender name for use with sendFromEmailAddress; if left empty, will default to ‘Notifications’

parameters.replyToEmailAddress

string

Optional custom email address to use as reply-to

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

object

required

The emailAuthIntentV2 object

Show emailAuthIntentV2 details

activity.intent.emailAuthIntentV2.email

string

required

Email of the authenticating user.

activity.intent.emailAuthIntentV2.targetPublicKey

string

required

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

activity.intent.emailAuthIntentV2.apiKeyName

string

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

activity.intent.emailAuthIntentV2.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.emailAuthIntentV2.emailCustomization

object

emailCustomization field

Show emailCustomization details

activity.intent.emailAuthIntentV2.emailCustomization.appName

string

The name of the application.

activity.intent.emailAuthIntentV2.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.emailAuthIntentV2.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.emailAuthIntentV2.emailCustomization.templateVariables

string

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

activity.intent.emailAuthIntentV2.emailCustomization.templateId

string

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

activity.intent.emailAuthIntentV2.invalidateExisting

boolean

Invalidate all other previously generated Email Auth API keys

activity.intent.emailAuthIntentV2.sendFromEmailAddress

string

Optional custom email address from which to send the email

activity.intent.emailAuthIntentV2.sendFromEmailSenderName

string

Optional custom sender name for use with sendFromEmailAddress; if left empty, will default to ‘Notifications’

activity.intent.emailAuthIntentV2.replyToEmailAddress

string

Optional custom email address to use as reply-to

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.

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 --request POST \
  --url https://api.turnkey.com/public/v1/submit/email_auth \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_EMAIL_AUTH_V2",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "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": "<boolean>",
        "sendFromEmailAddress": "<string>",
        "sendFromEmailSenderName": "<string>",
        "replyToEmailAddress": "<string>"
    }
}'

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_EMAIL_AUTH_V2",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "emailAuthIntentV2": {
            "email": "<string>",
            "targetPublicKey": "<string>",
            "apiKeyName": "<string>",
            "expirationSeconds": "<string>",
            "emailCustomization": {
              "appName": "<string>",
              "logoUrl": "<string>",
              "magicLinkTemplate": "<string>",
              "templateVariables": "<string>",
              "templateId": "<string>"
            },
            "invalidateExisting": "<boolean>",
            "sendFromEmailAddress": "<string>",
            "sendFromEmailSenderName": "<string>",
            "replyToEmailAddress": "<string>"
          }
        },
        "result": {
          "emailAuthResult": {
            "userId": "<string>",
            "apiKeyId": "<string>"
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}

OTP auth Recover a user

Activities

Queries

Perform Email Auth

Authorizations

Body

Response