Skip to contentSkip to navigationSkip to topbar
Rate this Page:

Export TOTP Secret Seed for Migrating to Verify TOTP


(warning)

Warning

As of November 2022, Twilio no longer provides support for Authy SMS/Voice-only customers. Customers who were also using Authy TOTP or Push prior to March 1, 2023 are still supported. The Authy API is now closed to new customers and will be fully deprecated in the future.

For new development, we encourage you to use the Verify v2 API.

Existing customers will not be impacted at this time until Authy API has reached End of Life. For more information about migration, see Migrating from Authy to Verify for SMS(link takes you to an external page).

(warning)

Warning

This API is only available for customers who intend to migrate Authy Google Auth TOTP to Verify TOTP.

(warning)

Warning

By default, customers do not have access to this API endpoint. To request access, please contact support team.(link takes you to an external page)


Export TOTP secret seed of a user

export-totp-secret-seed-of-a-user page anchor

This endpoint returns a TOTP secret seed and the otp for an authy_id. The secret seed and otp can be used to create and validate Verify TOTP factors.


_10
GET https://api.authy.com/protected/json/users/{authy_id}/secret/export

Parameters

parameters page anchor

The X-Authy-API-Key header needs to be passed for protected endpoints.

NameTypeDescription
authy_idIntegerUnique identifier of the user.
NameTypeDescription
secretStringSecret seed of the user.
otpStringValid OTP to verify Factor once it's created.

Status Codes

status-codes page anchor

The following are the status codes supported by this API.

CodeDescription
200The request has succeeded.
400The request was invalid.
404The resource was not found.
500Internal Server Error.

When the API returns a status other than 200, we add an error code in the message response body. For further information, please check the error codes page for a complete list of possible errors.

CodeDescription
60026User not found.
60154Migration tools disabled.
60003DOS protected.

Supported response format

supported-response-format page anchor

Currently we support only JSON format.

Listing export details for user with authy_id: 1


_10
curl -H "X-Authy-API-Key: <api_key>" \
_10
"https://api.authy.com/protected/json/users/1/secret/export"

Sample response


_10
{
_10
"secret": "ONSWG4TFORPXGZLFMQ======",
_10
"otp": "93212"
_10
}

Below are the usage limits for this API:

ScopeLimit
By user3 per month
By app1500 per minute

Rate this Page: