User's frequent beneficiaries (last 90 days)

GET https://api.veriko.mx/v1/insights/top-beneficiaries

Audience: public
Auth: API key
Permission: insights:read_self

Lists the beneficiaries the user validated most frequently in the last 90 days. Each entry includes the saved label (if the beneficiary is registered), the bank, and the last 4 digits of the account.

Parameters
Parameter	In	Type	Required	Description
`limit`	query	`integer`	optional	Maximum number of beneficiaries to return. Default: `10`

Request

cURLPython•JavaScript•PHP•

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

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

**Response 200** `InsightsTopBeneficiariesAttributes` — User's most frequent beneficiaries over the last 90 days.
Field	Type	Description
`beneficiaries` *	`array`	Beneficiary ranking sorted by `count` descending (validations sent to that beneficiary in the last 90 days). Up to 5 entries.

**Response status codes** `GET /v1/insights/top-beneficiaries`
Status	Class	Description	Body
200	`2xx`	User's most frequent beneficiaries over the last 90 days.	No body
401	`4xx`	Authentication is required or the provided credentials are invalid.	`ErrorResponse`
403	`4xx`	Permisos insuficientes	`ErrorResponse`

**Errors from `GET /v1/insights/top-beneficiaries`**
Status	Code	Detail
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`