PUT Update request signing chain

Edita a cadeia de signatários de uma solicitação pendente e encadeada (enviada com chain: true). As operações são executadas na ordem enviada: update troca o e-mail de um signatário, remove retira um signatário, add insere um novo signatário (com seus campos) e update_additional_info altera nome, CPF ou data de nascimento.

Solicitações não encadeadas, não pendentes ou de outra empresa respondem 404; operações inválidas (e-mail fora da cadeia, por exemplo) respondem 422.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Atualização da cadeia de assinatura

Exemplos

Substituir o e-mail de um signatário (update)

{
  "signing_key": "SUA_CHAVE_AQUI",
  "operations": [
    { "action": "update", "target_email": "[email protected]", "new_email": "[email protected]" }
  ]
}

Adicionar um signatário no fim da cadeia (add)

{
  "signing_key": "SUA_CHAVE_AQUI",
  "operations": [
    {
      "action": "add",
      "new_email": "[email protected]",
      "after_email": "last",
      "fullname": "João da Silva",
      "cpf": "11111111111",
      "fields": [
        { "type": "signature", "page": 1, "xPos": 100, "yPos": 500, "width": 200, "height": 60 }
      ]
    }
  ]
}

after_email aceita um e-mail já presente na cadeia, beginning (início) ou last (fim). Quando fields não é informado, as posições dos campos são copiadas do signatário anterior.

Remover um signatário (remove)

{
  "signing_key": "SUA_CHAVE_AQUI",
  "operations": [
    { "action": "remove", "target_email": "[email protected]" }
  ]
}

Atualizar os dados cadastrais de um signatário (update_additional_info)

{
  "signing_key": "SUA_CHAVE_AQUI",
  "operations": [
    { "action": "update_additional_info", "target_email": "[email protected]", "fullname": "João da Silva", "cpf": "22222222222", "birthdate": "1990-01-15" }
  ]
}

Atualizar um signatário da cadeia (update_recipient)

{
  "signing_key": "SUA_CHAVE_AQUI",
  "operations": [
    {
      "action": "update_recipient",
      "target_email": "[email protected]",
      "new_email": "[email protected]",
      "fullname": "João da Silva",
      "allow_cpf": false,
      "doubleauth": true,
      "doubleauth_cpf": "52998224725",
      "fields": [
        { "type": "signature", "page": 1, "xPos": 100, "yPos": 500, "width": 200, "height": 60 }
      ]
    }
  ]
}

update_recipient permite atualizar o signatário atual ou um próximo participante da cadeia. target_email identifica o participante e aceita e-mail ou telefone válido. new_email é opcional. A action altera somente as propriedades enviadas e não reenvia o convite. Se fields for enviado, ele substitui todas as posições do participante. subject e reminder só podem ser alterados para participantes futuros, pois o signatário atual já recebeu o convite.

Várias operações em uma única chamada

As operações são executadas na ordem enviada. É possível combinar update, add, remove, update_additional_info e update_recipient no mesmo array operations.

Resposta de sucesso (200)

{
  "message": "Cadeia de assinatura atualizada com sucesso.",
  "chain_emails": ["[email protected]", "[email protected]"],
  "warnings": []
}

Regras

  • A solicitação precisa estar com status Pending e possuir cadeia de assinatura (chain_emails); caso contrário a resposta é 404.
  • A empresa do token precisa ser a mesma da solicitação.
  • Um contato que não existe na cadeia responde 422 com a descrição do erro no campo error. update_recipient também pode localizar o signatário atual pelo contato do request.
  • remove retira o signatário de todas as listas da cadeia (e-mails, posições, opções e dados cadastrais).
  • update_additional_info altera apenas os dados cadastrais. Quando new_email é enviado nessa ação para o signatário atual, a API atualiza o contato somente nos dados adicionais e devolve um aviso em warnings. Para alterar o contato do signatário atual no request, use update_recipient ou PUT /api/requests/change-signer.
Body Params
string
required

Chave da solicitação de assinatura que será atualizada.

operations
array of objects
required
length ≥ 1

Uma ou mais operações, executadas na ordem enviada.

operations*
string
enum
required

Ação.

Allowed:
string

Contato do signatário. Obrigatório em update, remove, update_additional_info e update_recipient. Para update_recipient, pode identificar o signatário atual ou um participante futuro. Aceita e-mail ou telefone válido.

string

Novo e-mail ou telefone. Obrigatório em update e add; opcional em update_additional_info e update_recipient.

string

Insere após o contato indicado, ou use beginning ou last.

string | null

Nome completo do novo signatário. Em update_recipient, atualiza o nome do participante; null limpa o valor.

string | null

CPF do novo signatário. Em update_recipient, atualiza o CPF do participante; null limpa o valor.

string | null

Data de nascimento do novo signatário. Em update_recipient, atualiza a data de nascimento do participante; null limpa o valor.

string | null

URL HTTP ou HTTPS para redirecionamento após a assinatura. Em update_recipient, null limpa o valor.

string | null

Mensagem personalizada para o novo signatário, com até 500 caracteres. Em update_recipient, null limpa o valor.

string | null

Assunto da comunicação enviada ao novo signatário. Em update_recipient, só pode ser alterado para participantes futuros; null limpa o valor.

string | null

E-mail ou telefone usado como contato para lembrete. Em update_recipient, só pode ser alterado para participantes futuros; null limpa o valor.

boolean

Define se será permitido solicitar uma selfie.

boolean

Define se será permitido solicitar o documento (frente).

boolean

Define se será permitido solicitar o verso do documento.

boolean

Define se o CPF será exigido. Padrão para novos participantes: true.

boolean

Define se a data de nascimento será exigida. Padrão para novos participantes: true.

string | null

Tipo de assinatura do novo signatário. Em update_recipient, aceita o nome ou ID do tipo da empresa; null limpa o valor.

string

Modo de assinatura: all, draw, text ou upload.

boolean

Define se será usada autenticação dupla.

string | null

CPF válido usado como segundo fator. Exige doubleauth habilitado. Em update_recipient, null remove o CPF e mantém a autenticação convencional se doubleauth continuar habilitado.

integer

Código do certificado: 0, 1, 2 ou 3. Na cadeia, certificados tipos 0 e 1 devem vir antes dos tipos 2 e 3.

boolean

Define se será usado timestamp. Só pode ser habilitado com certificado tipo 2 ou 3.

boolean

Define a configuração de envio ao finalizar.

string | null

Data de expiração no formato YYYY-MM-DD; deve ser futura. Em update_recipient, null limpa o valor.

fields
array of objects
length ≥ 1

Lista de campos posicionados no documento. Usada quando action é add ou update_recipient. Em update_recipient, substitui todas as posições do participante.

fields
string
required

Tipo do campo: signature, text, rubric, checkbox, radio ou list.

integer

Página do documento. Informe para signature, text, checkbox, radio e list; para rubric, a API usa a página 0.

number
required

Posição horizontal do campo no documento.

number
required

Posição vertical do campo no documento.

number
required

Largura do campo.

number
required

Altura do campo.

string

Texto a exibir no campo text. Obrigatório para checkbox, radio e list.

options
array of strings
length between 1 and 50

Opções para checkbox, radio ou list. Envie textos de até 100 caracteres, sem opções repetidas.

options
number

Tamanho da fonte. O padrão é 14 para campos text com text informado.

string

Cor do texto; o padrão é #000000 para campos text com text informado.

string

Alinhamento do texto: left, center ou right.

string

Configuração de negrito para o texto.

string

Configuração de itálico para o texto.

string

Configuração de sublinhado para o texto.

string

Configuração de tachado para o texto.

string

Valor padrão do campo de texto.

boolean

Define se os dados do campo devem ser validados.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json