Skip to main content
POST
Test a value against fraud-control rules

Authorizations

Authorization
string
header
required

Body

application/json

Body of a POST /v2/blocks/test request. Checks a value against existing fraud-control rules without creating one.

list_type
enum<string>
required

What the fraud-control rule matches. USER_AGENT matches a substring of the event user-agent header (regex is not supported). EMAIL_DOMAIN matches the profile email domain on the event (for example example.com). NORMALIZED_EMAIL matches the provider-normalized profile email. Whether plus-address variants of the same mailbox match depends on the email provider. CIDR matches the event IP with CIDR notation (for example 192.168.1.0/24); overlapping CIDRs are separate fraud-control rules, not duplicates.

Available options:
CIDR,
EMAIL_DOMAIN,
NORMALIZED_EMAIL,
USER_AGENT
value
string
required

Value to test against existing fraud-control rules. The value is lowercased but not provider-normalized, so for NORMALIZED_EMAIL send the provider-normalized email, as stored on the fraud-control rule.

Response

Successful response

Result of testing a value against fraud-control rules.

block_Id
string | null
required

Identifier of the matching fraud-control rule, when one matched.

result
enum<string>
required

Outcome of testing a value against fraud-control rules. BLACKLISTED means a BLACK fraud-control rule matched. WHITELISTED means a WHITE fraud-control rule matched. NOT_LISTED means no fraud-control rule matched. A USER_AGENT value shorter than five characters returns BLACKLISTED with no block_Id, whether or not a fraud-control rule matches it.

Available options:
BLACKLISTED,
NOT_LISTED,
WHITELISTED