Skip to main content
PUT
Definir lista de signatários
Define a lista completa de signatários para o envelope. A operação substitui a lista anterior inteira (soft-deleta os antigos, insere os novos). Use quando quiser redefinir a fila de signatários no assistente. Autenticação: x-api-key no header. Também aceita Authorization: Bearer com headers de projeto/organização.

Parâmetros

string
required
UUID do envelope rascunho.
array
required
Array de signatários (mínimo 1). Cada item é um objeto com:
  • cpf (string, obrigatório) — CPF do signatário (com ou sem máscara).
  • name (string, obrigatório) — Nome completo.
  • email (string, obrigatório) — E-mail para convite e notificações.
  • signatureType (enum, obrigatório) — Tipo de assinatura: MFA_EMAIL, MFA_SMS, LIVENESS, ICP_BRASIL, MFA_EMAIL_LIVENESS, ou MFA_SMS_LIVENESS.
  • qualification (string, opcional) — Qualificação (ex.: “Contratante”, “Testemunha”).
  • birthDate (string, opcional) — Data de nascimento (formato AAAA-MM-DD).
  • phoneCountryCode (string, opcional) — Código de país do telefone (ex.: “55”).
  • phoneNumber (string, opcional) — Número de celular (obrigatório se signatureType inclui MFA_SMS).
  • queueOrder (integer, opcional) — Posição na fila (apenas para signingMode: sequential).

Respostas

array
Lista atualizada de signatários confirmados. Cada item contém: signerUuid, cpf (só dígitos), name, email, signatureType, signatureTypeName.

Erros

Veja Autenticação e erros.
  • 400: Lista vazia, CPF duplicado na mesma lista (mensagem: "O CPF X aparece mais de uma vez na lista."), CPF/e-mail/data inválidos, ou tipo SMS sem phoneNumber.
  • 404: Envelope não encontrado ou não pertence ao seu projeto.
  • 409: Envelope não está em rascunho.

Exemplo

Tipos de assinatura

Importante

  • Substitui completamente: os signatários anteriores são substituídos (soft-deletados). Não é adição incremental.
  • CPF único: o mesmo CPF não pode aparecer duas vezes na mesma lista.
  • Sem notificação ainda: ninguém é convidado nesta etapa. Invites são disparados apenas em POST .../:uuid/send.
  • Validação de e-mail: e-mails são validados; inválidos retornam 400.

Próximas etapas

  1. Defina todos os signatários.
  2. Chame POST .../:uuid/advance para ir à conferência.
  3. Depois, chame POST .../:uuid/send para enviar aos signatários.

Relacionado