Skip to main content

Filtering responses

You can use the fields property in the API request to specify the properties you want returned in the result.

This is optional, by default all available fields are returned.

Provide a list of field names. One of more of:

  • id
  • url
  • external_id
  • outcome
  • rules
  • device
  • address
  • email
  • ip
  • phone
info

If you request a field that isn't present in the result, it will be ignored.

Example​

Requesting only the score and email properties in the result:

{
    "probe_id": "ctwCYFyAUteNpsBgAw7xYL",
    "email": "[email protected]",
    "name": "Dan Gerous",
    "phone": "+12126647665",
    "ip": "204.158.96.40",
    "fields": [
        "id",
        "email"
    ],
    "secret_key": "3748eaee-7408-4fee-9e42-4d5d94e5f2e9"
}

Returns the response:

{
    "id": "d4bhu2b1hGOpMn1a76SXl",
    "email": {
        "success": true,
        "valid": true,
        "email": "[email protected]",
        "local_part": "dan",
        "normalized_email": "[email protected]",
        "normalized_local_part": "dan",
        "domain": "example.com",
        "domain_tld": "com",
        "domain_tld_high_risk": false,
        "digits_count": 0,
        "name_match": true,
        "free": true,
        "disposable": false,
        "business": false,
        "breaches_count": 8,
        "breaches_list": [
            "CafePress",
            "PDL",
            "Lastfm",
            ...
        ],
        "seen_hour": 1,
        "seen_day": 1,
        "seen_month": 1,
        "seen_quarter": 1,
        "unique_devices": 1
    }
}