v1

latestOpenAPI 3.1.02026-07-24450175.9 KB

Phone Risk

Use this API to assess a user's behavioral risk through their phone number

post/phone/risk

Request body

recipientstring required

User's phone number. Enter the phone number as a numerical string with no delimiters, such as ".", "(", ")", or "-".

callbackUrlstring required

Callback URL to receive the risk assessment score.

metadatastring json

Metadata to be sent to a webhook (callbackUrl)

Response

200

{"stackTrail":"paths:/phone/risk:post:responses:200:content:application/json:schema:properties:error","oasType":"schema","type":"unknown"}

Example response

{
  "data": {
    "phoneNumber": "00000000000",
    "countryCode": "7",
    "phoneType": "Mobile",
    "phoneTypeStatus": "Allowed",
    "riskLevel": "very-high",
    "riskInsights": [
      {
        "name": "high-risk irregular activity",
        "description": "Highest-risk category, based on past behavior.",
        "impact": "Negative",
        "type": "Category"
      }
    ],
    "riskScore": 80,
    "maxPossibleRiskScore": 100,
    "recommendation": "block",
    "timezone": "+2",
    "lineType": "MOBILE",
    "carrier": "Vimpel Communications",
    "location": {
      "city": "Moscow",
      "country": "Russia"
    }
  },
  "metadata": {
    "user_defined": "id00000"
  }
}