List beneficiaries

GEThttps://api.veriko.mx/v1/beneficiaries

List beneficiaries

Audience: public
Auth: API key
Permission: beneficiaries:read

Returns the beneficiary accounts saved under the authenticated account, unpaginated. The list gathers the three types the API recognises: CLABE, card, and phone (DiMo).

The with_archived parameter governs archived-account visibility and accepts three states:

omitted or empty: active and archived, which is the default;
0: active only;
1: archived only.

To resolve a single account without walking the list there is GET /v1/beneficiaries/lookup; to register many at once from CSV or XLS, POST /v1/beneficiaries/imports.

Parameters
Parameter	In	Type	Required	Description
`with_archived`	query	`string`	optional	Tri-state filter: omitted = all; `0` = active only; `1` = archived only. e.g. `0`

Request

cURLPython•JavaScript•PHP•

curl -X GET 'https://api.veriko.mx/v1/beneficiaries' \
  -H 'Authorization: Bearer veriko_••••'

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

**Response 200**`ListBeneficiariesResponse` — Complete list of the user's beneficiary accounts per the filter.
Field	Type	Description
`data`	`array`	Main response payload. Shape varies by endpoint (object, array, or JSON:API envelope with `type`, `id`, `attributes`).
`type`*	`string`	JSON:API resource type. Always `beneficiary`. e.g. `beneficiary`
`id`*	`string`	Auto-increment numeric identifier of the beneficiary in the `user_beneficiaries` table. e.g. `42`
`attributes`*	`object`	Canonical beneficiary attributes (recipient account data and record metadata).
`account_number`*	`string`	Stored account number: 18-digit CLABE, 16-digit card, or 10-digit DiMo phone. Use `account_type` to disambiguate the exact type. e.g. `012180004412345678`
`account_type`*	`string`	Auto-detected account type: `clabe` (18 digits), `card` (16 digits), or `phone` (10 digits, DiMo mobile). e.g. `clabe`
`bank_code`*	`string`	5-digit Banxico code of the receiving bank, derived from the CLABE prefix, card BIN, or DiMo catalog. e.g. `40012`
`bank_name`*	`string`	Bank name resolved from the CLABE prefix, card BIN, or DiMo catalog. e.g. `BBVA MEXICO`
`label`	`string \| null`nullable	User-assigned descriptive label. `null` if not provided. e.g. `Proveedor ABC`
`status`*	`string`	Beneficiary status. `inactive` is set when the beneficiary is archived (excluded from default listings). `active` — in use; `inactive` — retired without being deleted. e.g. `active`
`created_at`*	`string (date-time)`	UTC creation timestamp. e.g. `2026-01-15T10:00:00Z`
`meta`	`object`	Response metadata including API version, route prefix, unique request identifier, and the server timestamp in UTC.
`version`	`string`	API version that processed the request. e.g. `1.47.0`
`api_version`	`string`	API route prefix version (e.g. `v1`). e.g. `v1`
`request_id`	`string`	Unique request identifier (hex). e.g. `a1b2c3d4e5f6`
`datetime`	`object`	Companion descriptor present in every response's meta block (and in outgoing webhook payloads). Lets clients assert the timezone contract without re-reading the spec. e.g. `{"timezone":"UTC","format":"ISO 8601"}`
`timezone`*	`string`	Always `UTC` — the canonical timezone for every datetime field in the body. e.g. `UTC`
`format`*	`string`	Always `ISO 8601` — explicit `Z` suffix on every datetime. e.g. `ISO 8601`
`links`	`object`	Pagination or related links, present only when the endpoint returns a paginated collection.

**Response status codes**`GET /v1/beneficiaries`
Status	Class	Description	Body
200	`2xx`	Complete list of the user's beneficiary accounts per the filter.	`ListBeneficiariesResponse`
401	`4xx`	Authentication is required or the provided credentials are invalid.	`ErrorResponse`
403	`4xx`	Insufficient permissions.	`ErrorResponse`

**Errors from `GET /v1/beneficiaries`**
Status	Code	Example
401	`unauthorized`	Invalid or missing authentication credentials. Envelope meta.request_id `c4d5e6f7a8b9`
403	`forbidden`	You do not have permission to access this resource. Envelope meta.request_id `d5e6f7a8b9c0`