Skip to main content
PUT
Signatário posiciona a chancela na assinatura
Permite que o signatário defina a posição exata da sua chancela visual enquanto está assinando. Esta operação é chamada quando o signatário arrasta a chancela na tela de assinatura antes de confirmar a assinatura. O signatário só pode usar esta rota se o modo de posicionamento estiver definido como SIGNER (veja PUT .../:uuid/signers/:signerUuid/placement-mode). Autenticação: via sessionToken do signatário (extraído da URL).

Unidades suportadas

Parâmetros

string
required
Token da sessão de assinatura do signatário (extração automática da URL).
string
required
UUID do arquivo sendo assinado.
number
required
Página onde a chancela será desenhada, contando a partir de 1 (não 0).Exemplo: 1 para a primeira página, 2 para a segunda.
number
required
Distância da borda esquerda da página, na unidade declarada em unit.
number
required
Distância da borda indicada por origin (padrão: topo), na unidade de unit.
enum
required
Unidade de medida: fraction, percent, px, pt, mm, cm, in.
enum
default:"top-left"
De qual borda o top é medido:
  • top-left: medição a partir do topo (padrão, como na tela).
  • bottom-left: medição a partir do fundo.
number
Obrigatório se unit é px: largura, em pixels, com que a página foi desenhada na tela.Exemplo: se a página tem 827px de largura quando renderizada, passe 827.
number
Obrigatório se unit é px: altura, em pixels, com que a página foi desenhada na tela.

Respostas

string
UUID do signatário (extração automática da sessão).
string
UUID do arquivo.
number | null
Página gravada, contando a partir de 0. null quando não há marcação.
number | null
Fração da largura da página, a partir da borda esquerda (0..1). null quando não há marcação.
number | null
Fração da altura da página, a partir do topo (0..1). null quando não há marcação.

Erros

  • 400: Posição fora dos limites da página, página não existe no documento, ou px enviado sem as dimensões renderizadas.
  • 401: Token inválido ou ausente.
  • 404: Arquivo não encontrado neste envelope.
  • 409: Uma das seguintes condições: signatário não está em modo SIGNER, já assinou, ou o envelope força todas as assinaturas para a página final.

Exemplos

Signatário usando fração (0..1)

Signatário usando pixels do desenho renderizado

Fluxo de assinatura

  1. Signatário acessa a tela de assinatura (sessão de token).
  2. Se o modo é SIGNER, a interface mostra o gesto de arrastar a chancela.
  3. Signatário arrasta a chancela e esta rota é chamada para gravar a posição.
  4. Signatário confirma a assinatura com POST /v1/sign/:sessionToken/verification/confirm.

Importante

  • Modo requerido: rejeita com 409 se o modo não for SIGNER.
  • Após assinatura: rejeita com 409 se o signatário já assinou.
  • Configuração do envelope: rejeita se forceAllSignaturesToEndPage estiver ativada.
  • Sem ID automático: o signatário não pode escolher qual signatário está posicionando; é sempre ele próprio (extraído do token).
  • Nenhuma autorização requerida além do token: a sessão já valida a autenticidade.

Relacionado