This documentation is designed for CTOs and technical teams to implement our SMS verification API. Integration takes just 1 day with only 4 simple endpoints.
To integrate with our SMS verification service, you'll need to implement 4 simple API endpoints. The entire process typically takes just 1 day to complete.
Our API follows RESTful principles and returns responses in JSON format. All API requests require authentication using your API key, which will be provided upon partnership approval.
https://api.yourservice.comAll API requests require an api_key parameter. This key should be included in the query string for GET requests and in the request body for POST requests.
GET https://api.yourservice.com/getNumbers?api_key=YOUR_API_KEYReturns available numbers, countries, and quantities, with optional country filtering.
https://api.yourservice.com/getNumbers| Name | Type | Required | Description |
|---|---|---|---|
| api_key | string | Yes | Your API key for authentication |
| country | string | No | Optional ISO country code to filter results (e.g., US, GB, DE) |
{
"status": "success",
"numbers": [
{
"country": "US",
"country_name": "United States",
"available": 5000,
"price_per_sms": 0.05
},
{
"country": "GB",
"country_name": "United Kingdom",
"available": 3200,
"price_per_sms": 0.06
}
]
}// Implementation note // Use this endpoint to retrieve available numbers // You can optionally filter by country code
Rents a phone number from your service for SMS verification.
https://api.yourservice.com/rentNumber| Name | Type | Required | Description |
|---|---|---|---|
| api_key | string | Yes | Your API key for authentication |
| country | string | Yes | ISO country code (e.g., US, GB, DE) |
| service | string | No | Optional service identifier for specific platforms |
{
"status": "success",
"number": "+14155552671",
"rental_id": "rent_12345",
"expires_at": "2023-06-15T15:30:45Z",
"country": "US"
}// Implementation note // Use this endpoint to rent a number for SMS verification // Remember to store the rental_id for retrieving SMS messages
Retrieves SMS messages received on a rented number.
https://api.yourservice.com/getSMS| Name | Type | Required | Description |
|---|---|---|---|
| api_key | string | Yes | Your API key for authentication |
| rental_id | string | Yes | The rental ID returned from rentNumber |
{
"status": "success",
"messages": [
{
"sender": "Facebook",
"text": "Your verification code is: 123456",
"received_at": "2023-06-15T15:25:30Z"
}
],
"number": "+14155552671"
}// Implementation note // Use this endpoint to retrieve SMS messages for a rented number // You may need to poll this endpoint until a message is received
Cancels a previously rented phone number and stops any further charges.
https://api.yourservice.com/cancelNumber| Name | Type | Required | Description |
|---|---|---|---|
| api_key | string | Yes | Your API key for authentication |
| rental_id | string | Yes | The rental ID of the number to cancel |
{
"status": "success",
"message": "Number rental cancelled successfully",
"rental_id": "rent_12345",
"refund_amount": 0.00
}// Implementation note // Use this endpoint to cancel a number rental when you no longer need it // This can help prevent unnecessary charges for unused numbers
Our technical team is available to assist with your integration. We can help you implement these endpoints and ensure a smooth integration process in just 1 day.