Phone Check Webhooks
The following are the webhooks for the Phone Check Tool. The webhooks have the following IDs:
phone-ownership-validation
Step Completed
"step" : {
"status" : 200,
"id" : "phone-ownership-validation",
"data" : {
"phoneNumber" : "0000000000",
"countryCode" : "MX",
"dialingCode" : 52
},
"error" : null
}
Step Error
"step" : {
"status" : 200,
"id" : "phone-ownership-validation",
"error" : {
"type" : "StepError",
"code" : "phoneOwnership.notEnoughParams",
"message" : "User has not submitted any valid phone within given time"
}
}
"step" : {
"status" : 200,
"id" : "phone-ownership-validation",
"data" : {
"phoneNumber" : "000000000",
"countryCode" : "CL",
"dialingCode" : 56
},
"error" : {
"type" : "StepError",
"code" : "phoneOwnership.unconfirmed",
"message" : "User has not submitted confirmation code for phone entered within given time"
}
}
"step" : {
"status" : 200,
"id" : "phone-ownership-validation",
"error" : {
"type" : "StepError",
"code" : "phoneOwnership.skipped",
"message" : "User skipped this step"
}
}
phone-risk-analysis-validation
phone-risk-analysis-validationStep Completed
"status" : 200,
"id" : "phone-risk-analysis-validation",
"error" : null,
"data" : {
"phoneNumber" : "0000000000",
"dialingCode" : 52,
"countryCode" : "MX",
"phoneType" : "Mobile",
"phoneTypeStatus" : "Allowed",
"riskLevel" : "very-low",
"riskInsights" : [
{
"name" : "regular activity",
"description" : "Most trustworthy category, based on past behavior.",
"impact" : "Positive",
"type" : "Category"
},
{
"name" : "no range activity",
"description" : "Very little activity, or none at all, for a risky range that this number belongs to over the past 90 days. Also returned if the number does not belong to a risky range.",
"impact" : "Positive",
"type" : "Automation to human activity"
},
{
"name" : "seen in the last 3 months",
"description" : "Activity on this number in the last three months.",
"impact" : "Neutral",
"type" : "Human to human activity"
},
{
"name" : "low number of completed calls",
"description" : "Less success than expected for this number over the past 90 days.",
"impact" : "Negative",
"type" : "Human to human activity"
},
{
"name" : "regular call duration",
"description" : "Expected call duration for this number over the past 90 days.",
"impact" : "Positive",
"type" : "Human to human activity"
},
{
"name" : "sparse long-term activity",
"description" : "Lower than expected activity on this number over a tenure greater than or equal to one week (long-term).",
"impact" : "Positive",
"type" : "Human to human activity"
},
{
"name" : "no range activity",
"description" : "Very little activity, or none at all, for a risky range that this number belongs to over the past 90 days. Also returned if the number does not belong to a risky range.",
"impact" : "Positive",
"type" : "Human to human activity"
}
],
"riskScore" : 16,
"maxPossibleRiskScore" : 100,
"recommendation" : "allow",
"timezone" : "-6",
"lineType" : "MOBILE",
"carrier" : "Radiomovil Dipsa, S.A. De C.V.",
"location" : {
"city" : "Cuauhtemoc",
"state" : null,
"zip" : null,
"metroCode" : null,
"county" : null,
"country" : "Mexico"
}
}
},
Step Error
"step" : {
"status" : 200,
"id" : "phone-risk-analysis-validation",
"error" : {
"type" : "StepError",
"code" : "input.failed",
"message" : "Cannot meet dependent input"
}
}
"step" : {
"status" : 200,
"id" : "phone-risk-analysis-validation",
"error" : {
"type" : "StepError",
"code" : "phoneRisk.highRisk",
"message" : "The phone number that the user provided appears have suspicious behavior and properties"
},
"data" : {
"phoneNumber" : "0000000000",
"dialingCode" : 57,
"countryCode" : "CO",
"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"
},
{
"name" : "high short-term range activity",
"description" : "Very significant activity for a risky range that this number belongs to over the last 24 hours.",
"impact" : "Negative",
"type" : "Automation to human activity"
},
{
"name" : "seen in the last 2 months",
"description" : "Activity on this number in the last two months.",
"impact" : "Neutral",
"type" : "Human to human activity"
},
{
"name" : "very low number of completed calls",
"description" : "Much less success than expected, or no success at all, for this number over the past 90 days.",
"impact" : "Negative",
"type" : "Human to human activity"
},
{
"name" : "irregular call duration",
"description" : "Shorter or longer than expected call duration for this number over the past 90 days.",
"impact" : "Negative",
"type" : "Human to human activity"
},
{
"name" : "sparse long-term activity",
"description" : "Lower than expected activity on this number over a tenure greater than or equal to one week (long-term).",
"impact" : "Positive",
"type" : "Human to human activity"
},
{
"name" : "no range activity",
"description" : "Very little activity, or none at all, for a risky range that this number belongs to over the past 90 days. Also returned if the number does not belong to a risky range.",
"impact" : "Positive",
"type" : "Human to human activity"
}
],
"riskScore" : 83,
"maxPossibleRiskScore" : 100,
"recommendation" : "block",
"timezone" : "-5",
"lineType" : "MOBILE",
"carrier" : "Comcel",
"location" : {
"city" : "Countrywide",
"state" : null,
"zip" : null,
"metroCode" : null,
"county" : null,
"country" : "Colombia"
}
}
},
"step" : {
"status" : 200,
"id" : "phone-risk-analysis-validation",
"error" : {
"type" : "StepError",
"code" : "phoneRisk.serviceUnavailable",
"message" : "Service unavailable"
}
}
"step" : {
"status" : 200,
"id" : "phone-risk-analysis-validation",
"error" : {
"type" : "StepError",
"code" : "phoneRisk.skipped",
"message" : "User skipped this step"
}
}
"step" : {
"status" : 200,
"id" : "phone-risk-analysis-validation",
"error" : {
"type" : "StepError",
"code" : "phoneRisk.phoneTypeStatusBlocked",
"message" : "The phone number with a blocked type"
},
"data" : {
"phoneNumber" : "0000000000",
"dialingCode" : 1,
"countryCode" : "US",
"phoneType" : "Voip",
"phoneTypeStatus" : "Blocked",
"riskLevel" : "medium",
"riskInsights" : [
{
"name" : "irregular number type",
"description" : "This number has risky static attributes (like VOIP phone type or being on a blocklist).",
"impact" : "Negative",
"type" : "Category"
},
{
"name" : "no range activity",
"description" : "Very little activity, or none at all, for a risky range that this number belongs to over the past 90 days. Also returned if the number does not belong to a risky range.",
"impact" : "Positive",
"type" : "Automation to human activity"
},
{
"name" : "no activity",
"description" : "Very little activity, or none at all, was ever observed on this number. Very short tenure. Cannot classify.",
"impact" : "Neutral",
"type" : "Human to human activity"
},
{
"name" : "VOIP number",
"description" : "This is a VOIP number.",
"impact" : "Negative",
"type" : "Number type"
},
{
"name" : "medium-risk carrier",
"description" : "This number is associated with a risky carrier.",
"impact" : "Negative",
"type" : "Number type"
}
],
"riskScore" : 50,
"maxPossibleRiskScore" : 100,
"recommendation" : "flag",
"timezone" : "-5",
"lineType" : "VOIP",
"carrier" : "Google (Grand Central) - SVR",
"location" : {
"city" : "Boynton Beach",
"state" : "FL",
"zip" : "33435",
"metroCode" : "8960",
"county" : "Palm Beach",
"country" : "United States"
}
}
},
Updated 5 months ago