Full Phone Intelligence Service

Full Phone Intelligence Service API Documentation

POST /phone-service/fullPhoneIntelligence

Try it

Full Phone Intelligence

cURL

curl --request POST \
  --url https://sandbox-umbrella-api.azurewebsites.net/api/services/phone-service/fullPhoneIntelligence \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phoneNumber": "[phone]"
}
'

200

{
  "status": true,
  "data": {
    "referenceId": "3661FDC54750091C93078058241C3036",
    "externalId": null,
    "status": {
      "updatedOn": "2025-08-06T12:53:09.929413Z",
      "code": 300,
      "description": "Transaction successfully completed"
    },
    "numbering": {
      "original": {
        "completePhoneNumber": "[phone]",
        "countryCode": "43",
        "phoneNumber": "6501234567"
      },
      "cleansing": {
        "call": {
          "countryCode": "43",
          "phoneNumber": "6501234567",
          "cleansedCode": 100,
          "minLength": 7,
          "maxLength": 13
        },
        "sms": {
          "countryCode": "43",
          "phoneNumber": "6501234567",
          "cleansedCode": 100,
          "minLength": 7,
          "maxLength": 13
        }
      }
    },
    "riskInsights": {
      "status": 800,
      "category": [
        10010
      ],
      "a2P": [
        22007,
        20011,
        20101
      ],
      "p2P": [
        30201
      ],
      "numberType": [],
      "ip": [],
      "email": []
    },
    "phoneType": {
      "code": "2",
      "description": "MOBILE"
    },
    "location": {
      "city": "Countrywide",
      "state": null,
      "zip": null,
      "metroCode": null,
      "county": null,
      "country": {
        "name": "Austria",
        "iso2": "AT",
        "iso3": "AUT"
      },
      "coordinates": {
        "latitude": null,
        "longitude": null
      },
      "timeZone": {
        "name": null,
        "utcOffsetMin": "+1",
        "utcOffsetMax": "+1"
      }
    },
    "carrier": {
      "name": "T-Mobile Austria GmbH"
    },
    "blocklisting": {
      "blocked": false,
      "blockCode": 0,
      "blockDescription": "Not blocked"
    },
    "risk": {
      "level": "medium-low",
      "recommendation": "allow",
      "score": 301
    }
  }
}

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

Endpoint

POST /phone-service/fullPhoneIntelligence

Swagger

⬇️ Download OpenAPI YAML

Authorizations

Authorization · string · header · required

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

Body

application/json

phoneNumber · string · required

Phone number to check, including country code (E.164).

Example:

"[phone]"

Response

200

application/json

Successfully retrieved full phone intelligence.

status · boolean · required

Indicates if the API request was successful.

data · object · required

Show child attributes

data. referenceId · string

Unique reference ID for the transaction.

data. externalId · string | null

External reference ID (nullable).

data. status · object

Show child attributes

data.status. updatedOn · string

Timestamp of the last update (ISO 8601 format).

data.status. code · number

Status code (e.g., 300 for success).

data.status. description · string

Status description message.

data. numbering · object

Show child attributes

data.numbering. original · object

Show child attributes

data.numbering.original. completePhoneNumber · string

data.numbering.original. countryCode · string

data.numbering.original. phoneNumber · string

data.numbering. cleansing · object

Show child attributes

data.numbering.cleansing. call · object

Show child attributes

data.numbering.cleansing.call. countryCode · string

data.numbering.cleansing.call. phoneNumber · string

data.numbering.cleansing.call. cleansedCode · number

data.numbering.cleansing.call. minLength · number

data.numbering.cleansing.call. maxLength · number

data.numbering.cleansing. sms · object

Show child attributes

data.numbering.cleansing.sms. countryCode · string

data.numbering.cleansing.sms. phoneNumber · string

data.numbering.cleansing.sms. cleansedCode · number

data.numbering.cleansing.sms. minLength · number

data.numbering.cleansing.sms. maxLength · number

data. riskInsights · object

Risk assessment details.

Show child attributes

data.riskInsights. status · number

data.riskInsights. category · number[]

data.riskInsights. a2P · number[]

data.riskInsights. p2P · number[]

data.riskInsights. numberType · number[]

data.riskInsights. ip · number[]

data.riskInsights. email · number[]

data. phoneType · object

Show child attributes

data.phoneType. code · string

data.phoneType. description · string

data. location · object

Show child attributes

data.location. city · string | null

data.location. state · string | null

data.location. zip · string | null

data.location. metroCode · string | null

data.location. county · string | null

data.location. country · object

Show child attributes

data.location.country. name · string

data.location.country. iso2 · string

data.location.country. iso3 · string

data.location. coordinates · object

Show child attributes

data.location.coordinates. latitude · number | null

data.location.coordinates. longitude · number | null

data.location. timeZone · object

Show child attributes

data.location.timeZone. name · string | null

data.location.timeZone. utcOffsetMin · string

data.location.timeZone. utcOffsetMax · string

data. carrier · object

Show child attributes

data.carrier. name · string

data. blocklisting · object

Show child attributes

data.blocklisting. blocked · boolean

data.blocklisting. blockCode · number

data.blocklisting. blockDescription · string

data. risk · object

Overall risk score and recommendation.

Show child attributes

data.risk. level · string

Example:

"medium-low"

data.risk. recommendation · string

Example:

"allow"

data.risk. score · number

Example:

301