> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dojah.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Phone Number Screening for Fraud

> Screen phone numbers for risk. Check carrier, country, and fraud signals before you onboard or approve high-value actions.

```http [GET] theme={null}
{{baseUrl}}/api/v1/fraud/phone
```

### Header

| Header        | Type   | Description                                                                                         |
| ------------- | ------ | --------------------------------------------------------------------------------------------------- |
| AppId         | string | Create an app to get your app ID on dashboard [here](https://app.dojah.io/developers/configuration) |
| Authorization | string | Private/secret key. Use `<key>` not `Bearer <key>`                                                  |

### Query parameter

| Parameter | Type   | Description          | Required |
| --------- | ------ | -------------------- | -------- |
| phone     | string | phone number of user | required |

### Sample response

```json Response theme={null}
{
    "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

| Field                            | Type    | Description                                                                  |
| -------------------------------- | ------- | ---------------------------------------------------------------------------- |
| entity                           | object  | Contains the phone number risk profile data                                  |
| entity.phone                     | string  | The phone number that was screened                                           |
| entity.valid                     | boolean | `true` if the phone number is valid and properly formatted                   |
| entity.information               | object  | Carrier and geographic details for the phone number                          |
| entity.information.type          | string  | Line type (e.g., "Wireless", "Landline", "VoIP")                             |
| entity.information.carrier       | string  | Name of the telecom carrier                                                  |
| entity.information.country       | string  | ISO country code where the number is registered                              |
| entity.information.city          | string  | City associated with the number, or "N/A" if unavailable                     |
| entity.information.zipcode       | string  | ZIP or postal code associated with the number, or "N/A" if unavailable       |
| entity.information.region        | string  | Region or country name associated with the number                            |
| entity.information.dialing\_code | integer | International dialing code for the country                                   |
| entity.information.mnc           | string  | Mobile Network Code identifying the carrier                                  |
| entity.information.mcc           | string  | Mobile Country Code identifying the country                                  |
| entity.information.time\_zone    | string  | Time zone of the phone number's registered location                          |
| entity.format                    | object  | Formatted representations of the phone number                                |
| entity.format.formatted          | string  | Internationally formatted phone number with country code                     |
| entity.format.local              | string  | Locally formatted phone number                                               |
| entity.risk\_score               | integer | Fraud risk score from 0 (no risk) to 100 (highest risk)                      |
| entity.leaked                    | boolean | `true` if the phone number has appeared in known data leaks                  |
| entity.spammer                   | boolean | `true` if the phone number has been reported as a spam source                |
| entity.disposable                | boolean | `true` if the number is from a disposable or virtual phone service           |
| entity.suspicious                | boolean | `true` if the number is flagged as suspicious based on combined risk signals |
| entity.recent\_abuse             | boolean | `true` if the number has been associated with recent abusive activity        |
| entity.active                    | boolean | `true` if the phone number is currently active on the network                |
| entity.active\_status            | string  | Detailed active status description, or "N/A" if unavailable                  |