https://api.veriko.mx/v1/beneficiaries/imports/{id}/preview Preview extracted rows from import
How-to guide →Returns rows extracted from the file, paginated and filterable by bucket. CLABEs and phones are shown in full to the job owner; cards are also returned in full in the owner's view (the cross-user admin view masks them). Available only when the job is in preview_ready or later states with total_rows>0.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id * | path | integer | required | Numeric ID of the import job. |
buckets[] | query | array<string> | optional | Filter by one or more buckets. Without this parameter all rows are returned. Values outside the enum are silently dropped. |
page | query | integer | optional | Page number (1-based). Default: |
per_page | query | integer | optional | Rows per page (1–100). Default: |
curl -X GET 'https://api.veriko.mx/v1/beneficiaries/imports/{id}/preview' \
-H 'Authorization: Bearer mxcep_••••'
Python example — coming soon.
JavaScript example — coming soon.
PHP example — coming soon.
| Field | Type | Description |
|---|---|---|
type | string | JSON:API resource type (always `beneficiary_import_row`). |
id | string | Numeric row ID expressed as a string (JSON:API format). |
attributes | object | Parsed row fields. |
row_index | integer | 0-based position of the row in the original file. Allows the user to locate the row in the source document. |
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. |
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` if no account could be extracted. |
parsed_account_type | string | null nullable | Detected account type. `null` if `parsed_account` is null. |
parsed_bank_code | string | null nullable | 5-digit Banxico code of the receiving bank derived from the parsed account. `null` if it could not be resolved. |
parsed_bank_name | string | null nullable | Resolved name of the receiving bank. `null` if it could not be resolved. |
parsed_label | string | null nullable | Label/alias extracted from the file or auto-assigned. `null` if no label could be extracted and none was auto-assigned. |
error_codes | array | Stable error codes for the row (e.g. `clabe_checksum_failed`, `alias_missing`). Empty for `valid` rows. |
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. |
user_overrides | object | Manual user overrides submitted via `PATCH /v1/beneficiaries/imports/{id}/rows/{rowId}`. Take precedence over parsed values during commit. |
raw_preview | object | Snippet of the original file for diagnostic purposes. Sequences of 6 or more consecutive digits are masked (`••••`) to prevent PAN exposure in debug payloads. |
created_beneficiary_id | integer | null nullable | ID of the beneficiary record created after commit. `null` until the job completed and this row was persisted. |
| 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 | Permisos insuficientes | ErrorResponse |
| 404 | 4xx | The resource does not exist or is not visible to the caller | Error |
| Status | Code | Detail |
|---|---|---|
| 401 | unauthorized | Invalid or missing authentication credentials. Envelope
|
| 403 | forbidden | You do not have permission to access this resource. Envelope
|