SuperSign - API Oficial
  1. Introdução
  • SuperSign API Pública
    • Introdução
      • Crie seu primeiro envelope no Sandbox
      • 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
      • Gerar cliente com OpenAPI
      • Evento ENVELOPE_SENT
      • Evento SIGNATORY_SIGNED
      • Evento ENVELOPE_COMPLETED
      • Evento ENVELOPE_VOIDED
      • Evento ENVELOPE_EXPIRED
      • Segurança e verificação
      • Entregas, retentativas e reenvio
      • Testar na Sandbox e automatizar
      • Conceitos da API V4
      • Posicionar campos por texto âncora
      • Verificar um documento selado
      • Evento PARTICIPANT_DECLINED
      • Evento EMAIL_BOUNCED
      • Entrega do convite pela integração
      • Evento PARTICIPANT_VIEWED
      • Guia completo da API V4
      • Assinatura embutida (sob consulta)
      • Salvar os documentos assinados no seu Drive
    • 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
        • Consultar link de assinatura
        • 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
        • Consultar o tamanho das páginas
        • Achar texto (âncora) no documento
        • Verificar um documento selado
        • Baixar o PDF de exemplo
        • 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
        • Enviar um evento de teste para o webhook
        • Atualizar webhook
        • Criar webhook
        • Listar webhooks
      • Modelos
        • Listar modelos
        • Consultar modelo
        • Criar envelope a partir de modelo
        • Criar modelo em rascunho
        • Editar título e descrição do modelo
        • Consultar processamento do documento do modelo
        • Ativar modelo
        • Duplicar modelo
        • Enviar documentos do modelo
        • Definir vagas do modelo
        • Posicionar campos no documento do modelo
        • Apagar modelo em rascunho
        • Reordenar documentos do modelo
        • Remover documento do modelo
        • Definir cópias do modelo
        • Achar texto (âncora) no documento do modelo
      • Auditoria e relatórios
        • Relatório de consumo do plano
        • Relatório de recusas, anulações e prazos vencidos
        • 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
  1. Introdução

Entrega do convite pela integração

Use deliveryMethod: "API" quando sua integração enviará o convite ao participante pelo próprio canal. A opção é por participante individual, signatário ou aprovador, em PUT /v4/api/envelopes/{envelopeId}/participants e POST /v4/api/envelopes/send-now. Ela depende do direito efetivo de links de assinatura da conta: ativação por conta ou, em produção quando habilitado, direito do plano. Na sandbox, o acesso depende da ativação sincronizada pelo handoff. O SuperSign não envia convite, lembrete ou push para assinar para esse participante; os demais participantes do mesmo envelope continuam usando seus canais normais.
O método de autenticação (authMethod) é independente. Se ele exigir código por e-mail, SMS ou WhatsApp, esse código continua sendo enviado pelo SuperSign e os dados de contato exigidos continuam obrigatórios. O canal API não comprova que o integrador entregou a mensagem. Avisos posteriores de conclusão, anulação ou recusa seguem as regras existentes; a opção suprime o convite e seus lembretes, não todas as mensagens.

Fluxo#

1.
Crie um rascunho em POST /v4/api/envelopes.
2.
Sincronize os participantes com PUT /v4/api/envelopes/{envelopeId}/participants. Para quem receberá pelo seu canal, informe deliveryMethod: "API". Grupos e observadores não aceitam esse valor nesta versão.
3.
Adicione os documentos e envie com POST /v4/api/envelopes/{envelopeId}/send.
4.
Para cada participante de entrega API cuja vez esteja liberada, consulte GET /v4/api/envelopes/{envelopeId}/participants/{participantId}/signing-link. A chave precisa de signing-links:read ou acesso total. A resposta contém data.url e usa Cache-Control: private, no-store.
5.
Entregue a URL pelo seu canal e proteja-a como credencial privada. Não a grave em logs, analytics ou webhooks. O link pode mudar após edição do participante; consulte novamente antes de reenviar pelo seu canal.
Para criar e iniciar o envio numa chamada, use POST /v4/api/envelopes/send-now com deliveryMethod: "API" no signatário ou aprovador individual. Envie os arquivos às URLs devolvidas. O processamento e o envio são assíncronos: aguarde ENVELOPE_SENT ou consulte o estado do envelope antes de pedir o link. O Idempotency-Key é obrigatório. O direito efetivo é conferido antes da criação e novamente no envio; se a conta perder esse direito durante o processamento, o envelope é anulado com o motivo no histórico e evento ENVELOPE_VOIDED, sem convite ao participante.
Em fluxo sequencial, a consulta do link recusa WAITING_TURN. O evento ENVELOPE_SENT e a leitura dos participantes trazem IDs para acompanhar o envelope, mas não trazem a URL. Consulte o link quando a etapa estiver liberada. O endpoint de lembrete da SuperSign recusa participantes de entrega API; o integrador controla seus próprios lembretes.
Os contratos v2/v3, modelos e a edição pela tela não aceitam selecionar API. Grupos e observadores também continuam usando EMAIL, SMS e WHATSAPP. Envelopes já existentes e participantes de outros canais não mudam.
Modificado em 2026-11-15 14:09:47
Página anterior
Evento EMAIL_BOUNCED
Próxima página
Evento PARTICIPANT_VIEWED
Built with