The NumberRisk Assessments API is a RESTful-compliant which may be accessed via HTTPS using an API Key. You may obtain your API Key from your web portal or from your NumberRisk sales representative. All results are returned as JSON. Charges apply to use this API.
Below, please find the endpoints and examples:
Caller ID Assessment:
Endpoint:
Method:
GET
Parameters:
TelephoneNumber: Any correctly formatted telephone number.
Example: 3155564800, 13155564800, +13155564800
Optional Parameters:
Carrier: true or 1
Checks the telephone number against our Carrier API.
Crowdsource: true or 1
Checks the telephone number against several Crowdsourcing APIs.
By default, if no Optional Parameters are specified, we will check the Carrier API.
Headers:
x-api-key: Your API key.
Sample Request: : https://api.numberrisk.com/Assessments/result?TelephoneNumber=3155564800
With Optional Parameters (Crowdsource):
With both Optional Parameters:
Response:
{
"RequestGuid":"90fc3aba-6fb1-4364-a917-5f69d9de1e44",
"AccountGuid":"98e942d7-fb1a-4885-84bb-71df714c2580",
"PhoneNumber":"13155564800",
"E164FormattedNumber":"+13155564800",
"CountryCode":"US",
"IsSpam":false,
"IsFraud":false,
"CarrierAPI":true,
"CrowdsourcingAPI":false,
"Result_CarrierAPI":false,
"Result_CrowdsourcingAPI":false,
"RequestingIP":"54.86.50.139",
"RequestedAt":"2022-05-10T20:29:42.3244789Z",
"CompletedAt":"2022-05-10T20:29:42.3670615Z",
"TransactionType":"A",
"ReturnStatus":"Completed",
"ReturnCode":200
}
What do the response values mean?
RequestGuid: a unique identifier assigned to this request.
PhoneNumber: The original phone number sent in the GET request.
E164FormattedNumber: The original phone number formatted to the E164 standard.
CountryCode: The country where the original phone number is from.
IsSpam: Is this number flagged as Spam? Response will be either true or false.
IsFraud: Is this number flagged as fraud? Response will be either true or false
CarrierAPI: Was a request made to the Carrier API.
Result_CarrierAPI: If a request was made to the Carrier API - is the number flagged.
CrowdsourcingAPI: Was a request made to the Crowdsourcing API.
Result_CrowdsourcingAPI: If a request was made to the Carrier API - is the number flagged.
ReturnCode:
200: Successful
404: ReturnStatus will contain the reason.
503: ReturnStatus will contain the reason.