Esta seção da documentação descreve detalhadamente os campos utilizados nas requisições e respostas da API, juntamente com as regras de negócio associadas a cada um deles. Aqui, você encontrará informações sobre:

Definições dos campos: Nome, tipo de dado e formato esperado.
Validações aplicadas: Regras obrigatórias, valores permitidos, e limites de tamanho ou intervalo.
Dependências e relações: Campos que dependem de outros ou influenciam o comportamento da API.
Comportamento padrão: Valores atribuídos automaticamente e tratamento de dados opcionais.

Nosso objetivo é garantir que você tenha uma compreensão clara de como interagir com os campos da API e evitar erros comuns durante a integração. Certifique-se de consultar esta seção ao construir ou validar suas requisições.

Campos e Regras de Negócio:

Descrição dos Campos

Campo	Descrição	Exemplo	Tipo
name	O nome do signatário, usado para identificá-lo	Marcos Zumba	string
email	E-mail do signatário que deverá assinar o documento.	[email protected]	string
phone_number	Número de telefone do signatário, que deve possuir 10 ou 11 números.	11987654321	string
has_documentation	Define se serão solicitados os campos `CPF` e `Data de Nascimento` do signatário. Útil para signatários que não possuem CPF.	true	boolean
documentation	CPF do signatário.	123.321.123-40	string
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. O formato deverá ser AAAA-MM-DD. É necessário enviar uma data válida.	1983-03-31	date
refusable	Determina se o signatário pode recusar o documento.	false	boolean
group	Determina em qual grupo o signatário deve ser vinculado, conforme ordem de assinatura.	1	integer
location_required_enabled	Determina se o signatário deve compartilhar sua localização no momento da assinatura.	true	boolean
communicate_events	Objeto responsável por definir a comunicação com o signatário.		object
signature_host	Anfitrião de um processo de assinatura presencial		object

Regras de Negócio para os campos

Campo	Regras de Negócio
name	Informe ao menos um `Nome` e um `Sobrenome`. Não permite o envio de números.
has_documentation	Se for informado `false`, não é possível enviar os campos `documentation` e `birthday`.
group	Quando houver signatários em grupos diferentes, os signatários de grupos superiores só poderão assinar após todos os signatários dos grupos anteriores terem assinado.\ - Apenas é possível notificar os signatários do grupo ativo, os outros são notificados automaticamente quando os signatários dos grupos anteriores tiverem assinado.
communicate_events	signature_request: Indica como a Clicksign deve comunicar ao signatário a solicitação de assinatura do documento Valores possíveis: `email`, `sms`, `whatsapp`, `none`. Padrão: `email`. signature_reminder: Determina como os lembretes serão entregues, conforme intervalo configurado no atributo `remind_interval` na criação do Envelope . Valores possíveis: `none`, `email`. Padrão: `email`. document_signed: Indica como a Clicksign deve comunicar ao signatário para enviar o documento que foi assinado por todos os signatários. Valores possíveis: `email`, `whatsapp`. Padrão: `email`.
signature_host	name: Indica o Nome do "Anfitrião" do processo de assinatura. Padrão: `null`. email: E-mail do "Anfitrião" do processo de assinatura do documento. Padrão: `null`. communicate_events: Indica se o Anfitrião deve ser notificado via email. Tipo de dado: `{ "signature_host_signature_request": "email" }`. Padrão: `{}`.

Regras dos campos para a Criação

Campo	Obrigatório	Disponível	Valor Padrão
email	Apenas se houver valores de `email`.	SIM	null
phone_number	Apenas se houver valores de `sms`ou `whatsapp`.	SIM	null
has_documentation	NÃO	SIM	true
documentation	NÃO	SIM	null
birthday	NÃO	SIM	null
refusable	NÃO	SIM	false
group	NÃO	SIM	1
location_required_enabled	NÃO	SIM	false
communicate_events	NÃO	SIM	¹
signature_host	Apenas se houver requisito de Assinatura Presencial (`presential`)	SIM	{}

Valor padrão para communicate_events¹

{
  "signature_request":"email",
  "signature_reminder":"email",
  "document_signed":"email"
}

Conte com a nossa ajuda!

Estamos comprometidos em fornecer a você todas as ferramentas necessárias para simplificar e aprimorar seus processos de assinatura eletrônica. Não hesite em nos contatar se tiver alguma dúvida ou precisar de assistência adicional. Se precisar, entre em contato com nosso Time de Suporte.