OcrValidationRequest
Parameters for validating a SPEI transfer from a receipt image (OCR). At least one of `image` or `image_url` must be provided; if both are omitted the server returns 422.
Properties
| Field | Type | Description |
|---|---|---|
image | string (byte) | Receipt image encoded in base64 (JPEG, PNG, or WebP). Maximum size: 12 MB. Maximum dimensions: 12,000 px per side. Mutually exclusive with `image_url`; if both are provided, `image` takes precedence. |
image_url | string (uri) | Public HTTPS URL of the receipt image. The server downloads the image on receipt and persists it the same way as the `image` flow. Same format and size limits apply (JPEG, PNG, or WebP, maximum 12 MB). |
cuenta_beneficiaria | string | Optional hint for the beneficiary account: 18-digit CLABE, 13-19 digit card, or 10-digit DiMo phone, auto-detected by length. Used to disambiguate when OCR extracts a partial or masked number from the receipt. |
banco_emisor | string | Optional sender bank override. Accepted only when the value is a 4-5 digit numeric Banxico participant code. Textual values are ignored — OCR-extracted text is trusted over the client hint. |
banco_receptor | string | Optional receiver bank override. Accepted only when the value is a 4-5 digit numeric Banxico participant code. Textual values are ignored. Useful when OCR could not derive the receiving bank or the client knows the exact Banxico code. |
retry_policy | object | Automatic retry policy for this validation. If omitted, the policy configured at `PUT /v1/users/me/retry-policy` is used. Retries do not consume validation quota. |
enabled | boolean | Enables or disables the retry cycle for this validation. If `false`, the other fields are ignored. |
max_retries | integer | Maximum number of automatic retries. Once reached, the cycle enters the `exhausted` terminal state. The upper bound depends on the plan (`retry_max_retries`) or the global default `max_retries_cap` (typically 5–10). |
interval_seconds | integer | Seconds to wait between each retry (300–86400, i.e., 5 minutes to 24 hours). |
outcomes | array | Validation outcomes that trigger a retry. By default the cycle activates on `not_found`, `cep_unavailable` and `error`; clients that do not want to retry Banxico HTTP 5xx errors can send `["not_found", "cep_unavailable"]`. |
Variants
anyOf
-
object -
object
Used in operations
POST /v1/validate-ocr