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.

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

Export TOTP secret seed of a user

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.

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

Parameters

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

Name	Type	Description
`authy_id`	Integer	Unique identifier of the user.

Response

Name	Type	Description
`secret`	String	Secret seed of the user.
`otp`	String	Valid OTP to verify Factor once it's created.

Status Codes

The following are the status codes supported by this API.

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

Error codes

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.

Code	Description
`60026`	User not found.
`60154`	Migration tools disabled.
`60003`	DOS protected.

Supported response format

Currently we support only JSON format.

Example

Listing export details for user with authy_id: 1

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

Sample response

1{
2  "secret": "ONSWG4TFORPXGZLFMQ======",
3  "otp": "93212"
4}

Rate limits

Below are the usage limits for this API:

Scope	Limit
`By user`	3 per month
`By app`	1500 per minute