LookupBeneficiaryAccountResponse
Response for `GET /v1/beneficiaries/lookup`: the beneficiary metadata when the queried account is among the authenticated user’s own.
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 | Account number the lookup was made with, whether CLABE, card, or DiMo 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 | SPEI code (5 digits) of the resolved bank. It is the empty string (`""`) for a card whose BIN is not in the directory. |
bank_name* | string | Official name of the bank, resolved from its `bank_code`. |
label | string | null | Free-form label, `null` when 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 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* | 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