Listar beneficiarios

GET https://api.veriko.mx/v1/beneficiaries

Audiencia: public
Autenticación: API key
Permiso: beneficiaries:read

Devuelve las cuentas beneficiarias guardadas del usuario autenticado, sin paginación. Incluye CLABE, tarjeta y celular (DiMo). El parámetro with_archived controla la visibilidad de las cuentas archivadas (tri-state):

omitido o vacío: incluye activas y archivadas (comportamiento por defecto);
0: solo activas; - 1: solo archivadas. Para resolver una cuenta específica sin paginar la lista usa GET /v1/beneficiaries/lookup; para cargar muchos beneficiarios a la vez desde CSV/XLS usa POST /v1/beneficiaries/imports.

Parámetros
Parámetro	Ubicación	Tipo	Obligatorio	Descripción
`with_archived`	query	`string`	opcional	Filtro tri-state: omitido = todas; `0` = solo activas; `1` = solo archivadas.

Petición

cURLPython•JavaScript•PHP•

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

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

**Respuesta 200** `ListBeneficiariesResponse` — Lista completa de cuentas beneficiarias del usuario según el filtro.
Campo	Tipo	Descripción
`type` *	`string`	Tipo de recurso JSON:API. Siempre `beneficiary`.
`id` *	`integer`	Identificador numérico autoincremental del beneficiario en la tabla `user_beneficiaries`.
`attributes` *	`object`	Atributos canónicos del beneficiario (datos de la cuenta receptora y metadatos del registro).
`account_number` *	`string`	Número de cuenta almacenado: CLABE (18 dígitos), tarjeta (13-19 dígitos) o celular DiMo (10 dígitos). Use `account_type` para desambiguar el tipo exacto.
`account_type` *	`string`	Tipo de cuenta autodetectado: `clabe` (18 dígitos), `card` (13-19 dígitos) o `phone` (10 dígitos, celular DiMo).
`bank_code` *	`string`	Código Banxico de 5 dígitos del banco receptor, derivado del prefijo CLABE, BIN de la tarjeta o catálogo DiMo.
`bank_name` *	`string`	Nombre del banco resuelto a partir del prefijo CLABE, BIN de la tarjeta o catálogo DiMo.
`label`	`string \| null` anulable	Etiqueta descriptiva libre del usuario. `null` si no fue asignada.
`status` *	`string`	Estado del beneficiario. `inactive` se asigna cuando el beneficiario se archiva (no aparece en listados por defecto).
`created_at` *	`string (date-time)`	Marca temporal UTC de creación.

**Códigos de respuesta** `GET /v1/beneficiaries`
Código	Clase	Descripción	Cuerpo
200	`2xx`	Lista completa de cuentas beneficiarias del usuario según el filtro.	`ListBeneficiariesResponse`
401	`4xx`	Se requiere autenticación o las credenciales son inválidas	`ErrorResponse`
403	`4xx`	Permisos insuficientes	`ErrorResponse`

**Errores de `GET /v1/beneficiaries`**
Código	Clave	Detalle
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`