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

# Lista de erros do Matcher

> Os códigos de erro das APIs do Matcher e o status HTTP de cada um, para você diagnosticar problemas e encaminhá-los à equipe certa.

### Formato do erro

```json JSON theme={null}
{
   "type": "https://errors.lerian.studio/v1/<error_code>",
   "title": "<error_title>",
   "status": 400,
   "detail": "<error_detail>",
   "code": "<error_code>"
}
```

### Definições dos campos

* **`type`** – Uma URI que identifica o erro, montada como `https://errors.lerian.studio/v1/<code>`.
* **`title`** – O texto do status HTTP (por exemplo, `Bad Request`).
* **`status`** – O código de status HTTP.
* **`detail`** – Uma descrição curta desta ocorrência do erro. Use `code` para tratamento programático.
* **`code`** – Um código de produto estável que identifica o erro de forma exclusiva (por exemplo, `MTCH-0001`). Útil para tratamento programático e solicitações de suporte.
* **`errors`** – *(opcional)* Uma lista com detalhes de validação em nível de campo.

### Detalhes de erro em nível de campo

Quando a requisição falha na validação de schema, o Matcher retorna `422 Unprocessable Entity` com um array `errors` e sem `code`.

Exemplos:

```json Example 1 theme={null}
{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "validation failed",
  "errors": [
    { "message": "expected required property name to be present", "location": "body" }
  ]
}
```

```json Example 2 theme={null}
{
  "type": "https://errors.lerian.studio/v1/MTCH-0005",
  "title": "Not Found",
  "status": 404,
  "detail": "No reconciliation context matches this id; check the context id and try again.",
  "code": "MTCH-0005"
}
```

## Erros gerais

***

Esses erros se aplicam a todos os endpoints da API do Matcher.

**400**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0001` | Bad Request | O corpo da requisição é inválido ou malformado. Verifique o formato da requisição e tente novamente. |
| `MTCH-0013` | Bad Request | O ID do contexto é inválido. Verifique o formato do ID e tente novamente. |

**403**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0004` | Forbidden | Você não tem permissão para executar esta ação. Verifique seu nível de acesso. |
| `MTCH-0012` | Forbidden | O contexto de conciliação não está ativo. Ative o contexto antes de executar esta operação. |

**404**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0005` | Not Found | O recurso solicitado não existe. Verifique o ID e tente novamente. |

**409**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0007` | Conflict | A requisição está em conflito com o estado atual do recurso. Verifique e tente novamente. |

**413**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0010` | Request Entity Too Large | O arquivo enviado excede o tamanho máximo permitido. Reduza o tamanho do arquivo e tente novamente. |

**422**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0006` | Unprocessable Entity | A requisição estava bem formada, mas não pôde ser processada. Verifique os dados informados e tente novamente. |

**500**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0002` | Internal Server Error | Ocorreu um erro inesperado. O `detail` é `internal error`. |

**503**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0008` | Service Unavailable | Um serviço necessário está temporariamente indisponível. Tente novamente mais tarde. |
| `MTCH-0019` | Service Unavailable | O armazenamento de objetos está temporariamente indisponível. Tente novamente mais tarde. |

## Erros de configuração

***

O Matcher retorna esses erros para um problema na configuração de conciliação (contextos, fontes, mapas de campo, regras de correspondência, regras de tarifa, agendamentos).

**400**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0109` | Bad Request | Um nome de contexto é obrigatório. Informe um nome válido e tente novamente. |

**404**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0111` | Not Found | A fonte especificada não foi encontrada. Verifique o ID da fonte e tente novamente. |
| `MTCH-0112` | Not Found | O mapa de campo especificado não foi encontrado. Verifique o ID do mapa de campo e tente novamente. |
| `MTCH-0113` | Not Found | A regra de correspondência especificada não foi encontrada. Verifique o ID da regra de correspondência e tente novamente. |
| `MTCH-0114` | Not Found | A regra de tarifa especificada não foi encontrada. Verifique o ID da regra de tarifa e tente novamente. |
| `MTCH-0115` | Not Found | O agendamento de tarifa especificado não foi encontrado. Verifique o ID do agendamento de tarifa e tente novamente. |
| `MTCH-0116` | Not Found | O agendamento especificado não foi encontrado. Verifique o ID do agendamento e tente novamente. |

**409**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0101` | Conflict | Já existe um contexto com esse nome. Escolha um nome diferente e tente novamente. |
| `MTCH-0102` | Conflict | Já existe um recurso com essa prioridade. Escolha um valor de prioridade diferente e tente novamente. |
| `MTCH-0103` | Conflict | O recurso está em um estado inválido para esta operação. Verifique o estado atual e tente novamente. |
| `MTCH-0104` | Conflict | O contexto foi arquivado. Use um contexto ativo para esta operação. |
| `MTCH-0107` | Conflict | Já existe um recurso com essa prioridade. Escolha um valor de prioridade diferente. |
| `MTCH-0108` | Conflict | O agendamento de tarifa está em uso e não pode ser excluído. |
| `MTCH-0118` | Conflict | A regra de correspondência não pode ser excluída porque um grupo de correspondência confirmado que ela criou ainda tem uma exceção. Altere a configuração da regra em vez disso. |

## Erros de descoberta

***

O Matcher retorna esses erros para a descoberta de fontes de dados e o gerenciamento de conexões. A descoberta depende do mecanismo de extração embutido do Matcher. Veja [Discovery](https://docs.lerian.studio/pt/products/matcher/integrations/matcher-discovery.md) para saber como funciona.

**400**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0204` | Bad Request | A requisição de extração é inválida. Verifique os parâmetros e tente novamente. |
| `MTCH-0208` | Bad Request | O tipo de conector especificado não está registrado neste deploy. Verifique o tipo de conector e tente novamente. |

**404**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0201` | Not Found | A conexão especificada não foi encontrada. Verifique o ID da conexão e tente novamente. |
| `MTCH-0202` | Not Found | A extração especificada não foi encontrada. Verifique o ID da extração e tente novamente. |

**409**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0205` | Conflict | Uma atualização de descoberta já está em andamento. Aguarde a conclusão antes de iniciar uma nova. |
| `MTCH-0209` | Conflict | O Matcher retirou a conexão, mas não conseguiu confirmar a exclusão no sistema externo. Verifique no sistema externo se uma conexão ainda pode estar ativa. |

**422**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0210` | Unprocessable Entity | O Matcher não consegue executar testes de conectividade para este fornecedor agregador. Nenhum teste foi executado e nada mudou. |
| `MTCH-0211` | Unprocessable Entity | A conexão de agregador ainda não está vinculada a uma conta. O Matcher não executou o teste. Conclua o fluxo de consentimento hospedado e tente novamente. |
| `MTCH-0212` | Unprocessable Entity | O fornecedor agregador não emitiu um token de consentimento, e nada mudou. Teste a conexão e tente novamente. |
| `MTCH-0213` | Unprocessable Entity | O Matcher não consegue abrir um fluxo de consentimento hospedado para este fornecedor agregador, e nada mudou. Entre em contato com o suporte se você precisar do fluxo de consentimento para este fornecedor. |

**503**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0203` | Service Unavailable | O motor de extração está temporariamente indisponível. Tente novamente mais tarde. |

## Erros de ingestão

***

O Matcher retorna esses erros para o envio e o processamento de arquivos de transação.

**400**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0303` | Bad Request | O formato do arquivo é obrigatório. Especifique o formato e tente novamente. |
| `MTCH-0304` | Bad Request | O arquivo enviado está vazio. Forneça um arquivo não vazio e tente novamente. |
| `MTCH-0307` | Bad Request | O arquivo estava bem formado, mas não continha elementos de registro para ingestão. Verifique o conteúdo do arquivo e tente novamente. |
| `MTCH-0308` | Bad Request | O esquema do arquivo enviado não é compatível. Verifique a estrutura do arquivo e tente novamente. |
| `MTCH-0317` | Bad Request | Uma amostra de mapeamento é obrigatória. Forneça uma amostra e tente novamente. |
| `MTCH-0322` | Bad Request | O corpo do documento está vazio. Forneça um documento não vazio e tente novamente. |

**403**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0319` | Forbidden | A extração de documentos não está habilitada. Entre em contato com o suporte para ativar o recurso. |

**404**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0301` | Not Found | A fonte de ingestão especificada não foi encontrada. Verifique o ID da fonte e tente novamente. |
| `MTCH-0302` | Not Found | O mapa de campo de ingestão especificado não foi encontrado. Verifique o ID do mapa de campo e tente novamente. |
| `MTCH-0306` | Not Found | O job de ingestão especificado não foi encontrado. Verifique o ID do job e tente novamente. |

**408**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0311` | Request Timeout | O envio parou porque nenhum dado foi recebido dentro do tempo permitido. Tente enviar novamente. |

**409**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0305` | Conflict | O job de ingestão está em um estado inválido para esta operação. Verifique o estado atual. |
| `MTCH-0324` | Conflict | A revisão de extração não está mais pendente e não pode ser modificada. Verifique o estado atual. |

**422**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0309` | Unprocessable Entity | O job de ingestão excedeu o limite configurado de taxa de erro. Revise os dados de origem e tente novamente. |
| `MTCH-0310` | Unprocessable Entity | A configuração da fonte é inválida. Corrija a configuração da fonte e tente enviar novamente. |
| `MTCH-0312` | Unprocessable Entity | O mapa de campo da fonte é inválido. Corrija o mapa de campo e tente enviar novamente. |
| `MTCH-0321` | Unprocessable Entity | Nenhum candidato a transação pôde ser extraído do documento. Verifique o documento e tente novamente. |

**503**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0313` | Service Unavailable | A busca e ingestão automática não está habilitada neste deploy. Envie o arquivo manualmente. |
| `MTCH-0314` | Service Unavailable | Não foi possível acessar ou ler o transporte externo. Tente novamente mais tarde. |
| `MTCH-0315` | Service Unavailable | A proposta de mapeamento não está habilitada neste deploy. Configure o mapa de campo manualmente. |
| `MTCH-0316` | Service Unavailable | O assistente de mapeamento está indisponível. Configure um mapa de campo manualmente. |
| `MTCH-0318` | Service Unavailable | A extração de documentos não está habilitada neste deploy. Faça a ingestão do arquivo manualmente. |
| `MTCH-0320` | Service Unavailable | O extrator de documentos está indisponível. Faça a ingestão do arquivo manualmente. |
| `MTCH-0323` | Service Unavailable | A revisão de extração não está habilitada neste deploy. Tente novamente mais tarde. |

## Erros de correspondência

***

O Matcher retorna esses erros para o processo de correspondência da conciliação.

**400**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0401` | Bad Request | Nenhuma fonte está configurada para este contexto. Configure pelo menos uma fonte antes de rodar uma correspondência. |
| `MTCH-0402` | Bad Request | São necessárias pelo menos duas fontes para a correspondência. Configure fontes adicionais. |
| `MTCH-0403` | Bad Request | Cada fonte deve ter um lado definido. Especifique o lado da fonte e tente novamente. |
| `MTCH-0404` | Bad Request | A configuração de topologia um-para-um é inválida. Verifique a configuração da fonte. |
| `MTCH-0405` | Bad Request | A configuração de topologia um-para-muitos é inválida. Verifique a configuração da fonte. |

**403**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0409` | Forbidden | A sugestão de regras não está habilitada. Entre em contato com o suporte para ativar o recurso. |

**409**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0408` | Conflict | Uma execução de correspondência já está em andamento para este contexto. Aguarde a conclusão. |
| `MTCH-0413` | Conflict | A sugestão não está mais pendente e não pode ser modificada. Verifique o estado atual. |

**422**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0406` | Unprocessable Entity | As regras de tarifa são obrigatórias, mas não estão configuradas. Adicione regras de tarifa antes de rodar uma correspondência. |
| `MTCH-0407` | Unprocessable Entity | As regras de tarifa estão configuradas incorretamente. Revise as configurações das regras de tarifa e tente novamente. |
| `MTCH-0412` | Unprocessable Entity | A sugestão aprovada falhou na validação. Revise a sugestão e tente novamente. |

**503**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0410` | Service Unavailable | A sugestão de regras não está habilitada neste deploy. Crie as regras de correspondência manualmente. |
| `MTCH-0411` | Service Unavailable | O assistente de regras está indisponível. Crie as regras de correspondência manualmente. |

## Erros de exceção

***

O Matcher retorna esses erros para o tratamento de exceções, disputas e processamento de callbacks.

**404**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0501` | Not Found | A exceção especificada não foi encontrada. Verifique o ID da exceção e tente novamente. |
| `MTCH-0502` | Not Found | A disputa especificada não foi encontrada. Verifique o ID da disputa e tente novamente. |
| `MTCH-0507` | Not Found | O comentário especificado não foi encontrado. Verifique o ID do comentário e tente novamente. |
| `MTCH-0512` | Not Found | O Matcher aplicou a resolução, mas não conseguiu confirmar o registro atualizado da exceção. Recarregue a exceção para ver o status atual. |

**409**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0504` | Conflict | Um callback para esta exceção já está sendo processado. Aguarde a conclusão. |
| `MTCH-0505` | Conflict | O callback encontrou um erro temporário e pode ser tentado novamente. Tente a requisição novamente. |
| `MTCH-0510` | Conflict | Uma liquidação já está em andamento nesta exceção. Tente a requisição novamente em instantes. |
| `MTCH-0511` | Conflict | A exceção já está resolvida, ou uma resolução está em andamento. Revise os detalhes da resolução. |

**422**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0503` | Unprocessable Entity | A exceção está em um estado inválido para esta operação. Verifique o estado atual. |
| `MTCH-0508` | Unprocessable Entity | O tipo de destino do despacho não é compatível. Verifique a configuração do destino. |
| `MTCH-0509` | Unprocessable Entity | O conector de despacho não está configurado. Configure o conector e tente novamente. |

**429**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0506` | Too Many Requests | O limite de taxa de callbacks foi excedido. Aguarde antes de tentar novamente. |

## Erros de governança

***

As operações de trilha de auditoria e governança retornam os erros gerais, como `MTCH-0005` quando uma trilha de auditoria, um mapeamento de ator ou um arquivo morto não existe.

## Erros de relatórios

***

As operações de exportação de relatórios retornam os erros gerais. Um job de exportação que não existe retorna `MTCH-0005`, um job que ainda não está pronto para download ou que já terminou retorna `MTCH-0007`, um worker de exportação desabilitado retorna `MTCH-0702` e um armazenamento de objetos indisponível retorna `MTCH-0019`. Um arquivo de exportação expirado retorna `410` sem `code`.

## Erros de limite de requisições

***

O Matcher limita quantas requisições cada chamador pode enviar em uma janela de tempo. Uma requisição acima do limite retorna `429` antes de chegar à operação, com um corpo plano em que `code` é o número `429`. O header `Retry-After` informa quantos segundos você deve esperar antes de tentar novamente.

```json theme={null}
{
  "code": 429,
  "title": "rate_limit_exceeded",
  "message": "rate limit exceeded"
}
```

Quando o Matcher não consegue acessar o armazenamento que conta as requisições, ele rejeita a requisição com `503` e um corpo plano com o mesmo formato:

```json theme={null}
{
  "code": 503,
  "title": "service_unavailable",
  "message": "rate limiter temporarily unavailable"
}
```

## Erros de autenticação

***

O Access Manager verifica o token e as permissões de quem chama. Uma recusa dessa verificação não é um objeto problem e não traz código `MTCH`. Quando o Access Manager não responde, o Matcher responde `503`.

**401**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0003` | Unauthorized | A requisição não pôde ser autenticada. Verifique suas credenciais e tente novamente. |

**403**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0004` | Forbidden | O token não identifica um tenant. Verifique seu nível de acesso. |

## Erros de idempotência

***

O Matcher retorna esses erros para um problema no tratamento da chave de idempotência.

**400**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0015` | Bad Request | A chave de idempotência deve conter de 1 a 128 letras, dígitos, hifens, sublinhados ou dois-pontos; nenhuma requisição foi processada. |

**409**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0018` | Conflict | Uma requisição com esta chave de idempotência já está sendo processada. Aguarde a conclusão e tente novamente com a mesma chave; a requisição original ainda pode ser bem-sucedida. |

**500**

| `code` | `title` | Descrição |
| - | - | - |
| `MTCH-0016` | Internal Server Error | Ocorreu um erro inesperado. |
| `MTCH-0017` | Internal Server Error | O processamento de idempotência está temporariamente indisponível; tente a mesma requisição novamente mais tarde, com a mesma chave de idempotência. Se a falha persistir, peça a um administrador para verificar o armazenamento de idempotência. |


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