Lista de erros do Consignado

Formato do erro O Lerian Consignado retorna erros como problem details RFC 9457, com o media type application/problem+json:

{
  "code": "CLT-0006",
  "detail": "The worker's authorization is outside its validity window, so their payroll data can no longer be read under it. Obtain a fresh worker authorization and send its evidence; repeating this request cannot succeed.",
  "status": 422,
  "title": "Unprocessable Entity",
  "type": "https://errors.lerian.studio/v1/CLT-0006"
}

Definições de campos

type – Uma URI que identifica o erro no catálogo de erros da Lerian. Construída como https://errors.lerian.studio/v1/<code>.
title – O texto do status HTTP (por exemplo, Unprocessable Entity).
status – O código de status HTTP.
detail – Uma explicação legível por humanos desta ocorrência. Em uma resposta 5xx, o Consignado sanitiza o detail para internal error, para que uma causa interna nunca apareça no corpo. Um código 5xx que nomeia uma falha upstream ou um desfecho desconhecido mantém um detail escrito para você, como DATAPREV_TIMEOUT. Baseie sua lógica em code e no status, não no detail.
code – Um identificador estável para o erro. As tabelas abaixo listam os códigos CLT-NNNN e os códigos nomeados que várias operações compartilham. Algumas operações respondem com códigos próprios, como CURSOR_EXPIRED na varredura de inventário de registros. Veja Códigos por operação. Uma requisição que falha na validação de schema não traz code: ela responde 422 com o detail validation failed, ou 400 quando o corpo não pode ser interpretado, e a lista errors nomeia cada campo.
errors – Lista opcional de detalhes de erro individuais, cada um com um location, um message e um value.
instance – O trace ID da requisição, quando o gateway a rastreou. Informe-o ao reportar uma falha à Lerian.
upstream – O erro que um sistema upstream retornou e que o gateway repassa. Ele vem do Dataprev nas operações do trilho, e do Streaming Hub nas operações de subscription. Ele contém o code e o message desse sistema, e sobrevive à sanitização de 5xx que limpa o detail. Veja Códigos de motivo do Dataprev.
refusal – Em uma recusa de lance: o motivo que o gateway registrou para o lance, com source, field, rule e detail. Uma recusa do Dataprev também traz o code do Dataprev.

400: Requisição inválida

`code`	Descrição	`detail`
CLT-0001	Requisição inválida. Por exemplo, uma requisição de credenciais informa um código de solicitante que não tem três dígitos, ou um certificado e uma chave que não formam um par PEM válido. Uma requisição com uma chave `X-Idempotency` mais longa do que a operação aceita também recebe esse código. Uma confirmação de desembolso, uma execução de garantia FGTS, uma correção de contrato e um comando que responde códigos `RAIL_COMMAND_*` respondem a uma chave longa demais com `422`. Uma importação de contrato com contabilização aceita uma chave de até 121 bytes: uma chave de 122 a 128 bytes responde `422` `CLT-0006`. Uma requisição que falha na validação de schema não carrega código.	—
CLT-0011	Falha na requisição. O código de fallback para uma recusa do lado do cliente sem entrada própria.	Nomeia a recusa.

401: Não autorizado

`code`	Descrição	`detail`
CLT-0003	Não autorizado. A requisição não trouxe um bearer token válido, ou o gateway não conseguiu resolver um tenant a partir dele.	`Unauthorized`, ou uma frase que nomeia a causa, como `The bearer token was not accepted.`

403: Proibido

`code`	Descrição	`detail`
CLT-0004	Proibido. O chamador autenticado não tem permissão para esta operação. Um chamador que age por um originador ou por um fundo também recebe esse código em um contrato que pertence a outra parte.	`Forbidden`

404: Não encontrado

`code`	Descrição	`detail`
CLT-0005	Não encontrado. O registro nomeado pela requisição não existe para este tenant. Um artefato retido pertencente a outro tenant responde da mesma forma.	`Not Found`, `The requested resource was not found.`, ou uma frase que nomeia o que falta, como `contract is not an averbação of this tenant`

409: Conflito

`code`	Descrição	`detail`
CLT-0007	Conflito. A requisição conflita com o estado atual do registro.	`Conflict`, ou a frase específica do conflito, como `an identical request is already in flight`.

CLT-0007 com o detail an identical request is already in flight marca uma requisição que o gateway ainda não terminou. Repita essa requisição sob a mesma chave de idempotência. Conflitos de comando respondem com um código nomeado no lugar de CLT-0007, para que um cliente consiga diferenciá-los. Leia code e detail juntos antes de repetir a requisição. Essas grafias de código fazem parte do contrato de wire e não mudam.

Após DATAPREV_CREDENTIAL_REQUIRED, envie o certificado Dataprev, as credenciais OAuth e o código de solicitante do tenant, e depois envie a requisição novamente. Após DATAPREV_CREDENTIAL_REVOKED, envie um novo certificado e um novo cliente OAuth juntos com PUT /v1/credentials/dataprev. Após DATAPREV_CREDENTIAL_REJECTED, corrija as credenciais de cliente OAuth do tenant e depois envie uma leitura novamente. Uma escrita pode ter deixado o comando parado: veja Opere o Lerian Consignado antes de enviá-la novamente.

410: Removido

A varredura paginada de inventário de registros emite um cursor com uma janela limitada de repetição.

`code`	Descrição	`detail`
CURSOR_EXPIRED	Removido. A janela de repetição do cursor expirou, então a varredura à qual ele pertencia não pode continuar. Inicie uma nova varredura.	A janela de repetição do cursor expirou.

413: Entidade da requisição muito grande

`code`	Descrição	`detail`
CLT-0010	Entidade da requisição muito grande. O payload da requisição é maior do que o endpoint aceita, ou o corpo de um comando contém mais tokens JSON do que o comando aceita.	Nomeia o limite que a requisição ultrapassou, em bytes ou em tokens JSON.

Um corpo de averbação que traz a CCB assinada, o pacote de evidências, a evidência de assinatura ou data_hora_assinatura é recusado. Ele responde 413 com 1 MiB ou mais, e 422 com o detail validation failed abaixo disso. Envie-os para POST /v1/consignado/contracts/{numero_contrato}/ccb-attachment depois que o Dataprev aceitar a averbação.

422: Entidade não processável

`code`	Descrição	`detail`
CLT-0006	Entidade não processável. O gateway leu a requisição e a recusa em sua forma atual. Uma rejeição determinística do Dataprev também responde aqui, e traz `upstream`.	O motivo para agir, como obter uma nova autorização do trabalhador.

Algumas recusas respondem com um código nomeado no lugar de CLT-0006. Nada chegou ao Dataprev. A descrição diz o que fazer em seguida.

`code`	Descrição	`detail`
IDEMPOTENCY_KEY_REUSE	A chave `X-Idempotency` já foi consumida por uma requisição diferente. Envie a requisição alterada sob uma nova chave.	A chave X-Idempotency já foi usada com uma requisição diferente; envie uma nova chave para uma requisição alterada.
FUNDO_NOT_REGISTERED	`fundo_ref` não nomeia um fundo registrado para este tenant. Corrija `fundo_ref`.	fundo_ref não nomeia um fundo registrado para este tenant
FUNDO_DEACTIVATED	O fundo que `fundo_ref` nomeia não aceita mais crédito novo.	o fundo nomeado está desativado e não aceita crédito novo
FIRST_DEDUCTION_BEFORE_COMPETENCIA	`data_primeiro_desconto` cai em um mês anterior a `first_deduction_competencia`. Corrija as datas.	Nomeia a regra.
DECLARED_DATES_OUT_OF_ORDER	As datas declaradas quebram uma ordem que a contabilização exige. Corrija as datas.	Nomeia a regra.
FORMALIZATION_DEADLINE_EXCEEDED	`data_hora_assinatura` é posterior a `formalization_deadline`. Quando a documentação responder esse código, exclua a averbação e depois formalize o contrato novamente.	Nomeia a regra.
BOOKING_FIELD_INVALID	O Lender não consegue ler um campo do bloco de contabilização.	Nomeia o campo.
DECLARED_TERMS_INCONSISTENT	Os valores ou as taxas declarados se contradizem. Corrija os termos.	Nomeia a regra.
MARGIN_SNAPSHOT_INCONSISTENT	`margin_snapshot` não comporta `installment_amount`. Leia a margem de novo ou precifique o contrato de novo.	Nomeia a regra.
CONTRACT_NOT_BOOKABLE	O Lender não consegue contabilizar este contrato de forma alguma. Envie a requisição sem o bloco de contabilização.	Nomeia a regra.
RATE_OUTSIDE_PRODUCT_RANGE	`monthly_rate` vezes 12 fica fora da faixa de taxa anual da versão de produto do Lender que `loan_product_version` nomeia. O gateway não verifica uma versão que não recebeu do Lender.	Nomeia a faixa.
BID_ORIGINADOR_UNKNOWN	O originador para o qual o lance é feito não está registrado para este tenant.	O originador para o qual este lance é feito não está registrado para este tenant. Um bancarizador o nomeia em originadorRef; uma credencial de originador faz lances sob sua própria referência, que precisa estar registrada antes de fazer lances.
BID_ORIGINADOR_INACTIVE	O originador para o qual o lance é feito não pode mais agir por este tenant.	O originador para o qual este lance é feito pode não agir mais por este tenant. Um bancarizador o nomeia em originadorRef; uma credencial de originador faz lances sob sua própria referência, que precisa ser reativada antes de fazer lances de novo.
BID_SOLICITACAO_UNKNOWN	O gateway não mantém nenhuma solicitação descoberta sob este identificador. Tente de novo depois que o evento `consignado.solicitacao.received` dela chegar.	O gateway não mantém nenhuma solicitação descoberta sob este identificador. Tente de novo depois que o evento consignado_solicitacao.received dela chegar; nada foi registrado.
BID_NO_PROPOSTA_LEFT	Um lance retomado não tem mais proposta para enviar de novo. Faça um novo lance.	Não resta proposta para repetir sob esta chave de idempotência: ou a validadeProposta dela passou e o Dataprev não a aceita mais, ou o payload armazenado já foi apagado pela retenção deste serviço. Faça um novo lance se a solicitação ainda estiver aberta.
PORTABILIDADE_WINDOW_EXPIRED	A janela da portabilidade passou: os 20 dias corridos para concluir uma portabilidade de saída, ou a validade da solicitação que uma resposta ao leilão de portabilidade responde.	Nomeia a janela.

Os códigos de contabilização, de FIRST_DEDUCTION_BEFORE_COMPETENCIA a CONTRACT_NOT_BOOKABLE, valem apenas para um contrato enviado com o bloco de contabilização. Uma averbação responde todos os códigos de contabilização, exceto FORMALIZATION_DEADLINE_EXCEEDED. A documentação dela responde apenas DECLARED_DATES_OUT_OF_ORDER e FORMALIZATION_DEADLINE_EXCEEDED. Uma importação de contrato com booking responde todos os códigos de contabilização, exceto FIRST_DEDUCTION_BEFORE_COMPETENCIA. Uma averbação com o bloco de contabilização também responde RATE_OUTSIDE_PRODUCT_RANGE. Um comando enviado novamente com uma chave de idempotência que uma requisição anterior já consumiu pode responder um de quatro códigos nomeados. A requisição anterior pode já ter chegado ao Dataprev. Não envie o comando novamente, nem com esta chave nem com uma nova. Leia o estado atual do registro que o comando altera. A resposta ao leilão de portabilidade é a exceção: a referência dela explica como um reenvio com uma nova chave revela o resultado.

`code`	Descrição	`detail`
IDEMPOTENCY_STATE_UNRECOGNISED	O registro mantido sob esta chave foi gravado por uma versão mais nova do serviço.	Uma requisição anterior consumiu esta chave de idempotência com um registro gravado por uma versão mais nova deste serviço; concilie a requisição original e não tente de novo com uma nova chave.
IDEMPOTENCY_RECORD_UNREADABLE	O registro mantido sob esta chave não pode ser lido.	Uma requisição anterior consumiu esta chave de idempotência com um registro que este serviço não consegue ler; concilie a requisição original e não tente de novo com uma nova chave.
IDEMPOTENCY_OUTCOME_UNRECORDED	A requisição anterior sob esta chave não tem desfecho registrado.	Uma requisição anterior consumiu esta chave de idempotência e seu desfecho não foi registrado; concilie a requisição original e não tente de novo com uma nova chave.
IDEMPOTENCY_REPLAY_UNAVAILABLE	A requisição anterior sob esta chave foi concluída, e sua resposta não pode ser reproduzida.	Uma requisição anterior com esta chave de idempotência foi concluída e sua resposta foi entregue uma vez, mas não pode ser reproduzida; não reenvie, concilie o recurso que o comando altera e não tente de novo com uma nova chave.

429: Muitas requisições

`code`	Descrição	`detail`
CLT-0009	Muitas requisições. O chamador excedeu seu orçamento de requisições.	`Too many requests were sent in a given amount of time.`

Aguarde o tempo indicado no header Retry-After e depois envie a requisição novamente.

500: Erro interno do servidor

`code`	Descrição	`detail`
CLT-0002	Erro interno do servidor. Uma falha inesperada dentro do gateway.	`internal error`

501: Não implementado

Um 501 responde a uma operação que seu deploy não habilitou. As rotas permanecem montadas, então a resposta chega por requisição, em vez de como um path ausente. Estas operações respondem 501 até que seu deploy as habilite:

downloads de artefato de contrato
correções de contrato
envio de lance
operações que chegam ao Dataprev

A revogação de credenciais do Dataprev responde 501 em um deploy cujas credenciais são estáticas. O detail traz internal error, porque o Consignado sanitiza o detail em uma resposta 5xx. A revogação de credenciais é a exceção: o detail dela diz que as credenciais são estáticas. Baseie sua lógica no status.

502: Gateway inválido

`code`	Descrição	`detail`
DATAPREV_INVALID_RESPONSE	O Dataprev retornou, para uma leitura, dados que o gateway não consegue usar. Nada mudou. Tente de novo mais tarde, ou estreite a janela da leitura.	O Dataprev retornou dados para esta leitura que o gateway não conseguiu usar; nada foi alterado. Tente de novo mais tarde ou estreite a janela, citando este instance se o problema persistir.

503: Serviço indisponível

`code`	Descrição	`detail`
CLT-0008	Serviço indisponível. O gateway não consegue atender a requisição agora. O armazenamento próprio ou a custódia de credenciais dele está indisponível, ou o controle de ritmo das chamadas ao Dataprev segurou a requisição além do prazo dela. Envie a mesma requisição novamente em breve, sob a mesma chave de idempotência.	Uma frase que nomeia a causa, ou `internal error`.
DATAPREV_UNAVAILABLE	O Dataprev respondeu com uma falha de repetir-mais-tarde, ou não respondeu. Tente de novo mais tarde sob a mesma chave de idempotência.	O Dataprev está indisponível para esta requisição agora; o membro upstream traz o código próprio dele quando ele enviou um. Tente de novo mais tarde, reutilizando a mesma chave X-Idempotency em um comando.
OUTCOME_UNKNOWN	O gateway não sabe se a requisição teve efeito. Ele não conseguiu registrar o desfecho, ou a confirmação de um lance pelo Dataprev foi ambígua. Repita apenas sob a mesma chave de idempotência.	O gateway não conseguiu registrar o desfecho desta requisição, então não se sabe se ela teve efeito. Nunca a reenvie sob uma nova chave: repita sob a MESMA chave X-Idempotency e, se essa repetição responder IDEMPOTENCY_OUTCOME_UNRECORDED, concilie a requisição original.
STREAMING_HUB_UNAVAILABLE	O Streaming Hub por trás das operações de subscription está indisponível.	O streaming hub está indisponível. Tente de novo mais tarde, reutilizando a mesma chave X-Idempotency em uma alteração.
TENANT_MANAGER_UNAVAILABLE	O Tenant Manager está indisponível, então o gateway não consegue resolver seu tenant. Apenas um deploy multi-tenant responde esse código.	o tenant manager está indisponível; repita a requisição mais tarde
AUT-0033	O Access Manager não decidiu sobre esta requisição.	O Access Manager não decidiu esta requisição. Aguarde um momento e tente de novo.

Uma resposta DATAPREV_UNAVAILABLE ou DATAPREV_TIMEOUT também traz upstream quando o Dataprev enviou o código e a mensagem próprios.

504: Timeout do gateway

`code`	Descrição	`detail`
DATAPREV_TIMEOUT	O Dataprev não respondeu a tempo. Se a requisição altera estado no Dataprev, o desfecho dela é desconhecido. Repita apenas sob a mesma chave de idempotência.	O Dataprev não respondeu a tempo, então, se esta requisição altera estado no Dataprev, o desfecho dela é desconhecido. Nunca a reenvie sob uma nova chave: repita sob a MESMA chave X-Idempotency e, se essa repetição responder IDEMPOTENCY_OUTCOME_UNRECORDED, concilie a requisição original.
STREAMING_HUB_TIMEOUT	O Streaming Hub por trás das operações de subscription não respondeu a tempo.	O streaming hub não respondeu a tempo. Tente de novo, reutilizando a mesma chave X-Idempotency em uma alteração.
TENANT_MANAGER_TIMEOUT	O Tenant Manager não respondeu a tempo. Apenas um deploy multi-tenant responde esse código.	o tenant manager não respondeu a tempo; repita a requisição
AUT-1021	O Access Manager não respondeu a tempo.	O Access Manager não respondeu a tempo. Tente de novo.

Códigos por operação

Algumas operações respondem com códigos próprios, nomeados a partir da operação: FUNDO_*, ORIGINADOR_*, CESSAO_*, CEDED_CREDIT_*, SALDO_DEVEDOR_*, REGISTRO_B3_*, e os códigos de cursor e de filtro das operações de listagem. A referência da API enumera todos os códigos no campo code do schema de erro. As operações do código de instrumento B3, GET e PATCH /v1/consignado/contracts/{numero_contrato}/registro-b3, respondem com estes códigos.

`code`	Status	Descrição	`detail`
REGISTRO_B3_CONTRATO_NAO_ENCONTRADO	404	Este tenant não tem contrato com este número.	Nenhum contrato assim foi encontrado para este tenant.
REGISTRO_B3_NAO_INFORMADO	404	O contrato ainda não tem código de instrumento B3.	O contrato ainda não tem registro B3.
REGISTRO_B3_AVERBACAO_NAO_CONFIRMADA	409	A averbação do contrato não está confirmada. O gateway aceita o código apenas depois que a averbação é confirmada.	A averbação do contrato não está confirmada.
REGISTRO_B3_JA_INFORMADO	409	O contrato já tem outro código ou outra data de registro. A API não oferece correção. Enviar o mesmo registro de novo responde `200`.	O contrato já tem um registro B3 diferente.
REGISTRO_B3_DATA_REGISTRO_INVALIDA	422	`dataRegistro` está no futuro ou antes da averbação.	dataRegistro não pode estar no futuro nem antes da averbação.
REGISTRO_B3_INTERNAL	500	Uma falha inesperada.	`internal error`
REGISTRO_B3_UNWIRED	501	Este deploy não registra o código de instrumento B3.	`internal error`
REGISTRO_B3_UNAVAILABLE	503	O armazenamento do código de instrumento B3 está indisponível. Envie a requisição novamente em breve.	`internal error`

Códigos de motivo do Dataprev

O Consignado repassa os códigos de motivo do Dataprev, em vez de mapeá-los para códigos próprios. Isso mantém uma recusa legível em relação ao que o Dataprev disse. Leia cada código de motivo em relação à especificação do Dataprev, não a esta página. O Dataprev pode publicar um código que esta página não lista, e o gateway ainda assim o entrega a você. Eles chegam até você em dois lugares. Em uma recusa. O membro upstream traz o code e o message do próprio Dataprev. Uma recusa com vários códigos os lista separados por vírgula. O membro contém os códigos e as frases do Dataprev, com tamanho limitado, e não um corpo de resposta. Um 422 o traz para uma rejeição determinística. DATAPREV_UNAVAILABLE e DATAPREV_TIMEOUT o trazem para uma falha de repetir-mais-tarde. Uma recusa do Dataprev a um comando em upstream fica retida sob a chave de idempotência dele. Um refusal de lance também, qualquer que seja o source dele. A mesma chave retorna a mesma recusa, então envie uma requisição corrigida sob uma nova chave. Um lance recusado com source dataprev também retém a solicitação, então qualquer novo lance para essa solicitação responde BID_SOLICITACAO_TAKEN. Uma recusa que o gateway faz por conta própria, sem upstream e sem membro refusal de lance, não retém a chave, então uma requisição corrigida pode ir sob a mesma chave. Uma execução de garantia FGTS e um comando que responde códigos RAIL_COMMAND_* são a exceção: eles retêm a chave desde antes de chamar o Dataprev. Quando um reenvio responde que uma requisição anterior já detém a chave, como IDEMPOTENCY_KEY_REUSE ou RAIL_COMMAND_PAYLOAD_MISMATCH, siga a instrução desse código. Em respostas de contrato e margem. Vários campos de resposta emparelham um código de motivo do Dataprev com o rótulo próprio do Dataprev para ele. Uma leitura de margem publica blockType e ineligibilityReason, que formam o par code e description. Uma leitura de contrato publica motivo_exclusao, origem_averbacao, origem_exclusao, portabilidade_situacao e situacao_bloqueio_garantia, que formam o par codigo e descricao. Cada campo contém um código numérico e o texto que o Dataprev retornou ao lado dele. Trate o conjunto como aberto. Mapeie os códigos de motivo sobre os quais sua integração age, e repasse o restante com seus rótulos, para que um código ainda não mapeado continue legível para um operador.

Configuração do tenant e credenciais

Dados do trabalhador e margem

Leilões e propostas

Registro e documentos do contrato

Correções do contrato

Ciclo de vida do contrato

Refinanciamento, renegociação e portabilidade

Contratos legados

Garantias do FGTS

Conciliação e calendário

Fundos e cessões

Acesso de parceiro do fundo

Acesso de parceiro do originador

Capacidade

Monitoramento

Subscriptions de eventos

Tratamento de erros

Eventos

Lista de erros do Consignado

400: Requisição inválida

401: Não autorizado

403: Proibido

404: Não encontrado

409: Conflito

410: Removido

413: Entidade da requisição muito grande

422: Entidade não processável

429: Muitas requisições

500: Erro interno do servidor

501: Não implementado

502: Gateway inválido

503: Serviço indisponível

504: Timeout do gateway

Códigos por operação

Códigos de motivo do Dataprev

​400: Requisição inválida

​401: Não autorizado

​403: Proibido

​404: Não encontrado

​409: Conflito

​410: Removido

​413: Entidade da requisição muito grande

​422: Entidade não processável

​429: Muitas requisições

​500: Erro interno do servidor

​501: Não implementado

​502: Gateway inválido

​503: Serviço indisponível

​504: Timeout do gateway

​Códigos por operação

​Códigos de motivo do Dataprev

400: Requisição inválida

401: Não autorizado

403: Proibido

404: Não encontrado

409: Conflito

410: Removido

413: Entidade da requisição muito grande

422: Entidade não processável

429: Muitas requisições

500: Erro interno do servidor

501: Não implementado

502: Gateway inválido

503: Serviço indisponível

504: Timeout do gateway

Códigos por operação

Códigos de motivo do Dataprev