LookupBeneficiaryAccountResponse
Response from `GET /v1/beneficiaries/lookup?account=`. Returns the beneficiary metadata when the exact account number exists in the authenticated user's whitelist.
Properties
| Field | Type | Description |
|---|---|---|
data | object | 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_lookup`. |
attributes* | object | Resolved account metadata. |
account_number* | string | Queried account number (CLABE, card, or phone). |
account_type* | string | Account type auto-detected at registration. `clabe` — 18-digit CLABE; `card` — 16-digit card; `phone` — 10-digit phone. |
bank_code* | string | 5-digit Banxico SPEI code of the receiving bank. |
bank_name* | string | Resolved bank name. |
label | string | null | Free-form label, `null` if none was assigned. |
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/lookup