GEThttps://api.veriko.mx/v1/beneficiaries/imports/{id}/preview

Preview extracted rows from import

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

Returns the rows extracted from the file in an import job, paginated and filterable by bucket.

It responds in any job state; before preview_ready the list is empty.

Parameters
Parameter	In	Type	Required	Description
`id`*	path	`integer`	required	Numeric ID of the import job. e.g. `42`
`buckets`	query	`array<string>`	optional	Which rows to include, based on how they came out of the file. `valid` goes in as-is. `correctable` has a problem the platform can fix on its own — a bank inferred from the account number, say — and goes in too. `fatal` cannot be used and is dropped. `duplicate_account` and `duplicate_alias` clash with an existing beneficiary, by number or by name; the first is dropped and the second is kept anyway. Without this filter every row comes back. e.g. `["valid","correctable"]`
`page`	query	`integer`	optional	Page number (1-based). Default: `1` e.g. `1`
`per_page`	query	`integer`	optional	Rows per page (1–100). Default: `25` e.g. `25`

Request

cURLPython•JavaScript•PHP•

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

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

**Response 200**`BeneficiaryImportPreviewResponse` — Paginated preview rows with pagination metadata and job snapshot.
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_import_row`. e.g. `beneficiary_import_row`
`id`	`string`	Numeric row ID expressed as a string (JSON:API format). e.g. `123`
`attributes`	`object`	Parsed row fields.
`row_index`	`integer`	Position of the row within the original file, starting at `0`. It allows locating the row in the source document. e.g. `5`
`status`	`string`	Classification bucket — `valid`: Ready for commit; `correctable`: Auto-corrected, confirmable; `fatal`: Uncorrectable error, skipped; `duplicate_account`: Account already registered (reactivated if archived); `duplicate_alias`: Duplicate alias, persisted with suffix. e.g. `valid`
`parsed_account`	`string \| null`nullable	Normalized account number extracted from the file. The job owner can view and edit this value in the preview; `null` when no account could be extracted. e.g. `012180004412345678`
`parsed_account_type`	`string \| null`nullable	Detected account type. `null` when `parsed_account` is null. The types are `clabe`, `card`, and `phone`. e.g. `clabe`
`parsed_bank_code`	`string \| null`nullable	5-digit SPEI code of the resolved bank, derived from `parsed_account`. `null` when it could not be resolved. e.g. `40012`
`parsed_bank_name`	`string \| null`nullable	Resolved name of the receiving bank. `null` when it could not be resolved. e.g. `BBVA MEXICO`
`parsed_label`	`string \| null`nullable	Label/alias extracted from the file or auto-assigned. `null` when no label could be extracted and none was auto-assigned. e.g. `Proveedor ABC`
`error_codes`	`array`	Stable error codes for the row (e.g. `clabe_checksum_failed`, `alias_missing`). Empty for `valid` rows. e.g. `[]`
`corrections_applied`	`object`	Auto-corrections applied by the system to this row (e.g. `{ "alias_auto_assigned": "Proveedor 001" }`). Empty if no corrections were made. e.g. `{}`
`user_overrides`	`object`	Manual user overrides submitted via `PATCH /v1/beneficiaries/imports/{id}/rows/{rowId}`. Take precedence over parsed values during commit. e.g. `{}`
`raw_preview`	`object`	Snippet of the original file for diagnostic purposes. Runs of 13 to 19 digits that are not a CLABE (18 digits) are masked (`••••` plus the last four), as is a 10-digit phone number when a label such as "account" or "phone" precedes it, to prevent PAN exposure in debug payloads. e.g. `{}`
`created_beneficiary_id`	`integer \| null`nullable	ID of the beneficiary record created after commit. `null` until the job completed and this row was persisted. e.g. `null`
`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. `a1b2c3d4e5f66f5e4d3c2b1a`
`datetime`	`object`	Companion descriptor present in the `meta` block of every response (and in the `meta` of outgoing webhook bodies). 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/imports/{id}/preview`
Status	Class	Description	Body
200	`2xx`	Paginated preview rows with pagination metadata and job snapshot.	`BeneficiaryImportPreviewResponse`
401	`4xx`	Authentication is required or the provided credentials are invalid.	`ErrorResponse`
403	`4xx`	Insufficient permissions.	`ErrorResponse`
404	`4xx`	The resource does not exist or is not visible to the client	`Error`

**Errors from `GET /v1/beneficiaries/imports/{id}/preview`**
Status	Code	Example
401	`unauthorized`	Invalid or missing authentication credentials. Envelope meta.request_id `c4d5e6f7a8b99b8a7f6e5d4c`
403	`permission_denied`	You do not have permission to access this resource. Envelope meta.request_id `d5e6f7a8b9c00c9b8a7f6e5d`