Skip to main content
POST
/
phone-service
/
phoneRiskScore
Phone Risk Score
curl --request POST \
  --url https://api-umbrella.io/api/services/phone-service/phoneRiskScore \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "+436501234567",
  "accountLifecycleEvent": "create",
  "externalId": "1234567890",
  "originatingIp": "192.168.1.1",
  "deviceId": "1234567890",
  "accountId": "1234567890",
  "emailAddress": "test@example.com"
}
'
{
  "status": true,
  "data": {
    "referenceId": "3661FDC7EAA8111C93048FA6FB8C300C",
    "externalId": null,
    "status": {
      "updatedOn": "2025-08-06T12:53:53.082687Z",
      "code": 300,
      "description": "Transaction successfully completed"
    },
    "numbering": {
      "original": {
        "completePhoneNumber": "+436501234567",
        "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": [
        22001,
        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
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://umbrella-docs.info/llms.txt

Use this file to discover all available pages before exploring further.

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

​
Endpoint

POST /phone-service/phoneRiskScore

​
Swagger

Authorizations

​
Authorization
string
header
required

Bearer token obtained from POST /auth. Valid for 60 minutes.

Body

application/json
​
phoneNumber
string
required

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

Example:

"+436501234567"

​
accountLifecycleEvent
enum<string>
required

The action being evaluated.

Available options:
create,
sign-in,
transact,
update,
delete
Example:

"create"

​
externalId
string

Customer-generated ID echoed in the response.

Example:

"1234567890"

​
originatingIp
string

End user's IP address (IPv4 or IPv6). Do not send your server IP.

Example:

"192.168.1.1"

​
deviceId
string

Case-sensitive device ID.

Example:

"1234567890"

​
accountId
string

Case-sensitive account ID.

Example:

"1234567890"

​
emailAddress
string

Case-sensitive email address.

Example:

"test@example.com"

Response

Successfully retrieved phone risk score.

​
status
boolean
required

Indicates if the API request was successful.

​
data
object
required