SuperSign - API Oficial
Modelos
Copiar Página
SuperSign API Pública
Introdução
Primeiro envelope em 5 minutos
Integrar com IA
Testar a API no Postman
Paginação e filtros
Catálogo de erros
Receitas em Node.js, PHP e Python
Changelog
Idempotência e erros
Estados do envelope
Webhooks
Limites de requisição
Criar um envelope a partir de um modelo
Referência da API
Conta
Consultar a conta da integração
Consultar capacidades da integração
Consultar o catálogo de capacidades
Listar chamadas da própria chave
Consultar consumo do ciclo
Validar a chave de API
Envelopes
Excluir rascunho de envelope
Consultar histórico do envelope
Criar e enviar envelope numa chamada
Gerar URL de download do envelope em ZIP
Duplicar envelope
Criar rascunho de envelope
Listar envelopes
Atualizar configurações do envelope
Enviar envelope
Consultar envelope
Mover envelope para outra pasta
Anular envelope
Participantes
Listar participantes do envelope
Aprovar participante aprovador
Recusar como participante aprovador
Corrigir contato do participante
Sincronizar participantes
Enviar lembrete ao participante
Documentos
Listar documentos do envelope
Substituir campos do documento
Listar campos do documento
Confirmar o PDF convertido de um DOCX
Validar um documento selado
Reordenar documentos do envelope
Adicionar documento ao envelope
Gerar URL de download do documento
Contatos
Atualizar contato parcialmente
Listar envelopes do contato
Listar listas de contatos
Consultar lista de contatos
Criar contato
Listar contatos
Consultar contato
Atualizar contato
Excluir contato
Equipe
Listar grupos da conta
Listar membros da conta
Pastas
Listar conteúdo da pasta
Consultar acesso da pasta
Excluir pasta
Renomear pasta
Mover pasta
Listar todas as pastas
Criar pasta
Convites
Listar convites da conta
Webhooks
Excluir webhook
Listar entregas de um webhook
Detalhar uma entrega de webhook
Reenviar uma entrega de webhook
Girar o segredo de assinatura do webhook
Criar webhook
Listar webhooks
Atualizar webhook
Modelos
Listar modelos
GET
Consultar modelo
GET
Criar envelope a partir de modelo
POST
Criar modelo em rascunho
POST
Editar título e descrição do modelo
PUT
Consultar processamento do documento do modelo
GET
Ativar modelo
PATCH
Duplicar modelo
POST
Enviar documentos do modelo
POST
Definir vagas do modelo
PUT
Posicionar campos no documento do modelo
PUT
Auditoria e relatórios
Listar envelopes anulados
Relatório de envelopes
Relatório de uso por grupo
Etiquetas
Aplicar etiqueta ao envelope
Remover etiqueta do envelope
Listar etiquetas da conta
Modelos
Copiar Página
Consultar processamento do documento do modelo
Sandbox
Sandbox
GET
/v4/api/templates/{templateId}/documents/{documentId}/status
Testar
Run in Apidog
Run in Apidog
Informa se o documento enviado ao modelo já foi processado. Consulte até ficar pronto antes de posicionar campos e ativar.
Requisição
Parâmetros de Caminho
Gerar Código
Respostas
🟢
200
OK
application/json
Sucesso
Headers
Gerar Código
Body
application/json
Gerar Código
🟠
401
Não Autorizado
🟠
403
Proibido
🟠
404
Registo Não Encontrado
🟠
429
Request
Request Example
Shell
JavaScript
Java
Swift
cURL
cURL-Windows
Httpie
wget
PowerShell
curl
--location
'/v4/api/templates//documents//status'
Response
Response Example
200 -
Exemplo 1
{
"status"
:
"PENDING_UPLOAD"
}
Modificado em
2026-09-29 13:44:29
Página anterior
Editar título e descrição do modelo
Próxima página
Ativar modelo