Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Risk Evaluations

Create a risk evaluation override

Create a new risk evaluation override.

post/evaluation_overrides

Request body

account_idstring uuid

The unique identifier for the related customer account.

active_atstring date-time

The date and time when the evaluation override became active.

card_idstring uuid

The unique identifier for the related card.

customer_idstring uuid required

The unique identifier for the related customer.

expires_atstring date-time

The date and time when the evaluation override expires.

reasonstring required

The reason for the evaluation override.

spend_control_idstring uuid

The unique identifier for the related spend control.

transaction_idstring uuid

The unique identifier for the transaction.

type'FRAUD' | 'SPEND_CONTROL'

The type of evaluation override. Always present in responses; behavior and filtering depend on this field.

Example request

{
  "account_id": "30044785-ddb0-4a51-be1c-402bd4ba2b2b",
  "active_at": "2024-01-01T00:00:00.000Z",
  "card_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "customer_id": "5f4ff599-7c29-4f69-a3d9-e103e151afbd",
  "expires_at": "2024-12-31T23:59:59.000Z",
  "reason": "False positive - customer confirmed transaction is legitimate.",
  "spend_control_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "transaction_id": "f387d971-d23b-4cc0-997a-7bc4f895fe9a"
}

Response

The evaluation override response

account_idstring uuid

The unique identifier for the related customer account.

active_atstring date-time required

The date and time when the evaluation override became active.

card_idstring uuid

The unique identifier for the related card.

creation_timestring date-time required

The date and time the evaluation was created.

customer_idstring uuid required

The unique identifier for the related customer.

expires_atstring date-time

The date and time when the evaluation override expires.

idstring uuid required

The unique identifier for the evaluation override.

last_updated_timestring date-time required

The date and time the evaluation was last updated.

reasonstring required

The reason for the evaluation override.

spend_control_idstring uuid

The unique identifier for the related spend control.

transaction_idstring uuid

The unique identifier for the transaction.

type'FRAUD' | 'SPEND_CONTROL' required

The type of evaluation override. Always present in responses; behavior and filtering depend on this field.

Example response

{
  "account_id": "30044785-ddb0-4a51-be1c-402bd4ba2b2b",
  "active_at": "2024-01-01T00:00:00.000Z",
  "card_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "creation_time": "2010-05-06T12:23:34.321Z",
  "customer_id": "5f4ff599-7c29-4f69-a3d9-e103e151afbd",
  "expires_at": "2024-12-31T23:59:59.000Z",
  "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "reason": "False positive - customer confirmed transaction is legitimate.",
  "spend_control_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "transaction_id": "f387d971-d23b-4cc0-997a-7bc4f895fe9a"
}