← Volver al índice de esquemas
ValidateAccountResponse
Respuesta de `GET /v1/beneficiaries/validate-account?account=`. Resultado estructural de un número de cuenta. Bajo `data.attributes` se reporta el tipo detectado, el checksum, los metadatos del banco resuelto (cuando se puede) y, para CLABEs parciales de 17 dígitos, la versión auto-completada. Este endpoint **no** consulta Banxico — solo validación local.
Propiedades
| Campo | Tipo | Descripción |
|---|---|---|
data | object | Payload principal de la respuesta. La forma varía según el endpoint (objeto, array, o envelope JSON:API con `type`, `id`, `attributes`). |
type* | string | Tipo del recurso JSON:API. Siempre `account_validation`. |
attributes* | object | Resultado de la validación estructural. |
input* | string | Texto recibido (sin normalizar). |
length* | integer | Longitud en dígitos del input normalizado. |
is_numeric* | boolean | `true` cuando el input original contenía únicamente dígitos (sin separadores). |
account_type* | string | Tipo de cuenta detectado por longitud, o `unknown` para entradas fuera de rango. Los tipos reconocidos son `clabe`, `card` y `phone`. |
is_complete* | boolean | `true` cuando el input está completo para su tipo (18 dígitos en CLABE, 16 en tarjeta, 10 en celular). |
checksum_valid* | boolean | `true` cuando el dígito de control de la CLABE o el Luhn de la tarjeta es válido. Para celular siempre `false` (no aplica). |
computed_control_digit | string | null | Dígito de control CLABE calculado a partir de los primeros 17 dígitos. `null` cuando el tipo no es CLABE o el cálculo no es aplicable. |
auto_completed | string | null | CLABE de 18 dígitos auto-completada cuando el input venía con 17 dígitos y el control pudo calcularse. `null` en los demás casos. |
bank | object | null | Metadatos del banco resuelto, o `null` cuando no se pudo identificar. Se deriva del prefijo o BIN. |
banxico_code | string | null | Código SPEI de 5 dígitos (cuando el banco está mapeado). |
name | string | Nombre oficial del banco resuelto. |
card | object | null | Metadatos adicionales del BIN cuando `account_type=card` y hubo coincidencia en el directorio. `null` en cualquier otro caso. |
bin | string | Prefijo BIN consultado. |
brand | string | null | Marca de la tarjeta (Visa, Mastercard, etc.). |
type | string | null | Tipo de tarjeta (`debit`, `credit`, etc.). |
level | string | null | Nivel de la tarjeta (`classic`, `gold`, etc.). |
country_iso | string | null | ISO 3166-1 alpha-2 del país emisor. |
meta | object | Metadatos de la respuesta, incluyendo versión de la API, prefijo de ruta, identificador único de la petición y marca temporal del servidor en UTC. |
version | string | Versión de la API que procesó la petición. |
api_version | string | Versión del prefijo de ruta de la API (ej. `v1`). |
request_id | string | Identificador único de la petición (hex). |
datetime | object | Descriptor compañero presente en el bloque `meta` de cada respuesta (y en el `meta` del cuerpo de los webhooks salientes). Permite a los clientes afirmar el contrato de zona horaria sin releer el spec. |
timezone* | string | Siempre `UTC` — la zona canónica para cada campo datetime del cuerpo. |
format* | string | Siempre `ISO 8601` — sufijo `Z` explícito en cada datetime. |
links | object | Enlaces de paginación o relacionados, presentes solo cuando el endpoint devuelve una colección paginada. |
Usado en operaciones
GET /v1/beneficiaries/validate-account