← Volver al índice de esquemas
OcrValidationRequest
Parámetros para validar una transferencia SPEI a partir de la imagen de un comprobante (OCR). Debe enviarse al menos uno de `image` o `image_url`; si ambos se omiten el servidor devuelve 422.
Propiedades
| Campo | Tipo | Descripción |
|---|---|---|
image | string (byte) | Imagen del comprobante codificada en base64 (JPEG, PNG o WebP). Tamaño máximo: 12 MB. Dimensiones máximas: 12 000 px por lado. Mutuamente excluyente con `image_url`; si ambos se envían, `image` tiene precedencia. |
image_url | string (uri) | URL pública HTTPS de la imagen del comprobante. El servidor descarga la imagen al recibir la petición y la persiste igual que en el flujo `image`. Tamaño y formato idénticos (JPEG, PNG o WebP, máximo 12 MB). |
cuenta_beneficiaria | string | Pista opcional de la cuenta beneficiaria: CLABE (18 dígitos), tarjeta (16 dígitos) o celular DiMo (10 dígitos), autodetectada por longitud. Se usa para desambiguar cuando el OCR extrae un número parcial o enmascarado del comprobante. |
retry_policy | object | Política de reintentos automáticos para esta validación. Si se omite, se aplica la política configurada en `PUT /v1/users/me/retry-policy`. Los reintentos no consumen cuota de validaciones. |
enabled | boolean | Activa o desactiva el ciclo de reintentos para esta validación. Si es `false`, los demás campos se ignoran. |
max_retries | integer | Número máximo de reintentos automáticos. Una vez alcanzado, el ciclo pasa al estado terminal `exhausted`. El tope superior depende del plan (`retry_max_retries`) o del default global `max_retries_cap` (típicamente 5–10). |
interval_seconds | integer | Segundos de espera entre cada reintento (300–86400, es decir, 5 minutos a 24 horas). |
outcomes | array | Resultados de validación que habilitan un reintento. Por defecto el ciclo se activa con `not_found`, `cep_unavailable` y `error`; los clientes que no quieran reintentar errores Banxico HTTP 5xx pueden enviar `["not_found", "cep_unavailable"]`. |
Variantes
Debe incluir al menos uno de estos campos:
imageimage_url
Usado en operaciones
POST /v1/validate-ocr