---
title: "Preview Match"
method: POST
path: "/api/admin/whitelist/preview"
tags: ["Admin - Whitelist"]
---

# Preview Match

`POST /api/admin/whitelist/preview`

Test an email against the current ruleset without side effects.

Useful for admins verifying a rule before onboarding a customer.

## Request body

- WhitelistMatchPreviewRequest
  - `email` string, required

## Response `200`

Successful Response

- WhitelistMatchPreviewResponse
  - `success` boolean
  - `match` WhitelistEntry
    - `id` string, required
    - `pattern` string, required — "user@company.com" or "@company.com"
    - `credit_limit_usd` number, nullable
    - `created_by` string, nullable
    - `notes` string, nullable
    - `created_at` string, required
    - `source` string
    - `detected_user_count` integer, nullable

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/compresr/apis/compresr-platform-api.md) · [All operations](https://skmtc.net/compresr/apis/compresr-platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/compresr/compresr-platform-api/versions/93ee959dfa51/schema)