Skip to content

add tables with descriptions #1500

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add tables with descriptions #1500

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 34 additions & 23 deletions content/minfraud/api-documentation/requests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,19 +279,24 @@ transaction.
{{< minfraud-schema-row key="type" type="request" valueType="string" valueTypeNote="format: enum" >}}
The type of event being scored. The valid types are:

* `account_creation`
* `account_login`
* `credit_application`
* `email_change`
* `fund_transfer`
* `password_reset`
* `payout_change`
* `purchase`
* `recurring_purchase`
* `referral`
* `sim_swap`
* `survey`

The payment method associated with the transaction. The valid values are:
| Transaction type | Description |
| ---------------------------- | ------------------------------------------------------------------------------------------------------ |
| `account_creation` | The transactor is attempting to create an account in your system. |
| `account_login` | The transactor is attempting to log in to an account in your system. |
| `credit_application` | The transactor is attempting to submit an application for credit. |
| `email_change` | The transactor is attempting to change the email address associated with their account in your system. |
| `fund_transfer` | The transactor is attempting to transfer funds from one account to another. |
| `password_reset` | The transactor is attempting to reset their password in your system. |
| `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. |
| `purchase` | The transactor is attempting to make a purchase. |
| `recurring_purchase` | The transactor is attempting to set up a recurring purchase or subscription. |
| `referral` | The transactor is sending you referral traffic, for example referring someone to an e-commerce site with an ad. |
| `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. |
| `survey` | The transactor is attempting to begin or complete a survey. |

[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)
{{</minfraud-schema-row>}}

Expand Down Expand Up @@ -546,17 +551,23 @@ process that was used for the event.
{{< schema-table key="payment" >}}
{{< minfraud-schema-row key="method" type="request" valueType="string" valueTypeNote="format: enum" >}}
The payment method associated with the transaction. The valid values are:
| Payment method | Description |
| ---------------------------- | ------------------------------------------------------------------------------------------------------ |
| `bank_debit` | A direct debit of the customer's bank account. |
| `bank_redirect` | The customer authorizes payment after authentication via their bank. |
| `bank_transfer` | The customer pushes funds directly from their bank account. |
| `buy_now_pay_later` |Payment via a buy now, pay later provider (e.g. Affirm, Afterpay, Klarna, etc.). |
| `card` | Payment by card, such as a credit, debit, or charge card. |
| `crypto` | Payment via a cryptocurrency. |
| `digital_wallet` | Payment from a digital wallet linked to a card or bank account (e.g. Apple Pay, Google Pay, PayPal, etc.). |
| `gift_card` | Payment via a merchant sponsored gift card. |
| `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.). |
| `rewards` | Payment via rewards or loyalty program incentives. |

[Learn more about event and account inputs on our Knowledge Base.](https://support.maxmind.com/knowledge-base/articles/event-and-account-inputs-minfraud)



* `bank_debit`
* `bank_redirect`
* `bank_transfer`
* `buy_now_pay_later`
* `card`
* `crypto`
* `digital_wallet`
* `gift_card`
* `real_time_payment`
* `rewards`
{{</minfraud-schema-row>}}

{{< minfraud-schema-row key="processor" type="request" valueType="string" valueTypeNote="format: enum" >}}
Expand Down
14 changes: 8 additions & 6 deletions content/minfraud/api-documentation/responses.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -993,12 +993,14 @@ minFraud response.
{{< minfraud-schema-row key="status" type="response" valueType="string" insights="true" factors="true" >}}
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.

* `live` - the domain is reachable and serving content normally
* `dns_error` - the domain is missing, expired, or DNS is misconfigured
* `network_error` - the domain is offline, blocked, or unreachable
* `http_error` - the domain is reachable but the web application had a problem or denied the request
* `parked` - the domain is reachable and is in a parked state
* `pre_development` - the domain is reachable and is in a pre-development state
| Status | Description |
| ---------------------------- | ------------------------------------------------------------------------------------------------------ |
| `live` | The domain is reachable and serving content normally. |
| `dns_error` | The domain is missing, expired, or DNS is misconfigured. |
| `network_error` | The domain is offline, blocked, or unreachable. |
| `http_error` | The domain is reachable but the web application had a problem or denied the request. |
| `parked` | The domain is live and is in a parked state. |
| `pre_development` | The domain is live and is in a pre-development state. |

[Learn more about the email domain visit status on our Knowledge Base.](https://support.maxmind.com/knowledge-base/minfraud-domain-risk-data#domain-visit)
{{</minfraud-schema-row>}}
Expand Down