{
"data": {
"carrier": "",
"reason": "Invalid phone number structure.",
"isValid": false,
"blacklisted": false,
"disposable": false,
"phone": "+12121234567",
"countryCode": "US",
"custom_rules_applied": {
"total": 0,
"rules": []
}
},
"status": "success",
"executionTime": 1
}
Phone Number Scoring
curl --request GET \
--url https://greipapi.com/scoring/phone \
--header 'Authorization: Bearer <token>'{
"data": {
"carrier": "",
"reason": "Invalid phone number structure.",
"isValid": false,
"blacklisted": false,
"disposable": false,
"phone": "+12121234567",
"countryCode": "US",
"custom_rules_applied": {
"total": 0,
"rules": []
}
},
"status": "success",
"executionTime": 1
}
Risk Scoring
Phone Number Scoring
This method serves as an additional layer of protection in your system for validating phone numbers. It not only checks the syntax but also assesses the likelihood of the phone number being valid and operational.
By incorporating this scoring into your workflow, you can enhance fraud detection, reduce invalid inputs, and improve the overall quality of data captured.
{
"data": {
"carrier": "",
"reason": "Invalid phone number structure.",
"isValid": false,
"blacklisted": false,
"disposable": false,
"phone": "+12121234567",
"countryCode": "US",
"custom_rules_applied": {
"total": 0,
"rules": []
}
},
"status": "success",
"executionTime": 1
}
GET
/
scoring
/
phone
Phone Number Scoring
curl --request GET \
--url https://greipapi.com/scoring/phone \
--header 'Authorization: Bearer <token>'{
"data": {
"carrier": "",
"reason": "Invalid phone number structure.",
"isValid": false,
"blacklisted": false,
"disposable": false,
"phone": "+12121234567",
"countryCode": "US",
"custom_rules_applied": {
"total": 0,
"rules": []
}
},
"status": "success",
"executionTime": 1
}
Documentation Index
Fetch the complete documentation index at: https://docs.greip.io/llms.txt
Use this file to discover all available pages before exploring further.
Query Parameters
The phone command is used to specify the phone number you want to validate.Expected values: a phone numberSample value:
+12121234567, 0012121234567, 12121234567, or 2121234567The
ISO 3166-1 alpha-2 format of the country code of the phone number. Learn moreSample value: USThe format command is used to get a response in a specific format.Expected values:
JSON, XML, CSV, or NewlineFor more information please refer to Response Format.The mode command is used to in the development stage to simulate the integration process before releasing it to the production environment.Expected values:
live, or test.For more information please refer to Development Environment.The userID command can be used to identify requests sent by specific users to monitor in the Events Page.Expected values: email address, phone number, user id, name, etc.For more information please refer to User Identifier.
The callback command can help you make the response as a JSONP format.Expected values: any name that can be used as a function name in Javascript, e.g:
myFunctionName.For more information please refer to JSONP Callback.Response properties
Hide properties
Hide properties
Carrier name of the phone number.
The reason behind considering this phone number as risky.Note: The value of this property will be empty if the
isValid is true.A boolean value that you can rely on to determine if the phone number is 100% safe & valid or not.
Indicates if the phone number is blacklisted due to applying custom
rules or were found in one of your
blacklists.
A boolean value that indicates if the phone number is a disposable phone number or not.
The phone number you sent in the request.
The country code you sent in the request.
The custom rules applied to this request, learn
more.
Hide properties
Hide properties
The total number of custom rules applied to this request.
The custom rules applied to this request, learn
more.
The response status.Expected values:
success, or error.Time spent in milliseconds to process the data.
What can I expect from this API?
- Detection of disposable phone numbers (also known as Temporary Phone Numbers) or numbers associated with VoIP services
- Validation of phone number syntax
Was this page helpful?
⌘I