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	Tipo
email	Email do observador e onde será notificado.	string
kind	Define se o observador será notificado em todo o processo ou apenas na conclusão. Os valores possíveis são: `all_steps` ou `on_finished`.	string
communicate_events	Objeto responsável por comunicar eventos ao observador. Para saber mais sobre os atributos desse objeto, acesse a seção Comunicação de eventos.	json¹
attach_documents_enabled	Determina se o observador deve receber os documentos finalizados.	boolean

Valor padrão para communicate_events¹ quando kind for all_steps


{
  "signature_watcher_document_sent":"email",
  "signature_watcher_document_signed":"email",
  "signature_watcher_document_deadline":"email",
  "signature_watcher_document_canceled":"email",
  "signature_watcher_envelope_closed":"email"
}

Comunicação de Eventos

Vamos detalhar os tipos de comunicações possíveis para um observador e em qual momento nós realizamos as comunicações, desta forma é possível controlar os eventos de notificação desejados.

signature_watcher_document_sent: Indica como a Clicksign deve comunicar ao observador que ele irá acompanhar a assinatura do documento.
signature_watcher_document_signed: Indica como a Clicksign deve comunicar ao observador que o documento foi assinado por um dos signatários.
signature_watcher_document_deadline: Indica como a Clicksign deve comunicar ao observador que o documento está próximo de atingir a data limite de assinatura.
signature_watcher_document_canceled: Indica como a Clicksign deve comunicar ao observador que o documento foi cancelado.
signature_watcher_envelope_closed: Indica como a Clicksign deve comunicar ao observador que o documento foi finalizado.

Regras de Negócio para os campos

Campo	Regras de Negócio
kind	Valores possíveis: all_steps on_finished

Campo

Regras de Negócio

kind

Valores possíveis:

all_steps
on_finished

Regras dos campos para a Criação

Campo	Obrigatório	Disponível	Valor Padrão
email	SIM	SIM
kind	SIM	SIM
communicate_events	NÃO	SIM
attach_documents_enabled	NÃO	SIM	`false`

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. Estamos sempre disponíveis através do e-mail [email protected].