Skip to content

Commit 085d23a

Browse files
AndraMeerAndraMeer
authored
Merge pull request #1500 from maxmind/andram/descriptions-update
add tables with descriptions
2 parents 85005d4 + 977d185 commit 085d23a

File tree

2 files changed

+48
-41
lines changed

2 files changed

+48
-41
lines changed

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

Lines changed: 35 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -277,24 +277,28 @@ transaction.
277277
{{</minfraud-schema-row>}}
278278

279279
{{< minfraud-schema-row key="type" type="request" valueType="string" valueTypeNote="format: enum" >}}
280+
280281
The type of event being scored. The valid types are:
282+
283+
| Transaction type | Description |
284+
| ---------------------------- | ------------------------------------------------------------------- |
285+
| `account_creation` | The transactor is attempting to create an account in your system. |
286+
| `account_login` | The transactor is attempting to log in to an account in your system. |
287+
| `credit_application` | The transactor is attempting to submit an application for credit. |
288+
| `email_change` | The transactor is attempting to change the email address associated with their account in your system. |
289+
| `fund_transfer` | The transactor is attempting to transfer funds from one account to another. |
290+
| `password_reset` | The transactor is attempting to reset their password in your system. |
291+
| `payout_change` | The transactor is attempting to change how they will be paid in your system. The transactor may be sending you referral traffic or complete surveys, but this transaction type can be used in any circumstance in which you pay your users, and they are attempting to change how they are paid. |
292+
| `purchase` | The transactor is attempting to make a purchase. |
293+
| `recurring_purchase` | The transactor is attempting to set up a recurring purchase or subscription. |
294+
| `referral` | The transactor is sending you referral traffic, for example referring someone to an e-commerce site with an ad. |
295+
| `sim_swap` | For mobile network operators. A new SIM card or eSIM is being issued to activate service on a customer's existing phone number. |
296+
| `survey` | The transactor is attempting to begin or complete a survey. |
281297

282-
* `account_creation`
283-
* `account_login`
284-
* `credit_application`
285-
* `email_change`
286-
* `fund_transfer`
287-
* `password_reset`
288-
* `payout_change`
289-
* `purchase`
290-
* `recurring_purchase`
291-
* `referral`
292-
* `sim_swap`
293-
* `survey`
294298

295299
[Learn more about the /event/type input on our Knowledge Base.](https://support.maxmind.com/knowledge-base/articles/event-and-account-inputs-minfraud#transaction-identifier)
296-
{{</minfraud-schema-row>}}
297300

301+
{{</minfraud-schema-row>}}
298302
{{< minfraud-schema-row key="party" type="request" valueType="string" valueTypeNote="format: enum" >}}
299303
The party submitting this transaction. The valid values are:
300304

@@ -545,18 +549,25 @@ process that was used for the event.
545549

546550
{{< schema-table key="payment" >}}
547551
{{< minfraud-schema-row key="method" type="request" valueType="string" valueTypeNote="format: enum" >}}
552+
548553
The payment method associated with the transaction. The valid values are:
549-
550-
* `bank_debit`
551-
* `bank_redirect`
552-
* `bank_transfer`
553-
* `buy_now_pay_later`
554-
* `card`
555-
* `crypto`
556-
* `digital_wallet`
557-
* `gift_card`
558-
* `real_time_payment`
559-
* `rewards`
554+
555+
| Payment method | Description |
556+
| ---------------------------- | ------------------------------------------------------------------ |
557+
| `bank_debit` | A direct debit of the customer's bank account. |
558+
| `bank_redirect` | The customer authorizes payment after authentication via their bank. |
559+
| `bank_transfer` | The customer pushes funds directly from their bank account. |
560+
| `buy_now_pay_later` |Payment via a buy now, pay later provider (e.g. Affirm, Afterpay, Klarna, etc.). |
561+
| `card` | Payment by card, such as a credit, debit, or charge card. |
562+
| `crypto` | Payment via a cryptocurrency. |
563+
| `digital_wallet` | Payment from a digital wallet linked to a card or bank account (e.g. Apple Pay, Google Pay, PayPal, etc.). |
564+
| `gift_card` | Payment via a merchant sponsored gift card. |
565+
| `real_time_payment` | The customer pushes funds directly from their bank account or other funding source using an intermediary to authenticate, such as a phone number or other account (e.g. Pix, PayNow, Swish, etc.). |
566+
| `rewards` | Payment via rewards or loyalty program incentives. |
567+
568+
569+
[Learn more about event and account inputs on our Knowledge Base.](https://support.maxmind.com/knowledge-base/articles/event-and-account-inputs-minfraud)
570+
560571
{{</minfraud-schema-row>}}
561572

562573
{{< minfraud-schema-row key="processor" type="request" valueType="string" valueTypeNote="format: enum" >}}

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

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -992,14 +992,15 @@ minFraud response.
992992

993993
{{< minfraud-schema-row key="status" type="response" valueType="string" insights="true" factors="true" >}}
994994
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-
995+
| Status | Description |
996+
| ---------------------------- | ----------------------------------------------------------------- |
997+
| `live` | The domain is reachable and serving content normally. |
998+
| `dns_error` | The domain is missing, expired, or DNS is misconfigured. |
999+
| `network_error` | The domain is offline, blocked, or unreachable. |
1000+
| `http_error` | The domain is reachable but the web application had a problem or denied the request. |
1001+
| `parked` | The domain is live and is in a parked state. |
1002+
| `pre_development` | The domain is live and is in a pre-development state. |
1003+
10031004
[Learn more about the email domain visit status on our Knowledge Base.](https://support.maxmind.com/knowledge-base/minfraud-domain-risk-data#domain-visit)
10041005
{{</minfraud-schema-row>}}
10051006

@@ -1237,24 +1238,20 @@ then this object will not be present in the response.
12371238

12381239
{{< minfraud-schema-row key="action" type="response" valueType="string" valueTypeNote="format: enum" score="true" insights="true" factors="true" >}}
12391240
This describes how the request was handled. The valid values are:
1240-
12411241
| Action | Explanation |
12421242
| -------------- | -------------------------------------------------------------------------------------- |
12431243
| `accept` | This is the default value that is used if none of your custom rules match the request. |
12441244
| `reject` | |
12451245
| `manual_review` | |
12461246
| `test` | This value can be used to test custom rules. |
12471247
{{</minfraud-schema-row>}}
1248-
12491248
{{< minfraud-schema-row key="reason" type="response" valueType="string" valueTypeNote="format: enum" score="true" insights="true" factors="true" >}}
12501249
This describes why the `action` was set to a particular value. The valid values are:
1251-
12521250
| Reason | Explanation |
12531251
| ------------ | --------------------------------------------- |
12541252
| `default` | No custom rules matched the request. |
12551253
| `custom_rule` | A custom rule was applied and set the action. |
12561254
{{</minfraud-schema-row>}}
1257-
12581255
{{< minfraud-schema-row key="rule_label" type="response" valueType="string" score="true" insights="true" factors="true" >}}
12591256
The custom rule that was triggered. If you do not have custom rules set up, the triggered custom rule does not have a label, or no custom rule was triggered, the field will not be included in the response.
12601257
{{</minfraud-schema-row>}}
@@ -1374,10 +1371,10 @@ this array for issues when integrating the web service.
13741371
{{< minfraud-schema-row key="code" type="response" valueType="string" valueTypeNote="max length: 255" score="true" insights="true" factors="true" >}}
13751372
This value is a machine-readable code identifying the warning. Although more codes may be added in the future, the current codes are:
13761373

1377-
| Code | Description |
1378-
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1379-
| `BILLING_CITY_NOT_FOUND` | The billing city could not be found in our database. This may impact our ability to provide accurate distance calculations. |
1380-
| `BILLING_COUNTRY_MISSING` | Billing address information was provided without providing a billing country. This may impact our ability to provide accurate distance calculations. |
1374+
| Code | Description |
1375+
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------- |
1376+
| `BILLING_CITY_NOT_FOUND` | The billing city could not be found in our database. This may impact our ability to provide accurate distance calculations. |
1377+
| `BILLING_COUNTRY_MISSING` | Billing address information was provided without providing a billing country. This may impact our ability to provide accurate distance calculations. |
13811378
| `BILLING_COUNTRY_NOT_FOUND` | The billing country could not be found in our database. This may impact our ability to provide accurate distance calculations. |
13821379
| `BILLING_POSTAL_NOT_FOUND` | The billing postal could not be found in our database. This may impact our ability to provide accurate distance calculations. |
13831380
| `BILLING_REGION_NOT_FOUND` | The billing region could not be found in our database. This may impact our ability to provide accurate distance calculations. |
@@ -1394,7 +1391,6 @@ this array for issues when integrating the web service.
13941391
| `SHIPPING_REGION_NOT_FOUND` | The shipping region could not be found in our database. This may impact our ability to provide accurate distance calculations. |
13951392
{{</minfraud-schema-row>}}
13961393

1397-
13981394
{{< minfraud-schema-row key="warning" type="response" valueType="string" valueTypeNote="max length: 255" score="true" insights="true" factors="true" >}}
13991395
This field provides a human-readable explanation of the warning. The description may change at any time and should not be matched against.
14001396
{{</minfraud-schema-row>}}

0 commit comments

Comments
 (0)