For new development, we encourage you to use the Verify API instead of the Authy API. The Verify API is an evolution of the Authy API with continued support for SMS, voice, and email one-time passcodes, an improved developer experience, and new features including:
- Access via the Twilio CLI.
- Improved visibility and insights.
- A push authentication SDK embeddable in your own application.
This API is only available for customers who intend to migrate Authy users from the Authy API to the Verify API.
By default, customers do not have access to this API endpoint. To request access, please contact support team.
We need to pass
X-Authy-API-Key header for protected endpoints.
||Integer||Unique identifier of the user.|
||String||Phone number of the user without country code.|
||String||International calling prefix.|
||String||Full phone number in E164 format.|
||DateTime||Last update of the user in ISO-8601 format.|
Listing phone number detail for user with
curl -H "X-Authy-API-Key: <api_key>" \ "https://api.authy.com/protected/json/users/1/phone_number"
The following are the status codes supported by this API.
200: Request was successful.
400: When the request was invalid.
404: When the resource was not found.
500: Internal server error.
The following are the some of error codes supported by this API.
60026: User not found.
60154: Phone number export disabled.
60003: DoS protected.
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.
Presently we support only
Below are usage limits for this API
3 per month
1500 per minute