Get dashboard summary

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

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

Returns the user's aggregate validation counters and, in relationships.recent_validations, the latest N validations (parameter ?limit=, default 5, maximum 10). It also includes comenzar_milestones_completed for the /comenzar wizard.

Parameters
Parameter	In	Type	Required	Description
`limit`	query	`integer`	optional	Maximum number of recent validations to return. 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`	Resource type, fixed for this operation. Part of the resource identity in the JSON:API envelope. Always `dashboard_summary`. e.g. `dashboard_summary`
`attributes`*	`object`	Aggregated user dashboard attributes (counts, success rate, onboarding progress).
`total_validations`	`integer`	Cumulative validation count for the user across all months. e.g. `1284`
`monthly_validations`	`integer`	Validations in the current calendar month (UTC). e.g. `96`
`pending_month`	`integer`	Current-month validations still in a non-terminal state (`queued` or `processing`). e.g. `3`
`valid_validations`	`integer`	User's validations with verdict `valid` (lifetime total). e.g. `1160`
`avg_ticket`	`number`	User's lifetime average ticket: average amount over ALL of the user's validations with amount > 0 (excludes playground and soft-deleted). `0` when there is no positive amount. e.g. `4302.32`
`success_rate_percent`	`number`	Success rate as a percentage (0-100) over the total validations. e.g. `0`
`beneficiaries_count`	`integer`	Count of the user's active beneficiaries. e.g. `12`
`comenzar_milestones_completed`	`integer`	Milestones cleared in the `/comenzar` wizard: (1) ≥1 OCR validation, (2) ≥1 direct validation, (3) ≥1 beneficiary, (4) (1) AND (2). Max total: 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`	Response body. Everything hangs off here, per the JSON:API envelope.

**Response status codes**`GET /v1/summary`
Status	Class	Description	Body
200	`2xx`	Dashboard summary for the authenticated user.	No body
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 `c4d5e6f7a8b9`