Init Email Recovery
Initializes a new 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., 1745474677471)",
"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., 1745474677471)",
"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
Enum options: ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY
Timestamp (in milliseconds) of the request, used to verify liveness of user requests.
Unique identifier for a given Organization.
parameters field
Show details
Show details
Client-side public key generated by the user, to which the recovery bundle will be encrypted.
Expiration window (in seconds) indicating how long the recovery credential is valid. If not provided, a default of 15 minutes will be used.
emailCustomization field
Show details
Show details
A URL pointing to a logo in PNG format. Note this logo will be resized to fit into 340px x 124px.
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.
JSON object containing key/value pairs to be used with custom templates.
Response
A successful response returns the following fields:
The activity object containing type, intent, and result
Show activity details
Show activity details
The intent of the activity
Show intent details
Show intent details
The initUserEmailRecoveryIntent object
Show initUserEmailRecoveryIntent details
Show initUserEmailRecoveryIntent details
Client-side public key generated by the user, to which the recovery bundle will be encrypted.
Expiration window (in seconds) indicating how long the recovery credential is valid. If not provided, a default of 15 minutes will be used.
emailCustomization field
Show emailCustomization details
Show emailCustomization details
The name of the application.
A URL pointing to a logo in PNG format. Note this logo will be resized to fit into 340px x 124px.
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.
JSON object containing key/value pairs to be used with custom templates.
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., 1745474677471)",
"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., 1745474677471)",
"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>"
}
}
}
}
}
}
Was this page helpful?
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., 1745474677471)",
"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., 1745474677471)",
"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>"
}
}
}
}
}
}
Activities
- Overview
- Create API Keys
- Create Authenticators
- Create Invitations
- Create Oauth Providers
- Create Policies
- Create Policy
- Create Private Key Tag
- Create Private Keys
- Create Read Only Session
- Create Read Write Session
- Create Sub-Organization
- Create User Tag
- Create Users
- Create Wallet
- Create Wallet Accounts
- Delete API Keys
- Delete Authenticators
- Delete Invitation
- Delete Oauth Providers
- Delete Policy
- Delete Private Key Tags
- Delete Private Keys
- Delete Sub Organization
- Delete User Tags
- Delete Users
- Delete Wallets
- Export Private Key
- Export Wallet
- Export Wallet Account
- Import Private Key
- Import Wallet
- Init Email Recovery
- Init Import Private Key
- Init Import Wallet
- Init OTP auth
- Oauth
- OTP auth
- Perform Email Auth
- Recover a user
- Remove Organization Feature
- Set Organization Feature
- Sign Raw Payload
- Sign Raw Payloads
- Sign Transaction
- Update Policy
- Update Private Key Tag
- Update Root Quorum
- Update User
- Update User Tag
- Update Wallet
Queries
- Overview
- Get Activity
- Get API key
- Get Authenticator
- Get Authenticators
- Get Configs
- Get Oauth providers
- Get Policy
- Get Private Key
- Get Suborgs
- Get User
- Get Verified Suborgs
- Get Wallet
- Get Wallet Account
- List Activities
- List Policies
- List Private Key Tags
- List Private Keys
- List User Tags
- List Users
- List Wallets
- List Wallets Accounts
- Who am I?
Init Email Recovery
Initializes a new 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., 1745474677471)",
"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., 1745474677471)",
"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
Enum options: ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY
Timestamp (in milliseconds) of the request, used to verify liveness of user requests.
Unique identifier for a given Organization.
parameters field
Show details
Show details
Client-side public key generated by the user, to which the recovery bundle will be encrypted.
Expiration window (in seconds) indicating how long the recovery credential is valid. If not provided, a default of 15 minutes will be used.
emailCustomization field
Show details
Show details
A URL pointing to a logo in PNG format. Note this logo will be resized to fit into 340px x 124px.
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.
JSON object containing key/value pairs to be used with custom templates.
Response
A successful response returns the following fields:
The activity object containing type, intent, and result
Show activity details
Show activity details
The intent of the activity
Show intent details
Show intent details
The initUserEmailRecoveryIntent object
Show initUserEmailRecoveryIntent details
Show initUserEmailRecoveryIntent details
Client-side public key generated by the user, to which the recovery bundle will be encrypted.
Expiration window (in seconds) indicating how long the recovery credential is valid. If not provided, a default of 15 minutes will be used.
emailCustomization field
Show emailCustomization details
Show emailCustomization details
The name of the application.
A URL pointing to a logo in PNG format. Note this logo will be resized to fit into 340px x 124px.
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.
JSON object containing key/value pairs to be used with custom templates.
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., 1745474677471)",
"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., 1745474677471)",
"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>"
}
}
}
}
}
}
Was this page helpful?
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., 1745474677471)",
"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., 1745474677471)",
"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>"
}
}
}
}
}
}