Skip to content

risk score reasons are marked as available in all three minfraud tiers #1264

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

Closed
AndraMeer wants to merge 1 commit into from
Closed

risk score reasons are marked as available in all three minfraud tiers #1264

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
8 changes: 4 additions & 4 deletions content/minfraud/api-documentation/responses.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -987,15 +987,15 @@ will not be present in the response.
```

{{< schema-table key="risk_score_reason" >}}
{{< minfraud-schema-row key="multiplier" type="response" valueType="Decimal" valueTypeNote="min: 0.01, max: 100" factors="true" >}}
{{< minfraud-schema-row key="multiplier" type="response" valueType="Decimal" valueTypeNote="min: 0.01, max: 100" score="true" insights="true" factors="true" >}}
The factor by which the risk score is increased (if the value is greater than 1) or decreased (if the value is less than 1) for given risk reason(s). Multipliers greater than 1.5 and less than 0.66 are considered significant and lead to risk reason(s) being present.
{{</minfraud-schema-row>}}

{{< minfraud-schema-row key="reasons" type="response" valueType="array" factors="true" >}}
{{< minfraud-schema-row key="reasons" type="response" valueType="array" score="true" insights="true" factors="true" >}}
This array contains objects that describe one of the reasons for the multiplier.
{{</minfraud-schema-row>}}

{{< minfraud-schema-row key="code" type="response" valueType="string" valueTypeNote="format: enum, max length: 255" factors="true" >}}
{{< minfraud-schema-row key="code" type="response" valueType="string" valueTypeNote="format: enum, max length: 255" score="true" insights="true" factors="true" >}}
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.
| Code |
| --------------- |
Expand All @@ -1004,7 +1004,7 @@ will not be present in the response.
| ORG\_DISTANCE\_RISK |
{{</minfraud-schema-row>}}

{{< minfraud-schema-row key="reason" type="response" valueType="string" factors="true" >}}
{{< minfraud-schema-row key="reason" type="response" valueType="string" score="true" insights="true" factors="true">}}
The human-readable description of the risk reason and its effect on the overall risk score.
| Code | Reason |
| ------------------------------------------ | ---------------------------------------------------------------------------------------------------------------- |
Expand Down
Loading