Catálogo de erros

Toda resposta de erro traz um campo codigo estável. Ramifique por ele — nunca pelo texto da mensagem, que pode mudar.

401
chave_invalida
A chave enviada não foi reconhecida, ou não vale mais.
402
cota_do_plano_excedida
Os documentos incluídos no plano acabaram nesta competência.
402
organizacao_sem_escrita
A chave continua válida e continua lendo — o que parou foi a criação.
402
plano_sem_api
A chave é válida, mas o plano da organização funciona apenas pela tela.
402
saldo_insuficiente
Não há crédito pré-pago para enviar por SMS ou WhatsApp.
402
teto_de_excedente_atingido
O valor máximo de excedente do mês foi alcançado.
403
chave_de_ambiente_errado
A chave é de um ambiente e o recurso é de outro.
403
origem_nao_permitida
O pedido não veio da página de assinatura da UseSign.
403
sem_permissao
Você está autenticado, mas o seu papel nesta organização não permite esta operação.
404
documento_nao_encontrado
Nenhum recurso com esse identificador nesta organização.
405
metodo_nao_permitido
Esta rota não aceita esse verbo HTTP.
409
chave_idempotencia_reutilizada
A mesma Idempotency-Key já foi usada com outro corpo, ou em outra rota.
409
documento_ja_concluido
A operação não vale para o estado atual do documento.
409
otp_ja_validado
O signatário já confirmou o código; não há novo código a emitir.
409
requisicao_em_andamento
Outra requisição com esta mesma chave ainda está sendo processada.
409
sessao_de_outro_documento
A tela mostra um documento e o cookie de sessão aponta para outro.
410
convite_esgotado
Este convite atingiu o teto de emissões ou de tentativas.
410
otp_expirado
O código de verificação passou da validade de 10 minutos.
413
arquivo_grande_demais
O PDF passa do limite de 20,0 MB, ou a requisição passa de 28,0 MB.
422
arquivo_nao_e_pdf
O conteúdo enviado não tem a estrutura de um PDF.
422
campo_fora_da_pagina
A área informada em signatarios[].campos[] não cabe na página indicada.
422
cpf_invalido
O dígito verificador do documento do signatário não confere.
422
entrada_invalida
Um ou mais campos não passaram na validação.
422
webhook_url_invalida
O endereço informado foi recusado pelas regras de destino.
429
limite_de_requisicoes
Muitas requisições em pouco tempo com a mesma chave.
429
otp_excedeu_tentativas
Foram feitas 5 tentativas com o mesmo código.
500
erro_interno
Algo falhou do nosso lado. Não é a sua requisição.
502
falha_no_envio_do_codigo
O provedor de e-mail ou SMS recusou a entrega.
502
falha_no_provedor_de_cobranca
O provedor de pagamento não respondeu. Nada foi cobrado.

Os erros seguem a RFC 9457, com duas extensões: codigo e erros. Veja a referência da API.