Skip to main content
[GET]
{{baseUrl}}/api/v1/fraud/phone
HeaderTypeDescription
AppIdstringCreate an app to get your app ID on dashboard here
AuthorizationstringPrivate/secret key. Use <key> not Bearer <key>

Query parameter

ParameterTypeDescriptionRequired
phonestringphone number of userrequired

Sample response

Response
{
    "entity": {
        "phone": "2348101234567",
        "valid": true,
        "information": {
            "type": "Wireless",
            "carrier": "MTN Nigeria",
            "country": "NG",
            "city": "N/A",
            "zipcode": "N/A",
            "region": "Nigeria",
            "dialing_code": 234,
            "mnc": "12",
            "mcc": "123",
            "time_zone": "Africa/Lagos"
        },
        "format": {
            "formatted": "+2348101234567",
            "local": "0810 123 4567"
        },
        "risk_score": 0,
        "leaked": false,
        "spammer": false,
        "disposable": false,
        "suspicious": false,
        "recent_abuse": false,
        "active": true,
        "active_status": "N/A"
    }
}

Response Fields

FieldTypeDescription
entityobjectContains the phone number risk profile data
entity.phonestringThe phone number that was screened
entity.validbooleantrue if the phone number is valid and properly formatted
entity.informationobjectCarrier and geographic details for the phone number
entity.information.typestringLine type (e.g., β€œWireless”, β€œLandline”, β€œVoIP”)
entity.information.carrierstringName of the telecom carrier
entity.information.countrystringISO country code where the number is registered
entity.information.citystringCity associated with the number, or β€œN/A” if unavailable
entity.information.zipcodestringZIP or postal code associated with the number, or β€œN/A” if unavailable
entity.information.regionstringRegion or country name associated with the number
entity.information.dialing_codeintegerInternational dialing code for the country
entity.information.mncstringMobile Network Code identifying the carrier
entity.information.mccstringMobile Country Code identifying the country
entity.information.time_zonestringTime zone of the phone number’s registered location
entity.formatobjectFormatted representations of the phone number
entity.format.formattedstringInternationally formatted phone number with country code
entity.format.localstringLocally formatted phone number
entity.risk_scoreintegerFraud risk score from 0 (no risk) to 100 (highest risk)
entity.leakedbooleantrue if the phone number has appeared in known data leaks
entity.spammerbooleantrue if the phone number has been reported as a spam source
entity.disposablebooleantrue if the number is from a disposable or virtual phone service
entity.suspiciousbooleantrue if the number is flagged as suspicious based on combined risk signals
entity.recent_abusebooleantrue if the number has been associated with recent abusive activity
entity.activebooleantrue if the phone number is currently active on the network
entity.active_statusstringDetailed active status description, or β€œN/A” if unavailable