Assinatura Incremental
Criar assinatura incremental
Cria e envia, em uma única chamada, a assinatura de PDFs que já chegam assinados, sem alterar o arquivo recebido.
POST
Criar assinatura incremental
Recebe um ou mais PDFs que já contêm assinaturas digitais, mais os signatários novos, e já envia o pedido de assinatura. Cada assinatura nova entra como revisão no fim do arquivo, e as assinaturas que já estavam dentro continuam válidas. Veja Assinatura incremental para entender as regras.
Para montar o pedido em etapas, como numa tela de cadastro, use
Cada item de
POST .../drafts.
Parâmetros
Por onde os signatários são avisados:
EMAIL, SMS ou NONE. Com EMAIL ou SMS o portal envia o convite e os lembretes. Com NONE ninguém é avisado, os links voltam na resposta para você entregar, e urlNotification passa a ser obrigatória.URL HTTPS que recebe os eventos da assinatura (
SENT, SIGNED, REFUSED, FINISHED, CANCELLED e EXPIRED). Obrigatória com notificationChannel=NONE.Os PDFs que já vêm assinados, ao menos um. Cada item:
filename(string, obrigatório): nome do arquivo.content(string): o PDF em base64.url(string): URL de onde baixar o PDF.
content ou url, não os dois.Os signatários novos. Cada item:
name(string, obrigatório): nome completo.email(string, obrigatório): e-mail.cpf(string, obrigatório): CPF, com ou sem pontuação.placementMode(enum, obrigatório):OPERATORouSIGNER. ComOPERATORvocê manda a posição da chancela agora, empositions. ComSIGNERo próprio signatário posiciona a chancela antes de assinar.positions(array): obrigatório comOPERATOR, uma posição para cada documento do pedido. Veja abaixo.signatureType(enum):ICP_BRASIL,MFA_EMAIL,MFA_SMS,LIVENESS,MFA_EMAIL_LIVENESSouMFA_SMS_LIVENESS. Padrão:ICP_BRASIL.qualification(string): qualificação impressa na chancela, ex.:"Tomador".phoneCountryCode(string): DDI, ex.:"55".phoneNumber(string): celular com DDD. Obrigatório nos tipos por SMS.queueOrder(number): ordem na fila. Padrão: a posição na lista, a partir de 1.
Cada item de positions
Respostas
Identificador da assinatura incremental. Use-o em
GET /signer/v1/envelopes/:uuid.Os signatários, cada um com
signerUuid, email e signUrl, o link da página de assinatura. Com EMAIL ou SMS o portal já enviou o link; com NONE, entregar é com você.Erros
Veja Autenticação e erros.- 400: Corpo inválido, vencimento no passado, posição faltando para algum documento, tipo de assinatura desconhecido ou PDF ilegível.
- 401: Nem
x-api-keynemAuthorizationválidos. - 422: O documento não aceita assinatura nova: certificado como “nenhuma alteração permitida” (DocMDP
/P 1), protegido por senha ou com estrutura que impede a revisão incremental.
Exemplo
Importante
- O arquivo recebido não muda. Não há conversão para PDF/A nem página de manifesto.
- Toda chancela precisa de lugar. Com
OPERATOR, mande uma posição para cada documento; comSIGNER, o signatário posiciona antes de assinar. - O portal assina no fim. Quando o último signatário assina, o portal assina cada documento com o certificado do assinador, de forma invisível.
Relacionado
- Assinatura incremental: regras e limitações
POST .../drafts: criar em etapasGET /signer/v1/envelopes: listar, comincremental=true