PATCH https://api.veriko.mx/v1/beneficiaries/imports/{id}/rows/{row_id}

Edit a preview row

Audience
public
Auth
API key
Permission
beneficiaries:create
How-to guide →

Persists a user override on a preview row before confirming the import. Accepts JSON:API envelope or a flat object. All attributes are optional; only those present are overwritten. Five editable fields: parsed_account, parsed_label, parsed_account_type, parsed_bank_code, parsed_bank_name. After persisting the override the server re-processes the row (re-derives bank from the new CLABE prefix / BIN) so job counters and the preview's Bank column stay in sync without waiting for commit. Only valid when the job is in preview_ready state — other states return 422 job_not_editable.

Parameters
Parameter In Type Required Description
id * path integer required

Numeric ID of the import job.

row_id * path integer required

Numeric row ID within the job.

Parameters
Parameter Type Required Description
parsed_account string (pattern, ?–32) optional

User-corrected account number. Accepts up to 32 characters of digits, spaces, hyphens and non-breaking spaces (NBSP). The `RowProcessor` re-normalizes during re-processing.

e.g. 012180004412345678
parsed_label string (?–100) optional

Corrected label. Sanitized before storage (an anti-formula-injection escape is applied to the leading character when it is one of `=+-@\t\r`).

e.g. Mamá
parsed_account_type string (enum) optional

Corrected account type. If the client sends a value outside the enum, the server responds `422 invalid_account_type`.

e.g. clabe
parsed_bank_code string (pattern) optional

Corrected Banxico SPEI code (4–5 digits). Useful for `phone` rows that need bank reassignment. For CLABE/card the RowProcessor overrides it on re-derivation.

e.g. 40012
parsed_bank_name string (?–50) optional

Corrected bank name. May be overridden by the RowProcessor during re-derivation.

e.g. BBVA MEXICO
Request
curl -X PATCH 'https://api.veriko.mx/v1/beneficiaries/imports/{id}/rows/{row_id}' \
  -H 'Authorization: Bearer mxcep_••••' \
  -H 'Content-Type: application/json' \
  -d '{
    "parsed_account": "0121-8000-4412-3456-78"
  }'

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

Response 200 PatchBeneficiaryImportRowResponse — Row updated with the override applied and re-processed.
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.

Response status codes PATCH /v1/beneficiaries/imports/{id}/rows/{row_id}
Status Class Description Body
200 2xx Row updated with the override applied and re-processed. PatchBeneficiaryImportRowResponse
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
422 4xx Validation failed or job is not editable. Codes: `invalid_account` (pattern violation), `invalid_account_type`, `invalid_bank_code`, `no_valid_fields`, `job_not_editable`. ErrorResponse
Errors from PATCH /v1/beneficiaries/imports/{id}/rows/{row_id}
Status Code Detail
401 unauthorized

Invalid or missing authentication credentials.

Envelope
meta.request_id
c4d5e6f7a8b9
403 forbidden

You do not have permission to access this resource.

Envelope
meta.request_id
d5e6f7a8b9c0
422 invalid_account_type

parsed_account_type must be clabe, card, or phone.

Envelope
meta.request_id
e3f4a5b6c7d8
422 job_not_editable

Job is not in preview_ready state.

Envelope
meta.request_id
d2e3f4a5b6c7