Init Email Recovery

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

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "initUserEmailRecoveryIntent": {
            "email": "<string>",
            "targetPublicKey": "<string>",
            "expirationSeconds": "<string>",
            "emailCustomization": {
              "appName": "<string>",
              "logoUrl": "<string>",
              "magicLinkTemplate": "<string>",
              "templateVariables": "<string>",
              "templateId": "<string>"
            }
          }
        },
        "result": {
          "initUserEmailRecoveryResult": {
            "userId": "<string>"
          }
        }
      }
    }
  }
}

POST

public

submit

init_user_email_recovery

Authorizations

X-Stamp

string

header

required

Body

type

enum<string>

required

Enum options: ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY

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 user starting recovery

parameters.targetPublicKey

string

required

Client-side public key generated by the user, to which the recovery bundle will be encrypted.

parameters.expirationSeconds

string

Expiration window (in seconds) indicating how long the recovery credential 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.

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

object

required

The initUserEmailRecoveryIntent object

Show initUserEmailRecoveryIntent details

activity.intent.initUserEmailRecoveryIntent.email

string

required

Email of the user starting recovery

activity.intent.initUserEmailRecoveryIntent.targetPublicKey

string

required

Client-side public key generated by the user, to which the recovery bundle will be encrypted.

activity.intent.initUserEmailRecoveryIntent.expirationSeconds

string

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

activity.intent.initUserEmailRecoveryIntent.emailCustomization

object

emailCustomization field

Show emailCustomization details

activity.intent.initUserEmailRecoveryIntent.emailCustomization.appName

string

The name of the application.

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

string

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

activity.intent.initUserEmailRecoveryIntent.emailCustomization.templateId

string

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

activity.result

object

required

The result of the activity

Show result details

activity.result.initUserEmailRecoveryResult

object

required

The initUserEmailRecoveryResult object

Show initUserEmailRecoveryResult details

activity.result.initUserEmailRecoveryResult.userId

string

required

Unique identifier for the user being recovered.

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

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "initUserEmailRecoveryIntent": {
            "email": "<string>",
            "targetPublicKey": "<string>",
            "expirationSeconds": "<string>",
            "emailCustomization": {
              "appName": "<string>",
              "logoUrl": "<string>",
              "magicLinkTemplate": "<string>",
              "templateVariables": "<string>",
              "templateId": "<string>"
            }
          }
        },
        "result": {
          "initUserEmailRecoveryResult": {
            "userId": "<string>"
          }
        }
      }
    }
  }
}

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

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "initUserEmailRecoveryIntent": {
            "email": "<string>",
            "targetPublicKey": "<string>",
            "expirationSeconds": "<string>",
            "emailCustomization": {
              "appName": "<string>",
              "logoUrl": "<string>",
              "magicLinkTemplate": "<string>",
              "templateVariables": "<string>",
              "templateId": "<string>"
            }
          }
        },
        "result": {
          "initUserEmailRecoveryResult": {
            "userId": "<string>"
          }
        }
      }
    }
  }
}

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

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "initUserEmailRecoveryIntent": {
            "email": "<string>",
            "targetPublicKey": "<string>",
            "expirationSeconds": "<string>",
            "emailCustomization": {
              "appName": "<string>",
              "logoUrl": "<string>",
              "magicLinkTemplate": "<string>",
              "templateVariables": "<string>",
              "templateId": "<string>"
            }
          }
        },
        "result": {
          "initUserEmailRecoveryResult": {
            "userId": "<string>"
          }
        }
      }
    }
  }
}

POST

public

submit

init_user_email_recovery

Authorizations

X-Stamp

string

header

required

Body

type

enum<string>

required

Enum options: ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY

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 user starting recovery

parameters.targetPublicKey

string

required

Client-side public key generated by the user, to which the recovery bundle will be encrypted.

parameters.expirationSeconds

string

Expiration window (in seconds) indicating how long the recovery credential 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.

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

object

required

The initUserEmailRecoveryIntent object

Show initUserEmailRecoveryIntent details

activity.intent.initUserEmailRecoveryIntent.email

string

required

Email of the user starting recovery

activity.intent.initUserEmailRecoveryIntent.targetPublicKey

string

required

Client-side public key generated by the user, to which the recovery bundle will be encrypted.

activity.intent.initUserEmailRecoveryIntent.expirationSeconds

string

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

activity.intent.initUserEmailRecoveryIntent.emailCustomization

object

emailCustomization field

Show emailCustomization details

activity.intent.initUserEmailRecoveryIntent.emailCustomization.appName

string

The name of the application.

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

string

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

activity.intent.initUserEmailRecoveryIntent.emailCustomization.templateId

string

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

activity.result

object

required

The result of the activity

Show result details

activity.result.initUserEmailRecoveryResult

object

required

The initUserEmailRecoveryResult object

Show initUserEmailRecoveryResult details

activity.result.initUserEmailRecoveryResult.userId

string

required

Unique identifier for the user being recovered.

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

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "initUserEmailRecoveryIntent": {
            "email": "<string>",
            "targetPublicKey": "<string>",
            "expirationSeconds": "<string>",
            "emailCustomization": {
              "appName": "<string>",
              "logoUrl": "<string>",
              "magicLinkTemplate": "<string>",
              "templateVariables": "<string>",
              "templateId": "<string>"
            }
          }
        },
        "result": {
          "initUserEmailRecoveryResult": {
            "userId": "<string>"
          }
        }
      }
    }
  }
}

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

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "initUserEmailRecoveryIntent": {
            "email": "<string>",
            "targetPublicKey": "<string>",
            "expirationSeconds": "<string>",
            "emailCustomization": {
              "appName": "<string>",
              "logoUrl": "<string>",
              "magicLinkTemplate": "<string>",
              "templateVariables": "<string>",
              "templateId": "<string>"
            }
          }
        },
        "result": {
          "initUserEmailRecoveryResult": {
            "userId": "<string>"
          }
        }
      }
    }
  }
}

Authorizations

Body

Response

Changelogs

Authorizations

Body

Response