INVALID_API_KEY | 401 | Confira ambiente, prefixo, revogação e header Authorization. |
API_KEY_EXPIRED | 401 | A chave passou da validade; emita outra e troque na integração. |
API_SCOPE_INSUFFICIENT | 403 | A chave não tem o escopo de error.details.requiredScope; emita outra. |
SANDBOX_TRIAL_READ_ONLY | 403 | Só no ambiente de testes: o teste grátis acabou há menos de 30 dias e a chave só lê. error.details.readOnlyUntil traz o fim da janela; para voltar a escrever, contrate um plano com ambiente de testes. |
SANDBOX_TRIAL_EXPIRED | 403 | Só no ambiente de testes: teste grátis e janela de leitura encerrados. Nada é apagado; um plano com ambiente de testes religa a conta e as chaves. |
SANDBOX_TRIAL_ALREADY_USED | 409 | Outra conta do mesmo CNPJ ou dono já usou o teste grátis (error.details.accountId). Use essa conta ou peça a liberação ao comercial. |
ACCOUNT_SUSPENDED | 403 | A conta está suspensa; nenhuma operação é aceita. Fale com o suporte. |
ACCOUNT_SUSPENDED_BILLING | 403 | Pagamento pendente: só leitura e download seguem; regularize a fatura. |
RESOURCE_NOT_FOUND | 404 | Confira o identificador, a conta e se o responsável pela chave o vê. |
RATE_LIMIT_EXCEEDED | 429 | Respeite Retry-After e repita com backoff e jitter. |
IDEMPOTENCY_KEY_REQUIRED | 400 | Envie Idempotency-Key em toda operação POST. |
IDEMPOTENCY_KEY_IN_USE | 409 | Aguarde e repita a mesma requisição com a mesma chave. |
IDEMPOTENCY_KEY_REUSE | 422 | Não reutilize a chave com rota ou corpo diferente. |
IDEMPOTENCY_UNAVAILABLE | 503 | Repita com backoff sem trocar a chave. |
IDEMPOTENCY_SECRET_NOT_REPLAYABLE | 409 | O webhook já foi criado; gire o segredo em .../secret/rotate. |
ENVELOPE_WRITE_NOT_ALLOWED | 403 | O envelope não permite essa alteração para o ator ou estado atual. |
VOID_NOT_ALLOWED | 403 | O usuário responsável pela chave não pode anular este envelope. |
ENVELOPE_SIGNER_LOCATION_LOCKED | 409 | requestSignerLocation só muda em rascunho; o envelope já foi enviado. Para pedir a localização, duplique e envie de novo. |
DOCUMENT_TOO_LARGE | 413 | Reduza o arquivo conforme o limite informado pela resposta. |
DOCUMENTS_PER_ENVELOPE_EXCEEDED | 422 | O envelope passaria de details.limit documentos do plano (details.planName); envie menos arquivos ou mude de plano (details.upgradeUrl). |
SIGNATORIES_PER_ENVELOPE_EXCEEDED | 422 | O envelope passaria de details.limit signatários do plano (details.planName); só conta o papel de signatário, e um grupo vale 1. Remova signatários, divida em dois envelopes ou mude de plano (details.upgradeUrl). Em itens do envio em massa, details.row traz a linha. |
BULK_SEND_ITEM_TOO_MANY_FILES | 422 | Um item do lote tem mais arquivos que o plano aceita por envelope (details.limit); reduza o item ou mude de plano. |
VERSION_UNAVAILABLE | 403 | A versão solicitada do documento não está disponível para download. |
SIGNATURE_UPLOAD_NOT_ALLOWED | 403 | Imagem enviada fora do que a conta e o envelope permitem; desenhe ou digite. |
SIGNATURE_IMAGE_INVALID | 400 | A imagem foi recusada; details.motivo diz o porquê. Envie outra, ou desenhe ou digite. |
CONTACT_ALREADY_EXISTS | 409 | Consulte ou atualize o contato existente. |
FOLDER_SELF_MOVE | 400 | Não mova uma pasta para ela mesma. |
FOLDER_CIRCULAR_MOVE | 400 | Escolha um destino fora da árvore descendente da pasta. |
NON_EMPTY_FOLDER | 403 | Remova ou mova o conteúdo antes de excluir a pasta. |
API_APPROVAL_NOT_ENABLED | 403 | A aprovação pela API não está liberada para a conta; fale com o suporte. |
APPROVER_WAITING_TURN | 403 | Ainda não é a vez do aprovador; repita quando a etapa anterior concluir. |
DEADLINE_EXPIRED | 403 | O prazo do envelope venceu; não repita. |
PARTICIPANT_NOT_APPROVER | 409 | Só participantes com papel de aprovador são aprovados pela API. |
GROUP_APPROVER_NOT_SUPPORTED | 409 | Aprovador de grupo não é aprovado pela API; o membro aprova pelo link. |
PARTICIPANT_ALREADY_DECLINED | 409 | O aprovador recusou; não repita. |
ENVELOPE_NOT_APPROVABLE | 409 | O envelope não está em andamento; veja error.details.status. |
INVALID_CPF | 400 | Confira os dígitos do CPF enviado. |
VALIDATION | 400 | Confira os campos obrigatórios ou tipos de dados da requisição. |
BAD_REQUEST | 400 | A requisição está malformada; consulte a mensagem do erro. |
PHONE_NUMBER_REQUIRED | 400 | Número de telefone obrigatório para este método de autenticação. |
FIELD_PAGE_OUT_OF_BOUNDS | 400 | Um campo está posicionado em página que não existe no documento. |
PARTICIPANT_DOCUMENT_ACCESS_INVALID | 400 | allowedDocumentIds tem documento que não é do envelope; confira details.documentIds. |
FIELD_DOCUMENT_NOT_VISIBLE | 400 | Campo de participante em documento que ele não vê; libere o documento ou remova o campo. |
FIELD_GEOMETRY_INVALID | 400 | Campo com coordenada negativa, tamanho zero ou, com anchor, que ficaria fora da página; nada foi gravado. |
INVALID_FIELD_LINKING | 400 | A vinculação entre campos é inválida. |
APPROVAL_ALREADY_PROCESSED | 400 | O aprovador já processou esta aprovação; não repita. |
CONFLICT | 409 | Conflito com o estado atual do recurso; consulte a mensagem do erro. |
DOCUMENT_CONVERSION_NOT_PENDING | 409 | Documento não está esperando confirmação de conversão DOCX. |
ENVELOPE_DOCUMENTS_NOT_READY | 409 | Envelope tem documento(s) ainda sendo processado; aguarde e tente de novo. |
DOCUMENT_NOT_READY | 409 | O documento ainda está sendo processado; aguarde e tente de novo. |
ENVELOPE_DOCUMENT_AWAITING_CONFIRMATION | 409 | Revise e confirme o PDF convertido antes de enviar. |
ENVELOPE_DOCUMENT_INVALID | 409 | Um documento foi recusado no processamento e não vai mudar com o tempo: substitua o arquivo. details.documents lista documentId, name e reasonCode de cada recusado (reasonCode null é recusa genérica do arquivo). |
DOCUMENT_PROTECTED_BY_CERTIFICATION | — | Não é status HTTP: aparece como reasonCode em details.documents do 409 ENVELOPE_DOCUMENT_INVALID. O PDF tem certificação ou bloqueio de terceiro que não permite novas assinaturas (por exemplo, documento certificado do gov.br). Envie uma versão sem a certificação ou imprima em um PDF novo. |
ENVELOPE_NOT_EDITABLE | 409 | Envelope já saiu de rascunho/ajuste; não pode mais ser alterado. |
PARTICIPANT_TYPE_CHANGE_NOT_ALLOWED | 409 | Com o envelope em correção, não troque o tipo nem o grupo de um participante já enviado. Remova esse participante e inclua outro na mesma chamada. |
ENVELOPE_DOCUMENT_NOT_DUPLICABLE | 409 | Envelope tem documento que não pode ser duplicado (status inválido). |
ENVELOPE_HAS_NO_ORIGINAL_FILE | 409 | Nenhum documento tem arquivo original armazenado ainda. |
ENVELOPE_HAS_NO_SIGNED_DOCUMENT | 409 | Envelope não tem documento assinado para baixar. |
WEBHOOK_ENDPOINT_LIMIT_REACHED | 409 | Conta já tem 20 endpoints de webhook, o máximo; exclua um que não usa. |
ENVELOPE_TAG_LIMIT | 409 | Envelope já tem 3 etiquetas, o máximo; remova uma antes de aplicar outra. |
TEMPLATE_NOT_DRAFT | 409 | Só modelos em rascunho podem ser alterados; duplique e altere a cópia. |
CANNOT_EDIT_PARTICIPANT | 403 | Participante não pode ser editado no estado atual. |
ENVELOPE_SIGNATORIES_LIMIT | 403 | Envelope atingiu o limite de destinatários do plano. |
ENVELOPES_QUOTA_EXCEEDED | 403 | Conta atingiu o limite de envelopes; aguarde ou faça upgrade. |
PKI_QUOTA_EXCEEDED | 403 | A conta atingiu o limite de envelopes com certificado ICP-Brasil do ciclo. O limite renova no próximo ciclo; para ampliar, fale com a SuperSign®. |
SELFIE_QUOTA_EXCEEDED | 403 | A conta atingiu o limite de envelopes com verificação por selfie do ciclo. O limite renova no próximo ciclo; para ampliar, fale com a SuperSign®. |
PKI_NOT_IN_PLAN | 403 | Assinatura com ICP-Brasil não está disponível neste plano. |
WHATSAPP_NOT_IN_PLAN | 403 | WhatsApp não está disponível neste plano. Na edição depois do envio, vale para o participante sem e-mail (com e-mail, a mensagem sai por e-mail); nada foi gravado. |
SMS_NOT_IN_PLAN | 403 | SMS não está disponível neste plano. Vale para o participante sem e-mail, no envio e na edição depois do envio (com e-mail, a mensagem sai por e-mail); nada foi enviado nem gravado. Informe um e-mail do participante ou troque o canal. |
PKI_CERTIFICATE_CPF_MISMATCH | 422 | Na assinatura ICP-Brasil, o CPF do certificado não é o expectedDocumentNumber do signatário; nada foi gravado. O signatário assina com o certificado do titular, ou quem enviou corrige o CPF esperado. |
API_NOT_IN_PLAN | 403 | Acesso à API não está disponível neste plano. |
FREE_PLAN_EMAIL_ONLY | 403 | No plano gratuito, os participantes só são avisados e autenticados por e-mail. Troque o canal e a autenticação para e-mail, ou contrate um plano. |
PLAN_AUTHORIZATION_UNAVAILABLE | 503 | Não foi possível confirmar agora o que o plano permite. Repita com backoff; nada foi enviado. |
ACCOUNT_HOURLY_VOLUME_LIMIT | 429 | Conta atingiu o teto de envelopes por hora; aguarde e tente de novo. |
ACCOUNT_MESSAGE_BUDGET_EXCEEDED | 429 | Orçamento de mensagens da conta foi atingido; aguarde a renovação. |
TEMPLATE_ENVELOPE_MISSING_PARTICIPANTS | 422 | Vaga do modelo exige nome e contato para enviar; preencha e tente de novo. |
DOCUMENT_HAS_NO_TEXT | 422 | PDF sem texto legível (escaneado); posicione os campos por coordenadas. |
DOCUMENT_TEXT_UNREADABLE | 422 | O texto não pôde ser lido nos limites; posicione os campos por coordenadas. |
DOCUMENT_TOO_LARGE_FOR_ANCHOR | 422 | Arquivo acima do teto da busca por âncora; posicione por coordenadas. |
ANCHOR_SEARCH_BUSY | 503 | Busca por âncora ocupada; repita após o Retry-After. |
ANCHOR_SEARCH_UNAVAILABLE | 503 | Busca por âncora indisponível no ambiente ou falha temporária; use coordenadas ou repita após o Retry-After. |
ANCHOR_NOT_FOUND | 422 | Texto de anchor não achado no PUT .../fields; nada foi gravado. details.anchors lista TODAS as âncoras não achadas (fieldId, text). Confira os textos ou use ifNotFound: "ignore". |
ANCHOR_TOO_MANY_MATCHES | 422 | As âncoras do PUT .../fields gerariam mais de 200 campos; use occurrence "first"/N ou um texto mais específico. |