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

Get dashboard summary

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

Returns the user's aggregate counters: the lifetime total, the current UTC-month total, validations with verdict valid, the monthly count of the queued and processing states, the average amount, and the success rate. It also includes the active beneficiary count.

relationships.recent_validations contains the latest validations that have not been withdrawn. Its size is controlled by ?limit=, from 1 to 10; the default is 5.

comenzar_milestones_completed indicates progress through the /comenzar wizard.

Parameters
Parameter	In	Type	Required	Description
`limit`	query	`integer`	optional	Filter — Maximum number of recent validations to return. From `1` to `10`; the default is `5`. Default: `5` e.g. `5`

Request

cURLPython•JavaScript•PHP•

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

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

**Response 200**`DashboardSummary` — Dashboard summary for the authenticated user.
Field	Type	Description
`type`*	`string`	JSON:API resource type. Always `dashboard_summary`. e.g. `dashboard_summary`
`attributes`*	`object`	Aggregated user dashboard data: counts, success rate, and onboarding progress.
`total_validations`	`integer`	Lifetime number of the user's validations. Includes withdrawn and playground validations. e.g. `1284`
`monthly_validations`	`integer`	Number of validations in the current UTC calendar month. Includes withdrawn and playground validations. e.g. `96`
`pending_month`	`integer`	Number of non-withdrawn validations in the current UTC month whose stored state is `queued` or `processing`. e.g. `3`
`valid_validations`	`integer`	Lifetime number of the user's validations with verdict `valid`. Includes withdrawn and playground validations. e.g. `1160`
`avg_ticket`	`number`	Average amount per validation in MXN. It is computed over the user's full history and only with amounts greater than `0`; it excludes playground and withdrawn validations. Returns `0` when there is no positive amount. e.g. `4302.32`
`success_rate_percent`	`number`	Success rate from `0` to `100`: `valid_validations` divided by `total_validations`, rounded to one decimal place. It uses the same lifetime population, including withdrawn and playground validations; returns `0` when the total is `0`. e.g. `90.3`
`beneficiaries_count`	`integer`	Count of the user's active beneficiaries. e.g. `12`
`comenzar_milestones_completed`	`integer`	Number of milestones completed in the `/comenzar` wizard: (1) at least one non-withdrawn OCR validation exists, (2) at least one non-withdrawn manual validation exists, (3) at least one active beneficiary exists, and (4) both (1) and (2) are met. Maximum: `4`. e.g. `0`
`relationships`	`object`	Dashboard JSON:API relationships (references to associated resources).
`recent_validations`	`object`	JSON:API relationship pointing to the recent validations shown in the dashboard.
`data`	`array`	Recent validations, each as a compact resource.

**Response status codes**`GET /v1/summary`
Status	Class	Description	Body
200	`2xx`	Dashboard summary for the authenticated user.	`DashboardSummary`
401	`4xx`	Authentication is required or the provided credentials are invalid.	`ErrorResponse`

**Errors from `GET /v1/summary`**
Status	Code	Example
401	`unauthorized`	Invalid or missing authentication credentials. Envelope meta.request_id `c4d5e6f7a8b99b8a7f6e5d4c`