Skip to main content
PUT
Definir signatários da assinatura incremental
Define a lista completa de signatários. A chamada substitui a lista anterior inteira, e com ela o modo de posicionamento e as posições já marcadas. Todos entram com a chancela posicionada pelo próprio signatário (SIGNER); troque no passo seguinte com placement-mode. Não muda o estado do rascunho: depois, chame advance.

Parâmetros

string
required
UUID da assinatura incremental em rascunho.
array
required
Signatários, ao menos um. Cada item:
  • name (string, obrigatório): nome completo.
  • email (string, obrigatório): e-mail.
  • cpf (string, obrigatório): CPF, com ou sem máscara.
  • signatureType (enum): ICP_BRASIL, MFA_EMAIL, MFA_SMS, LIVENESS, MFA_EMAIL_LIVENESS ou MFA_SMS_LIVENESS. Padrão: ICP_BRASIL.
  • qualification (string): qualificação, ex.: "Contratante".
  • birthDate (string): data de nascimento, AAAA-MM-DD.
  • phoneCountryCode (string): DDI, ex.: "55".
  • phoneNumber (string): celular com DDD. Obrigatório nos tipos por SMS.
  • queueOrder (integer): ordem na fila. Padrão: a posição na lista, a partir de 1.
  • liveness (object): prova de vida já feita, com sessionId (sessão do Hub de Liveness) e/ou imageBase64 (foto feita no seu sistema, JPEG ou PNG, até 5 MB). Com ela, o link de assinatura não pede a captura de novo. No modo incremental não há manifesto, então a foto fica registrada no portal e não sai no documento.

Respostas

array
A lista gravada. Cada item tem signerUuid, name, email, cpf (só dígitos), signatureType, livenessSource (HUB, EXTERNAL ou null) e livenessImagePath.

Erros

Veja Autenticação e erros.
  • 400: Lista vazia, CPF inválido ou repetido, tipo de assinatura desconhecido, ou tipo por SMS sem phoneNumber.
  • 404: Não existe assinatura incremental com este uuid no seu projeto. Um envelope comum também responde 404 aqui: ele se edita pelas rotas de /signer/v1/envelopes.
  • 409: A assinatura já foi enviada.

Exemplo

Veja os tipos de assinatura em Assinatura incremental.