v1

latestOpenAPI 3.0.02026-07-24231140.6 KB

Misc

Searches for providers for the specified phone number

get/check_phone_number

Query parameters

phone_numberstring required

The phone number to be checked.

operatorstring

Example:verizon

The phone's operator in case it's known.

Response

Success. There's some situations where we can't figure out the operator of the phone number so we return a list of possible ones instead of a single match.

operator_foundboolean

This can be used to know if the 'data' field is going to be an object or a list of objects.

messagestring

Example response

{
  "meta": {
    "operator": "verizon",
    "_endpoint": "/check_phone_number"
  },
  "data": {
    "id": "test-gift-card-link",
    "name": "Test Gift Card Link",
    "country_code": "KN",
    "country_name": "St Kitts and Nevis",
    "currency": "USD",
    "created_time": "2021-10-04T17:02:22.768Z",
    "recipient_type": "none",
    "image": "https://res.cloudinary.com/bitrefill/d_operator.png/this_is_a_test",
    "in_stock": true,
    "packages": {
      "id": "test-gift-card-link<&>10",
      "price": 12
    },
    "range": {
      "min": 10,
      "max": 100,
      "step": 10,
      "price_rate": 1.2
    }
  },
  "operator_found": true
}