> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.omni-ward.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Status e erros

> A validação vale para a requisição inteira; a execução, para cada serviço.

## Erros de validação (HTTP 422)

Se algum serviço não puder ser executado, nada é consultado nem cobrado. `details.results` lista só os serviços com problema:

```json theme={null}
{
  "error": {
    "code": "validation_failed",
    "message": "Alguns serviços não podem ser executados. Nada foi consultado nem cobrado.",
    "correlationId": "4f1c9a7e-2b1d-4c55-9a51-0d2f6f1c2a10",
    "details": {
      "results": [
        {
          "service": "SERVICE_RFB_PF",
          "status": { "code": 422, "message": "Validation failed" },
          "result": null,
          "errors": [{ "field": "cpf", "code": "required", "message": "Informe CPF: este serviço exige o campo." }]
        }
      ]
    }
  }
}
```

| `errors[].code` | Significado | O que fazer |
| - | - | - |
| `required` | Campo obrigatório ausente ou vazio | Envie o campo indicado em `field` |
| `invalid` | Formato inválido, como CPF com dígito errado | Corrija o valor |
| `unknown_service` | Alias desconhecido | Confira o alias no catálogo |
| `duplicate_service` | O mesmo alias apareceu duas vezes | Remova a repetição |
| `purpose_required` | O serviço trata dados pessoais | Envie `purpose` |
| `product_not_activated` | Produto não ativado | Ative no Marketplace do console |
| `production_not_approved` | Produção não liberada | Solicite em Configurações |
| `no_eligible_provider` | Serviço indisponível neste ambiente | Tente no sandbox ou fale com o suporte |
| `price_not_defined` | Serviço sob consulta | Fale com o comercial |

## Outros erros da requisição

| HTTP | `error.code` | Significado |
| - | - | - |
| 401 | `invalid_api_key` | Chave ausente, inválida ou revogada |
| 402 | `insufficient_credits` | O saldo não cobre todos os serviços. Nada foi executado |
| 403 | `insufficient_scope` | A chave não tem `capabilities:execute` |
| 422 | `idempotency_mismatch` | `Idempotency-Key` repetida com outro corpo |
| 429 | `rate_limited` | Limite de taxa; respeite `Retry-After` |

## Falhas por serviço (HTTP 200)

| `results[].status.code` | Significado | Cobrado? |
| - | - | - |
| 200 | Consulta feita | Sim |
| 422 | A fonte recusou o dado enviado | Não |
| 502 | A fonte de dados falhou | Não |
| 503 | Fonte indisponível no momento | Não |

Informe o `correlationId` ao suporte quando precisar de ajuda.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.