---
title: "List recipients"
method: POST
path: "/beneficiaries/list"
tags: ["Reporting"]
---

# List recipients

`POST /beneficiaries/list`

## Request

- Base URL: `https://www.sandbox.striga.com/api/v1/grid`
- URL: `https://www.sandbox.striga.com/api/v1/grid/beneficiaries/list`
- Auth: API key in header `api-key` and API key in header `Authorization`

Lists the payout recipients registered for your application, newest first.

By default `DEACTIVATED` recipients are excluded — pass `status` explicitly to see them. Use a recipient's `id` as the `beneficiaryId` on a payout.

Recipients appear as `PENDING` until sanctions screening completes, then flip to `ACTIVE`. Only `ACTIVE` recipients can be paid.

## Request body

- object
  - `status` 'PENDING' | 'ACTIVE' | 'DEACTIVATED' | 'BLACKLISTED': Lifecycle state of a recipient. `PENDING` means sanctions screening has not finished yet; only `ACTIVE` recipients can be paid.
  - `limit` integer: Page size, 1-100.
  - `offset` integer: Number of records to skip.

## Response `200`

A page of recipients.

- object
  - `beneficiaries` Beneficiary[]
    - `id` string, uuid: Striga recipient id — pass this as `beneficiaryId` when creating a payout.
    - `status` 'PENDING' | 'ACTIVE' | 'DEACTIVATED' | 'BLACKLISTED': Lifecycle state of a recipient. `PENDING` means sanctions screening has not finished yet; only `ACTIVE` recipients can be paid.
    - `currency` string: Funding currency of the linked account. Always `USDC`.
    - `payoutCurrency` 'USD' | 'MXN' | 'BRL': Currency the recipient is paid in.
    - `accountDetails` AccountDetails: Destination account. Which fields are present depends on `accountType`.
      - `accountType` 'USD_ACCOUNT' | 'MXN_ACCOUNT' | 'BRL_ACCOUNT'
      - `accountNumber` string: USD only — US bank account number.
      - `routingNumber` string: USD only — ABA routing number.
      - `accountCategory` 'CHECKING' | 'SAVINGS': USD only.
      - `bankName` string: USD only, when known.
      - `clabeNumber` string: MXN only — 18-digit CLABE (SPEI).
      - `pixKey` string: BRL only — the PIX key.
      - `pixKeyType` 'CPF' | 'CNPJ' | 'EMAIL' | 'PHONE' | 'RANDOM': BRL only.
      - `taxId` string: BRL only — recipient CPF or CNPJ.
      - `paymentRails` string[]
    - `beneficiaryInfo` BeneficiaryInfo: Who is being paid. `legalName` is present for `BUSINESS` recipients, `fullName` for `INDIVIDUAL` recipients.
      - `beneficiaryType` 'INDIVIDUAL' | 'BUSINESS'
      - `fullName` string
      - `legalName` string
      - `countryOfResidence` string: ISO 3166-1 alpha-2. Required for BUSINESS recipients on MXN/BRL.
      - `registrationNumber` string
      - `taxId` string
      - `address` object
    - `linkedAccountId` string: The USDC account payouts to this recipient are funded from.
    - `syncedOwnerId` string: Owner of the recipient — your applicationId for corporate recipients.
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
  - `total` integer: Total matching the filter, across all pages.
  - `limit` integer
  - `offset` integer

## Other responses

- `400`: Invalid `status`, `limit` or `offset`.
- `401`: Missing or invalid `api-key` / HMAC signature.
- `403`: Your application does not have the `LIST_BENEFICIARIES` permission.

---

[API](https://skmtc.dev/striga/apis/lightspark-grid-global-payments.md) - [All operations](https://skmtc.dev/striga/apis/lightspark-grid-global-payments/llms.txt) - [OpenAPI document](https://skmtc.dev/striga/apis/lightspark-grid-global-payments/revisions/7b0a8cde82ff?raw)
