BeneficiaryImportPreviewResponse
Response from `GET /v1/beneficiaries/imports/{id}/preview`. Paginated parsed rows with a job snapshot in `meta`. 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).
Properties
| 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`). |
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 | 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 | Detected account type. `null` if `parsed_account` is null. The types are `clabe`, `card`, and `phone`. |
parsed_bank_code | string | null | 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 | Resolved name of the receiving bank. `null` if it could not be resolved. |
parsed_label | string | null | 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 | ID of the beneficiary record created after commit. `null` until the job completed and this row was persisted. |
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. |
api_version | string | API route prefix version (e.g. `v1`). |
request_id | string | Unique request identifier (hex). |
datetime | object | Companion descriptor present in every response's meta block (and in outgoing webhook payloads). Lets clients assert the timezone contract without re-reading the spec. |
timezone* | string | Always `UTC` — the canonical timezone for every datetime field in the body. |
format* | string | Always `ISO 8601` — explicit `Z` suffix on every datetime. |
links | object | Pagination or related links, present only when the endpoint returns a paginated collection. |
Used in operations
GET /v1/beneficiaries/imports/{id}/preview