Skip to content

Commit 78e0011

Browse files
authored
Merge pull request #1487 from maxmind/greg/eng-3453-dev-site-document-email-domain-outputs
Document new email domain outputs for minFraud
2 parents 6121059 + cd6b3af commit 78e0011

File tree

1 file changed

+129
-6
lines changed

1 file changed

+129
-6
lines changed

content/minfraud/api-documentation/responses.md

Lines changed: 129 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -833,7 +833,15 @@ associated with the IP address passed in the request.
833833
```json
834834
{
835835
"domain": {
836-
"first_seen": "2015-01-20"
836+
"classification": "business",
837+
"first_seen": "2015-01-20",
838+
"risk": 1.23,
839+
"visit": {
840+
"has_redirect": true,
841+
"last_visited_on": "2025-11-15",
842+
"status": "live"
843+
},
844+
"volume": 6.5
837845
},
838846
"first_seen": "2016-02-03",
839847
"is_disposable": false,
@@ -853,7 +861,7 @@ associated with the IP address passed in the request.
853861
{{< minfraud-schema-row key="first_seen" type="response" valueType="string" valueTypeNote="format: YYYY-MM-DD, max length: 10" insights="true" factors="true" >}}
854862
A date string (e.g. 2017-04-24) to identify the date an email address was first seen by MaxMind. This is expressed using the ISO 8601 date format YYYY-MM-DD. The earliest date that may be returned is January 1, 2008.
855863

856-
[Learn how to use email first seen data for risk analysis on our Knowledge Base.](https://support.maxmind.com/knowledge-base/articles/minfraud-email-risk-data#first-seen)
864+
[Learn how to use email first seen data for risk analysis on our Knowledge Base.](https://support.maxmind.com/knowledge-base/articles/minfraud-email-risk-data#email-first-seen)
857865
{{</minfraud-schema-row>}}
858866

859867
{{< minfraud-schema-row key="is_disposable" type="response" valueType="boolean" insights="true" factors="true" >}}
@@ -882,18 +890,117 @@ associated with the IP address passed in the request.
882890
This is a sub-object of `email` that contains information related to the domain.
883891
```json
884892
{
885-
"first_seen": "2015-01-20"
893+
"classification": "business",
894+
"first_seen": "2015-01-20",
895+
"risk": 1.23,
896+
"visit": {
897+
"has_redirect": true,
898+
"last_visited_on": "2025-11-15",
899+
"status": "live"
900+
},
901+
"volume": 6.5
886902
}
887903
```
888904

889905
<!-- prettier-ignore-start -->
890906

891907
{{< schema-table key="email--domain" >}}
892908

909+
{{< minfraud-schema-row key="classification" type="response" valueType="string" insights="true" factors="true" >}}
910+
A classification of the domain. One of the following values. Additional values may be added in the future.
911+
912+
* `business`
913+
* `education`
914+
* `government`
915+
* `isp_email`
916+
917+
[Learn more about the domain classification on our Knowledge Base.](https://support.maxmind.com/knowledge-base/minfraud-domain-risk-data#domain-classification)
918+
{{</minfraud-schema-row>}}
919+
893920
{{< minfraud-schema-row key="first_seen" type="response" valueType="string" valueTypeNote="format: YYYY-MM-DD, max length: 10" insights="true" factors="true" >}}
894921
A date string (e.g. 2019-01-01) to identify the date an email address domain was first seen by MaxMind. This is expressed using the ISO 8601 date format `YYYY-MM-DD`. The earliest date that may be returned is January 1, 2019.
895922

896-
[Learn how to use email first seen data for risk analysis on our Knowledge Base.](https://support.maxmind.com/knowledge-base/articles/minfraud-email-risk-data#first-seen)
923+
[Learn how to use email first seen data for risk analysis on our Knowledge Base.](https://support.maxmind.com/knowledge-base/articles/minfraud-email-risk-data#email-first-seen)
924+
{{</minfraud-schema-row>}}
925+
926+
{{< minfraud-schema-row key="risk" type="response" valueType="decimal" valueTypeNote="min: 0.01, max: 99" insights="true" factors="true" >}}
927+
This field contains the risk associated with the domain. The value ranges from 0.01 to 99. A higher score indicates higher risk.
928+
929+
[Learn more about the email domain risk score on our Knowledge Base.](https://support.maxmind.com/knowledge-base/minfraud-domain-risk-data#domain-reputation-score)
930+
{{</minfraud-schema-row>}}
931+
932+
{{< minfraud-schema-row key="visit" type="response" valueType="object" insights="true" factors="true" >}}
933+
An object containing information about an automated visit to the email domain. See the [Email > Domain > Visit](#email--domain--visit) section for details about this object.
934+
{{</minfraud-schema-row>}}
935+
936+
{{< minfraud-schema-row key="volume" type="response" valueType="decimal" valueTypeNote="min: 0.001, max: 1000000" insights="true" factors="true" >}}
937+
This field indicates how much activity we see on an email domain across the minFraud network, expressed in sightings per million.
938+
939+
The value is rounded to 2 significant figures. Example domain sightings per million requests:
940+
941+
* Consumer email domains: gmail.com (630,000), icloud.com (37,000)
942+
* Business domains: microsoft.com (6)
943+
944+
Note: These are point-in-time examples to provide a relative sense of the values. They will change based on email usage patterns.
945+
946+
[Learn more about email domain volume on our Knowledge Base.](https://support.maxmind.com/knowledge-base/minfraud-domain-risk-data#domain-volume)
947+
{{</minfraud-schema-row>}}
948+
949+
{{</ schema-table >}}
950+
951+
<!-- prettier-ignore-end -->
952+
953+
### Email > Domain > Visit
954+
955+
{{< anchor-target schema--response--email--domain--visit >}}
956+
957+
This is a sub-object of `email/domain` that contains information about an
958+
automated visit to the email domain.
959+
960+
Domain visits are performed by an automated agent, so for newly-sighted domains
961+
on the minFraud network, it can take a few minutes for these outputs to be
962+
populated on later requests on the same domain. Domain visits are also limited
963+
to those with low volume on the network. High volume domains such as those for
964+
email providers and large businesses will not have domain visit outputs in the
965+
minFraud response.
966+
967+
```json
968+
{
969+
"has_redirect": true,
970+
"last_visited_on": "2025-11-15",
971+
"status": "live"
972+
}
973+
```
974+
975+
<!-- prettier-ignore-start -->
976+
977+
{{< schema-table key="email--domain--visit" >}}
978+
979+
{{< minfraud-schema-row key="has_redirect" type="response" valueType="boolean" insights="true" factors="true" >}}
980+
This is `true` if the domain in the request has redirects (configured to automatically send visitors to another URL). Otherwise, the key is not included in the `/email/domain/visit` object.
981+
982+
If `true`, the `/email/domain/visit/status` field corresponds to the last domain visited after redirecting.
983+
984+
[Learn more about the email domain visit redirect flag on our Knowledge Base.](https://support.maxmind.com/knowledge-base/minfraud-domain-risk-data#domain-visit)
985+
{{</minfraud-schema-row>}}
986+
987+
{{< minfraud-schema-row key="last_visited_on" type="response" valueType="string" valueTypeNote="format: YYYY-MM-DD" insights="true" factors="true" >}}
988+
A date string that corresponds to when the automated visit was completed. This is expressed using the ISO 8601 date format `YYYY-MM-DD`.
989+
990+
Pair with the `/email/domain/visit/status` and `/email/domain/visit/has_redirect` fields to determine the recency of those values.
991+
{{</minfraud-schema-row>}}
992+
993+
{{< minfraud-schema-row key="status" type="response" valueType="string" insights="true" factors="true" >}}
994+
A classification of the status of the domain (or the last domain visited after following redirects, if these are present and can be followed) based on an automated visit at a previous point in time. This field may be initially unavailable for a newly sighted domain and populated at a future time after a visit is conducted. Pair with the `/email/domain/visit/last_visited_on` to determine the recency of the visit. One of the following values. Additional values may be added in the future.
995+
996+
* `live` - the domain is reachable and serving content normally
997+
* `dns_error` - the domain is missing, expired, or DNS is misconfigured
998+
* `network_error` - the domain is offline, blocked, or unreachable
999+
* `http_error` - the domain is reachable but the web application had a problem or denied the request
1000+
* `parked` - the domain is reachable and is in a parked state
1001+
* `pre_development` - the domain is reachable and is in a pre-development state
1002+
1003+
[Learn more about the email domain visit status on our Knowledge Base.](https://support.maxmind.com/knowledge-base/minfraud-domain-risk-data#domain-visit)
8971004
{{</minfraud-schema-row>}}
8981005

8991006
{{</ schema-table >}}
@@ -1533,7 +1640,15 @@ Factors services, and a full example of the JSON body document for an error.
15331640
},
15341641
"email": {
15351642
"domain": {
1536-
"first_seen": "2015-01-20"
1643+
"classification": "business",
1644+
"first_seen": "2015-01-20",
1645+
"risk": 1.23,
1646+
"visit": {
1647+
"has_redirect": true,
1648+
"last_visited_on": "2025-11-15",
1649+
"status": "live"
1650+
},
1651+
"volume": 6.5
15371652
},
15381653
"first_seen": "2016-02-03",
15391654
"is_disposable": false,
@@ -1758,7 +1873,15 @@ Factors services, and a full example of the JSON body document for an error.
17581873
},
17591874
"email": {
17601875
"domain": {
1761-
"first_seen": "2015-01-20"
1876+
"classification": "business",
1877+
"first_seen": "2015-01-20",
1878+
"risk": 1.23,
1879+
"visit": {
1880+
"has_redirect": true,
1881+
"last_visited_on": "2025-11-15",
1882+
"status": "live"
1883+
},
1884+
"volume": 6.5
17621885
},
17631886
"first_seen": "2016-02-03",
17641887
"is_disposable": false,

0 commit comments

Comments
 (0)