Skip to content

Commit 70b8543

Browse files
kevcentenokevcenteno
committed
Add non-scalar key values to minfraud response top level field section
1 parent a0507e0 commit 70b8543

File tree

2 files changed

+91
-14
lines changed

2 files changed

+91
-14
lines changed

‎content/minfraud/api-documentation/responses.md‎

Lines changed: 87 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -183,12 +183,22 @@ For full examples of response bodies, select one of the following:
183183

184184
```json
185185
{
186-
...
187186
"id": "5bc5d6c2-b2c8-40af-87f4-6d61af86b6ae",
188187
"risk_score": 0.01,
189188
"funds_remaining": 25,
190-
"queries_remaining": 5000
191-
...
189+
"queries_remaining": 5000,
190+
"ip_address": {...},
191+
"credit_card": {...},
192+
"device": {...},
193+
"email": {...},
194+
"shipping_address": {...},
195+
"shipping_phone": {...},
196+
"billing_address": {...},
197+
"billing_phone": {...},
198+
"disposition": {...},
199+
"risk_score_reasons": [...],
200+
"subscores": {...},
201+
"warnings": [...]
192202
}
193203
```
194204

@@ -212,6 +222,70 @@ For full examples of response bodies, select one of the following:
212222
The approximate number of queries remaining for the service before your account runs out of funds.
213223
{{</minfraud-schema-row>}}
214224

225+
{{< minfraud-schema-row key="queries_remaining" type="response" valueType="integer" valueTypeNote="min: 0" score="true" insights="true" factors="true" >}}
226+
The approximate number of queries remaining for the service before your account runs out of funds.
227+
{{</minfraud-schema-row>}}
228+
229+
{{< minfraud-schema-row key="ip_address" fragmentOverride="ip-address" type="response" valueType="object" score="true" insights="true" factors="true" >}}
230+
This object contains IP intelligence data.
231+
[See more](#ip-address).
232+
{{</minfraud-schema-row>}}
233+
234+
{{< minfraud-schema-row key="credit_card" fragmentOverride="credit-card" type="response" valueType="object" insights="true" factors="true" >}}
235+
This object contains information related to the credit card.
236+
[See more](#credit-card).
237+
{{</minfraud-schema-row>}}
238+
239+
{{< minfraud-schema-row key="device" fragmentOverride="device" type="response" valueType="object" insights="true" factors="true" >}}
240+
This object contains information about the device that MaxMind believes is associated with the IP address passed in the request.
241+
[See more](#device).
242+
{{</minfraud-schema-row>}}
243+
244+
{{< minfraud-schema-row key="email" fragmentOverride="email" type="response" valueType="object" insights="true" factors="true" >}}
245+
This object contains email intelligence data.
246+
[See more](#email).
247+
{{</minfraud-schema-row>}}
248+
249+
{{< minfraud-schema-row key="shipping_address" fragmentOverride="shipping-address" type="response" valueType="object" insights="true" factors="true" >}}
250+
This object contains information related to the shipping address
251+
[See more](#shipping-address).
252+
{{</minfraud-schema-row>}}
253+
254+
{{< minfraud-schema-row key="shipping_phone" fragmentOverride="shipping-phone" type="response" valueType="object" insights="true" factors="true" >}}
255+
This object contains information related to the shipping phone number
256+
[See more](#shipping-phone).
257+
{{</minfraud-schema-row>}}
258+
259+
{{< minfraud-schema-row key="billing_address" fragmentOverride="billing-address" type="response" valueType="object" insights="true" factors="true" >}}
260+
This object contains information related to the billing address
261+
[See more](#billing-address).
262+
{{</minfraud-schema-row>}}
263+
264+
{{< minfraud-schema-row key="billing_phone" fragmentOverride="billing-phone" type="response" valueType="object" insights="true" factors="true" >}}
265+
This object contains information related to the billing phone number
266+
[See more](#billing-phone).
267+
{{</minfraud-schema-row>}}
268+
269+
{{< minfraud-schema-row key="disposition" fragmentOverride="disposition" type="response" valueType="object" score="true" insights="true" factors="true" >}}
270+
This object contains information about how a request was handled by the custom rules you have defined.
271+
[See more](#disposition).
272+
{{</minfraud-schema-row>}}
273+
274+
{{< minfraud-schema-row key="risk_score_reasons" fragmentOverride="risk-score-reasons" type="response" valueType="array" factors="true" >}}
275+
This array contains risk score reason objects.
276+
[See more](#risk-score-reasons).
277+
{{</minfraud-schema-row>}}
278+
279+
{{< minfraud-schema-row key="subscores" fragmentOverride="subscores" type="response" valueType="object" factors="true" >}}
280+
**Deprecated.** This object contains risk factor scores for many of the individual components that are used in calculating the risk_score.
281+
[See more](#subscores).
282+
{{</minfraud-schema-row>}}
283+
284+
{{< minfraud-schema-row key="warnings" fragmentOverride="warnings" type="response" valueType="array" score="true" insights="true" factors="true" >}}
285+
This array contains warning objects detailing issues with the request that was sent such as invalid or unknown inputs.
286+
[See more](#warnings).
287+
{{</minfraud-schema-row>}}
288+
215289
{{</ schema-table >}}
216290

217291
### IP Address
@@ -948,7 +1022,7 @@ will not be present in the response.
9481022
},
9491023
{
9501024
"code": "IP_ISSUER_ID_NUMBER_VELOCITY",
951-
"reason": "The number of distinct Issuer ID Numbers found in the
1025+
"reason": "The number of distinct Issuer ID Numbers found in the
9521026
velocity check on IP address raised the overall risk score"
9531027
}
9541028
]
@@ -958,7 +1032,7 @@ will not be present in the response.
9581032
"reasons": [
9591033
{
9601034
"code": "TIME_OF_DAY",
961-
"reason": "The local time of day of the request raised the overall
1035+
"reason": "The local time of day of the request raised the overall
9621036
risk score"
9631037
}
9641038
]
@@ -968,7 +1042,7 @@ will not be present in the response.
9681042
"reasons": [
9691043
{
9701044
"code": "EMAIL_DOMAIN_NEW",
971-
"reason": "The email domain being recently seen for the first time
1045+
"reason": "The email domain being recently seen for the first time
9721046
in the minFraud network raised the overall risk score"
9731047
}
9741048
]
@@ -978,7 +1052,7 @@ will not be present in the response.
9781052
"reasons": [
9791053
{
9801054
"code": "PHONE_ACTIVITY",
981-
"reason": "minFraud network activity of the phone number lowered
1055+
"reason": "minFraud network activity of the phone number lowered
9821056
the overall risk score"
9831057
}
9841058
]
@@ -999,9 +1073,9 @@ will not be present in the response.
9991073
A machine-readable code identifying the risk reason. Examples listed below. Although more codes may be added in the future, a list of current codes may be provided on request.
10001074
| Code |
10011075
| --------------- |
1002-
| ANONYMOUS\_IP |
1003-
| COUNTRY |
1004-
| ORG\_DISTANCE\_RISK |
1076+
| ANONYMOUS\_IP |
1077+
| COUNTRY |
1078+
| ORG\_DISTANCE\_RISK |
10051079
{{</minfraud-schema-row>}}
10061080

10071081
{{< minfraud-schema-row key="reason" type="response" valueType="string" factors="true" >}}
@@ -1019,9 +1093,9 @@ will not be present in the response.
10191093
{{< anchor-target schema--response--subscores >}}
10201094

10211095
{{< alert warning >}}
1022-
Risk factor scores are deprecated as of November 4, 2024. Please
1023-
[review risk score reasons](/minfraud/api-documentation/responses/#risk-score-reasons)
1024-
for insight into why a risk score is high or low.
1096+
Risk factor scores are deprecated as of November 4, 2024. Please
1097+
[review risk score reasons](/minfraud/api-documentation/responses/#risk-score-reasons)
1098+
for insight into why a risk score is high or low.
10251099

10261100
{{</ alert >}}
10271101

‎layouts/shortcodes/minfraud-schema-row.html‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
{{ $key := .Get "key" }}
44
{{ $type := .Get "type" }}
55
{{ $fragment := printf "schema--%s--%s__%s" $type $parentKey $key }}
6+
{{ $fragmentOverride := .Get "fragmentOverride" }}
7+
{{ $href := $fragment }}
8+
{{ if $fragmentOverride }}{{ $href = $fragmentOverride }}{{ end }}
69

710
{{ $score := .Get "score" }}
811
{{ $insights := .Get "insights" }}
@@ -14,7 +17,7 @@
1417

1518
<tr>
1619
<td class="schema__key-cell">
17-
<a href="#{{ $fragment }}"><code class="schema__row-key">{{ $key }}</code></a>
20+
<a href="#{{ $href }}"><code class="schema__row-key">{{ $key }}</code></a>
1821
</td>
1922
<td class="schema__type-cell">
2023
{{ .Get "valueType" }}

0 commit comments

Comments
 (0)