---
title: "Batch sanctions screening — up to 100 addresses, one receipt each (API key)"
method: POST
path: "/api/screen/batch"
tags: ["Screening"]
---

# Batch sanctions screening — up to 100 addresses, one receipt each (API key)

`POST /api/screen/batch`

## Request

- Base URL: `https://www.xrplhub.io`
- URL: `https://www.xrplhub.io/api/screen/batch`
- Auth: none declared

Screen up to 100 addresses (mixed chains) in one call against the same list snapshots. One receipt per address, all stored together so they land in the same on-ledger anchor batch, sharing a batchId. Each valid address counts as one call against your quota; an invalid address is reported per item.

## Request body

- object
  - `addresses` union[], required
    - union
      - string
      - object
        - `address` string
        - `reference` string
  - `lists` string

## Response `200`

Per-address results and the batchId.

- object

## Other responses

- `400`: Bad request or more than 100 addresses.
- `429`: Quota cannot cover the whole batch; nothing was screened.
- `503`: A list is not loaded yet.

---

[API](https://skmtc.dev/xrplhub/apis/xrplhub-xrplscore-and-prebuilt-xrpl-transactions.md) · [All operations](https://skmtc.dev/xrplhub/apis/xrplhub-xrplscore-and-prebuilt-xrpl-transactions/llms.txt) · [OpenAPI document](https://skmtc.dev/xrplhub/apis/xrplhub-xrplscore-and-prebuilt-xrpl-transactions/revisions/a5d4e13aff32?raw)