POST
/
phoneid
curl --request POST \
  --url https://api-umbrella.io/api/services/phoneid \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "phone": "+436504142107"
}'
{
  "reference_id": "36475B3EB1DC0C2492E2889F4EACF2CC",
  "sub_resource": "live",
  "status": {
    "code": 300,
    "description": "Transaction successfully completed",
    "updatedOn": "2024/09/09T12:43:42.701105Z"
  },
  "errors": [
    "<string>"
  ],
  "phoneType": {
    "code": "2",
    "description": "MOBILE"
  },
  "blocklisting": {
    "blocked": false,
    "blockCode": 0,
    "blockDescription": "Not blocked"
  },
  "numbering": {
    "cleansing": {
      "call": {
        "countryCode": "43",
        "phoneNumber": "6504142107",
        "cleansedCode": 100,
        "minLength": 7,
        "maxLength": 13
      },
      "sms": {
        "countryCode": "43",
        "phoneNumber": "6504142107",
        "cleansedCode": 100,
        "minLength": 7,
        "maxLength": 13
      }
    },
    "original": {
      "completePhoneNumber": "+436504142107",
      "countryCode": "43",
      "phoneNumber": "6504142107"
    }
  },
  "location": {
    "city": "Countrywide",
    "state": "<string>",
    "zip": "<string>",
    "metroCode": "<string>",
    "county": "<string>",
    "country": {
      "name": "Austria",
      "iso2": "AT",
      "iso3": "AUT"
    },
    "coordinates": {
      "latitude": "<string>",
      "longitude": "<string>"
    },
    "timeZone": {
      "name": "<string>",
      "utcOffsetMax": "+1",
      "utcOffsetMin": "+1"
    }
  },
  "carrier": {
    "name": "Mass Response Service GmbH"
  },
  "live": {
    "subscriberStatus": "ACTIVE",
    "deviceStatus": "REACHABLE",
    "roaming": "UNAVAILABLE",
    "roamingCountry": "<string>",
    "roamingCountryIso2": "<string>"
  }
}

For a usage description of the Phone Status Service, please refer to the Phone Status page.

​
Endpoint

POST /phoneid

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
phone
string
required

The phone number to check, including country code.

Example:

"+436504142107"

Response

200
application/json
Successfully retrieved phone status.
​
reference_id
string

Unique reference ID for the transaction.

Example:

"36475B3EB1DC0C2492E2889F4EACF2CC"

​
sub_resource
string

Sub-resource type (e.g., 'live').

Example:

"live"

​
status
object
​
errors
string[]

List of errors, if any.

​
phoneType
object
​
blocklisting
object
​
numbering
object
​
location
object
​
carrier
object
​
live
object