📘
Requisição para criar novo signatário no Envelope. Essa é uma requisição POST para /envelopes/{{envelopeid}}/signerssendo {{envelopeid}}a variável id gerada na criação do envelope. Em Authorizationadicione o access token de sua conta. No body, deverão ser enviados os atributos listados abaixo.

POST /api/v3/envelopes/{{envelopeid}}/signers HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

Tipo de dados

Atributo	Descrição	Obrigatório
`type`	Determina o tipo de dados, que aqui deve ser `signers`.	Sim

Atributos do novo signatário no Envelope

Atributo	Descrição	Obrigatório	Padrão	Exemplo
`name`	O nome do signatário, usado para identificá-lo. Necessário enviar ao menos duas palavras. Não permite o envio de números.	Não	none	João Silva
`birthday`	Data de nascimento do signatário. Se este campo for enviado, o signatário não poderá realizar a alteração da data de nascimento no momento da assinatura. Formato deverá ser AAAA-MM-DD. Necessário enviar uma data válida.	Não	none	1971-06-28
`email`	E-mail do signatário que deverá assinar o documento.	Não*	none	example@example
`phone_number`	Número de telefone do signatário, que deve possuir 11 números.	Não*	none	11987654321
`has_documentation`	Não solicita os campos CPF e data de nascimento do signatário no momento da assinatura. Útil para signatários que não possuem CPF. Se for false, não é possível enviar os campos `documentation` e `birthday`.	Não	true	false
`documentation`	CPF do signatário. Se este campo for enviado, o signatário não poderá realizar a alteração do CPF no momento da assinatura. Necessário ser um CPF válido.	Não	none	123.321.123-40
`refusable`	Determina se o signatário pode recusar o documento.	Não	false	true
`group`	Determina em qual grupo o signatário deve ser vinculado, conforme ordem de assinatura. Deve ser número, inteiro e maior que 0.	Não	1	1
`communicate_events`	Objeto responsável por comunicar eventos ao signatário. Para saber mais sobre os atributos desse objeto, acesse a seção Comunicação de eventos.	Não	email	"communicate_events": { "signature_request": "email", "signature_reminder": "email", "document_signed": "email" }

*Alguns atributos se tornam obrigatórios dependendo dos valores presentes em communicate_events. Ao adicionar o campo sms em signature_request, por exemplo, o atributo phone_number passa a ser obrigatório.

Comunicação de eventos

Em communicate_events podem ser indicados signature_request, signature_reminder e document_signed, descritos a seguir:

Atributo Descrição Obrigatório Padrão Exemplo

Atributo	Descrição	Obrigatório	Padrão	Exemplo
`signature_request`	Indica como a Clicksign deve comunicar ao signatário a solicitação de assinatura do documento. Campos válidos: `none` (nenhum comunicado), `email`, `whatsapp` ou `sms`.	Não	email	sms
`signature_reminder`	Determina como os lembretes serão entregues, conforme intervalo configurado no atributo `remind_interval` na criação do Envelope. As opções são `email` e `none`.	Não	email	none
`document_signed`	Indica como a Clicksign deve comunicar ao signatário que o documento foi assinado por todos os signatários. Campos válidos: `email` ou `whatsapp`.	Não	email	whatsapp

signature_request

Indica como a Clicksign deve comunicar ao signatário a solicitação de assinatura do documento.

Campos válidos: none (nenhum comunicado), email, whatsapp ou sms.

Não

sms

signature_reminder

Determina como os lembretes serão entregues, conforme intervalo configurado no atributo remind_interval na criação do Envelope.

As opções são email e none.

Não

none

document_signed

Indica como a Clicksign deve comunicar ao signatário que o documento foi assinado por todos os signatários.

Campos válidos: email ou whatsapp.

Não

❗️
Se a requisição para a Clicksign falhar
Sempre verifique o BODY da resposta. O retorno da requisição mostrará o motivo pelo qual a requisição não foi aceita pelos servidores da Clicksign. Confira mais detalhes em Mensagens de erro.

Exemplo completo

Request

POST /api/v3/envelopes/{{envelopeid}}/signers HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Authorization: access token

{
   "data":{
      "type":"signers",
      "attributes":{
         "name":"Pedro Silva",
         "birthday":"1992-10-20",
         "email":"[email protected]",
         "phone_number":"11977754299",
         "has_documentation":true,
         "documentation":"401.367.420-33",
         "refusable":true,
         "group":"3",
         "communicate_events":{
            "document_signed":"email",
            "signature_request":"sms",
            "signature_reminder":"email"
         }
      }
   }
}

Response

HTTP/1.1 201 Created
Content-Type: application/vnd.api+json; charset=utf-8

{
   "data":{
      "id":"8322d8ac-6feb-4107-aab7-49ee8bf31d7d",
      "type":"signers",
      "links":{
         "self":"https://3.clicksign.dev/api/v3/envelopes/9cb073ef-4de2-4630-93e6-ead5dc046837/signers/8322d8ac-6feb-4107-aab7-49ee8bf31d7d"
      },
      "attributes":{
         "name":"Pedro Silva",
         "birthday":"1992-10-20",
         "email":"[email protected]",
         "phone_number":"11977754299",
         "has_documentation":true,
         "documentation":"401.367.420-33",
         "refusable":true,
         "group":3,
         "communicate_events":{
            "document_signed":"email",
            "signature_request":"sms",
            "signature_reminder":"email"
         },
         "created":"2023-09-20T09:35:50.783-03:00",
         "modified":"2023-09-20T09:35:50.783-03:00"
      }
   }
}