← Back to schema index

PatchBeneficiaryImportRowResponse

Response for `PATCH /v1/beneficiaries/imports/{id}/rows/{row_id}`: the row once corrected and reprocessed. Its classification group (`status`) may have changed with the correction.

Properties

FieldTypeDescription
dataobjectMain response payload. Shape varies by endpoint (object, array, or JSON:API envelope with `type`, `id`, `attributes`).
typestringJSON:API resource type. Always `beneficiary_import_row`.
idstringNumeric row ID expressed as a string (JSON:API format).
attributesobjectParsed row fields.
row_indexintegerPosition of the row within the original file, starting at `0`. It allows locating the row in the source document.
statusstringClassification 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_accountstring | nullNormalized 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.
parsed_account_typestring | nullDetected account type. `null` when `parsed_account` is null. The types are `clabe`, `card`, and `phone`.
parsed_bank_codestring | null5-digit SPEI code of the resolved bank, derived from `parsed_account`. `null` when it could not be resolved.
parsed_bank_namestring | nullResolved name of the receiving bank. `null` when it could not be resolved.
parsed_labelstring | nullLabel/alias extracted from the file or auto-assigned. `null` when no label could be extracted and none was auto-assigned.
error_codesarrayStable error codes for the row (e.g. `clabe_checksum_failed`, `alias_missing`). Empty for `valid` rows.
corrections_appliedobjectAuto-corrections applied by the system to this row (e.g. `{ "alias_auto_assigned": "Proveedor 001" }`). Empty if no corrections were made.
user_overridesobjectManual user overrides submitted via `PATCH /v1/beneficiaries/imports/{id}/rows/{rowId}`. Take precedence over parsed values during commit.
raw_previewobjectSnippet 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.
created_beneficiary_idinteger | nullID of the beneficiary record created after commit. `null` until the job completed and this row was persisted.
metaobjectResponse metadata including API version, route prefix, unique request identifier, and the server timestamp in UTC.
versionstringAPI version that processed the request.
api_versionstringAPI route prefix version (e.g. `v1`).
request_idstringUnique request identifier (hex).
datetimeobjectCompanion 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.
timezone*stringAlways `UTC`: The canonical timezone for every datetime field in the body.
format*stringAlways `ISO 8601`: Explicit `Z` suffix on every datetime.
linksobjectPagination or related links, present only when the endpoint returns a paginated collection.

Used in operations

  • PATCH /v1/beneficiaries/imports/{id}/rows/{row_id}