Lista de erros do BC Correios

Formato de erro As operações do Lerian BC Correios retornam erros como problem details da RFC 9457, com o media type application/problem+json:

{
  "code": "BCC-0005",
  "correlationId": "req-7a3f9c2e",
  "detail": "Mail not found or access denied",
  "status": 404,
  "title": "Not Found",
  "type": "https://errors.lerian.studio/v1/BCC-0005"
}

Definições de campo

type – Um URI que identifica o erro no catálogo de erros da Lerian, construído como https://errors.lerian.studio/v1/<code>.
title – O texto do status HTTP (por exemplo, Not Found).
status – O código de status HTTP.
detail – Uma explicação legível dessa ocorrência. Para respostas 5xx, o detail traz internal error. Decida com base em code. O detail de BCC-2009, BCC-2010 e BCC-2011 está em português.
code – Um identificador estável para o erro. Decida com base nesse campo. As tabelas abaixo listam os códigos BCC-NNNN e o código nomeado BANDWIDTH_LIMIT_EXCEEDED. Dois erros podem compartilhar um status e ainda assim diferir aqui. BCC-0006 e BCC-2010 respondem 409. O code diz qual dos dois você recebeu.
errors – Lista opcional de detalhes de erro individuais, cada um com uma location, uma message e um value.
correlationId – O identificador de correlação da requisição.

Erros de requisição

Esses erros se aplicam à própria requisição. Cobrem seus campos, seus headers, o recurso que ela nomeia e o estado do serviço que a recebeu.

`code`	Descrição	Status
BCC-0001	Invalid Input. Um valor da requisição não é válido. Uma requisição `POST`, `PUT` ou `PATCH` com um `Content-Type` diferente de `application/json` responde `415`. Uma chave `X-Idempotency` já usada em outra requisição responde `422`.	400, 415, 422
BCC-0002	Validation Failed. A requisição falha na validação. Uma recusa pelo schema da requisição responde `422`, e `errors` nomeia os campos responsáveis. Uma verificação de campo responde `400`. Uma recusa do lado do cliente sem código próprio também carrega `BCC-0002`, com o seu próprio status.	4xx
BCC-0003	Invalid Cursor. O cursor de paginação não é válido ou expirou.	400
BCC-0005	Not Found. O recurso não existe para o tenant de quem chama. Em um envio, a correspondência que `inReplyToMailId` nomeia não existe.	404
BCC-0006	Settings Already Exist. O tenant já tem configurações. Atualize-as em vez de criá-las de novo.	409
BCC-0007	Rate Limit Exceeded. Chegaram requisições demais na janela atual. Tente de novo após o intervalo do header `Retry-After`.	429
BCC-0008	Internal Server Error. Uma falha inesperada. O `detail` traz `internal error`.	500
BCC-0009	Service Unavailable. O serviço, ou uma dependência de que ele precisa, não consegue concluir a requisição. Tente de novo mais tarde.	503
BCC-0010	Checksum Mismatch. O anexo armazenado falhou na verificação de integridade no download. O `detail` traz `internal error`.	500
BCC-0012	Duplicate Idempotency Key. Uma requisição com a mesma chave `X-Idempotency` ainda está em processamento, e a resposta carrega um header `Retry-After`. Em uma reanálise, uma chave já usada para outra correspondência responde `422`.	409, 422
BCC-0013	Concurrent Modification. Outra requisição alterou o recurso antes. Leia os valores atuais e aplique sua alteração de novo.	409
BCC-0014	Invalid State. O estado atual da correspondência não permite a ação. Uma restauração de uma correspondência na pasta `CANCELLED` ou `SENT` responde esse código.	409
BANDWIDTH_LIMIT_EXCEEDED	O tenant usou sua cota de download de anexos na janela atual de 60 segundos. Tente de novo após o intervalo do header `Retry-After`.	429

Erros de autenticação

Esses erros se aplicam ao token e às permissões de quem chama.

`code`	Descrição	Status
BCC-1002	Unauthorized. A requisição não tem bearer token, ou o serviço não aceita o token.	401
BCC-1003	Forbidden. Quem chama não tem permissão para essa operação. No modo multi-tenant, um token sem claim de tenant também responde esse código.	403

Erros do BC Correio e de envio

Esses erros se aplicam às mensagens que você envia ao BACEN pelo BC Correio.

`code`	Descrição	Status
BCC-2001	BCB Authentication Failed. O tenant não tem configurações, ou não tem credenciais do BC Correio armazenadas, ou o serviço não consegue lê-las. Verifique as configurações do tenant.	401
BCC-2002	BCB Service Unavailable. O BC Correio recusou a mensagem, ou o serviço não a enviou. Envie a mensagem de novo com uma nova chave `X-Idempotency`.	503
BCC-2009	Transmission In Progress. Outro envio com a mesma chave `X-Idempotency` está em andamento. Aguarde alguns segundos e tente de novo com a mesma chave.	409
BCC-2010	Transmission State Unknown. O serviço não consegue dizer se o BC Correio recebeu a mensagem. Não a envie de novo. Confirme a não entrega com o BACEN pelo canal manual dele antes de usar uma nova chave.	409
BCC-2011	Transmission Failed. Um envio anterior com a mesma chave falhou, e o BC Correio não tem a mensagem. Envie a mensagem de novo com uma nova chave.	409
BCC-4003	Attachment Too Large For Transmission. O corpo da requisição de envio passa de 8 MB.	413

Erros de insight de IA

Esses erros se aplicam a uma reanálise de uma correspondência pelo provedor de IA que o tenant configurou.

`code`	Descrição	Status
BCC-3002	AI Analysis Failed. O provedor de IA retornou um erro em uma reanálise. O `detail` traz `internal error`.	502
BCC-3004	AI Not Configured. A IA não está configurada para o tenant.	422
BCC-3005	AI No Content. A correspondência não tem texto para analisar. O corpo dela está vazio, e nenhum texto veio dos anexos.	422
BCC-3006	Attachment Extraction In Progress. O serviço ainda está extraindo texto dos anexos da correspondência. Tente de novo em alguns segundos.	409

Correspondências

Configurações

Auditoria

Painel

Tratamento de erros

Lista de erros do BC Correios

Erros de requisição

Erros de autenticação

Erros do BC Correio e de envio

Erros de insight de IA

​Erros de requisição

​Erros de autenticação

​Erros do BC Correio e de envio

​Erros de insight de IA

Erros de requisição

Erros de autenticação

Erros do BC Correio e de envio

Erros de insight de IA