Skip to content

Corgi BankDocumentation

OpenAPI

The Fraud Review object

FraudReview is a payment the outbound fraud rules held, with the evidence and the decision.

Attributes

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amountintegerRequired

callback_requiredbooleanRequired

callbacksarray of objectsOptional

8 child attributes

called_atstring · date-timeRequired

idintegerRequired

notestringOptional

number_calledstringRequired

number_sourcestringRequired

Customer_record

outcomestringRequired

Verified, not_verified or no_answer

recorded_atstring · date-timeRequired

recorded_bystringRequired

counterpartyobjectRequired

FraudCounterparty is who a held payment pays.

3 child attributes

account_numberstringRequired

namestringRequired

routing_numberstringRequired

currency_codestringRequired

customer_idstringOptional

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

decided_atstring · date-time or nullOptional

decided_bystringOptional

decision_reasonstringOptional

factsobjectRequired

idstringRequired

initiated_bystringRequired

opened_atstring · date-timeRequired

parametersobjectRequired

parameters_readbooleanRequired

payment_idstringRequired

Example lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm

payment_kindstringRequired

Wire, instant or ach

railstringRequired

reasonsarray of stringsRequired

rules_hitarray of stringsRequired

scoresarray of objectsRequired

7 child attributes

callback_requiredbooleanRequired

errorstringOptional

holdbooleanRequired

reasonsarray of stringsRequired

rules_hitarray of stringsRequired

scoreintegerRequired

scorerstringRequired

statusstringRequired

Open, released or rejected

The Fraud Review object

{
  "account_id": "acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "amount": 10000,
  "callback_required": false,
  "callbacks": [
    {
      "called_at": "2026-09-17T14:30:00Z",
      "id": 0,
      "note": "string",
      "number_called": "string",
      "number_source": "string",
      "outcome": "string",
      "recorded_at": "2026-09-17T14:30:00Z",
      "recorded_by": "string"
    }
  ],
  "counterparty": {
    "account_number": "string",
    "name": "string",
    "routing_number": "string"
  },
  "currency_code": "USD",
  "customer_id": "cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "decided_at": "2026-09-17T14:30:00Z",
  "decided_by": "string",
  "decision_reason": "string",
  "facts": {},
  "id": "string",
  "initiated_by": "string",
  "opened_at": "2026-09-17T14:30:00Z",
  "parameters": {},
  "parameters_read": false,
  "payment_id": "lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "payment_kind": "string",
  "rail": "string",
  "reasons": [
    "string"
  ],
  "rules_hit": [
    "string"
  ],
  "scores": [
    {
      "callback_required": false,
      "error": "string",
      "hold": false,
      "reasons": [
        "string"
      ],
      "rules_hit": [
        "string"
      ],
      "score": 0,
      "scorer": "string"
    }
  ],
  "status": "string"
}