---
title: "List beneficiaries"
method: GET
path: "/v1/beneficiaries"
tags: ["Beneficiaries"]
---

# List beneficiaries

`GET /v1/beneficiaries`

List registered beneficiaries with query filtering options.

## Query parameters

- `lastEvaluatedCreationDatetime` string
- `perPage` string
- `order` 'DESC' | 'ASC'
- `name` string
- `alias` string
- `enabled` boolean

## Headers

- `Authorization` string, required

## Response `200`

Response Body

- BeneficiariesSearchBeneficiaryResponse
  - `items` BeneficiariesBeneficiary[]
    - `account_code` string — Beneficiary account code.
    - `account_id` integer — Account ID
    - `account_type` 'CACC' | 'SLRY' | 'SVGS' | 'TRAN' — Account type: `CACC` - Checking/current account. Known as "conta corrente" in Portuguese, this is a bank account type designed for everyday financial transactions and is the most common type individuals and businesses use for day-to-day banking. `SVGS` - Savings account `TRAN` - Payment account. Payment institutions offer payment accounts to move funds and make payments, while banks offer checking accounts that include full financial services such as credit and investments. `SLRY` - Salary account. Employer deposits a fixed amount every month.
    - `alias` string — Beneficiary alias.
    - `bank_code` string — Beneficiary bank code.
    - `beneficiary_id` string — UUID identifying beneficiary.
    - `branch` string — Beneficiary branch.
    - `creation_datetime` string, date-time — Account creation date time displayed in ISO 8601 format `2023-04-12T23:20:50.52Z`.
    - `document_number` string — A government document number, such as a Social Security number (US) or Cadastro de Pessoas Físicas number (Brazil).
    - `enabled` boolean — Is beneficiary active flag.
    - `name` string — Beneficiary's first and last name.
    - `region` string — ISO-3166 two letter country code. For example, BR=Brazil.
    - `schema` 'BANKACCOUNT' | 'PIX' | 'DOCUMENTNUMBER' — Beneficiary schema validation: `BANKACCOUNT` - `account_code` contains a Brazilian account number (used in junction with the `bank_code` and `branch` fields) `PIX` - `account_code` contains a valid Pix key. For more information, see <a href="https://developers.pismo.io/pismo-docs/docs/pix-instant-payments" target="_blank">Pix instant payments</a> `DOCUMENTNUMBER` - `account_code` contains a valid Brazilian document number. This is government document number, such as Cadastro de Pessoas Físicas number - a Brazilian tax registry number, similar to a Social Security number in the US.
    - `updated_datetime` string, date-time — Updated date time. A RFC 3339 value, i.e., "2023-04-12T23:20:50.52Z".
  - `last_evaluated_creation_datetime` string — Use this field to get next results
  - `per_page` integer — Items per page.
  - `total_items` integer — Total items

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/pismo/apis/platform-authentication.md) · [All operations](https://skmtc.net/pismo/apis/platform-authentication/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pismo/platform-authentication/revisions/935b62e16de4/schema)