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