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.
| Campo | Descrição | Tipo |
|---|
| status | A alteração desse campo determina a ativação do Envelope e está disponível apenas na atualização do envelope (update) | string |
| name | Define o nome do Envelope. | string |
| locale | Determina o idioma do documento. Os e-mails, página de assinatura e log do documento assinado estarão no idioma definido. | string |
| auto_close | Determina se o documento será finalizado automaticamente logo após a assinatura do último signatário. | boolean |
| remind_interval | Determina se o documento terá opção de lembretes automáticos ativada. O intervalo é medido em dias. Com a inclusão do parâmetro serão enviados até três lembretes automaticamente. | integer |
| block_after_refusal | Determina se o processo de assinatura tem que ser pausado ou não após um signatário ter recusado. | boolean |
| deadline_at | Data limite para a realização das assinaturas dos documentos relacionados. Documento será finalizado automaticamente quando a data limite for atingida. Se houver assinaturas, o Documento ficará com o status finalizado, caso contrário, o documento será cancelado. | datetime |
| default_subject | Define o assunto do e-mail que será enviado aos signatários na solicitação de assinatura. | string |
| default_message | Define a mensagem padrão que será enviada aos signatários. | string |
| Campo | Regras de Negócio |
|---|
| status | Valores possíveis: draft, running, canceled, closed. |
| locale | Valores possíveis: pt-BR, en-US. |
| auto_close | Valores possíveis: true, false. |
| remind_interval | Valores possíveis: null, 1, 2, 3, 7, 14. |
| block_after_refusal | Valores possíveis: true, false. |
| deadline_at |
- Data limite máxima é de 90 dias contados a partir do upload.
- Uma vez cancelado, o processo não pode ser retomado.
- O valor deve ser maior que a data/hora atual.
|
| default_subject |
- Se esse atributo não for informado, o assunto padrão será enviado.
- Há um limite de 100 caracteres.
|
| default_message |
- É possível enviar uma mensagem específica para cada signatário usando o parâmetro message ao disparar notificação de signatário.
- A mensagem informada no parâmetro message terá prioridade sobre a mensagem definida no atributo default_message.
|
| Campo | Obrigatório | Disponível | Valor Padrão |
|---|
| status | | NÃO | |
| name | SIM | SIM | |
| locale | NÃO | SIM | pt-BR |
| auto_close | NÃO | SIM | true |
| remind_interval | NÃO | SIM | 3 |
| block_after_refusal | NÃO | SIM | false |
| deadline_at | NÃO | SIM | datetime + 30 dias |
| default_subject | NÃO | SIM | null |
| default_message | NÃO | SIM | "" |
| Campo | Obrigatório | Disponível |
|---|
| status | NÃO | SIM |
| name | | NÃO |
| locale | NÃO | SIM |
| auto_close | NÃO | SIM |
| remind_interval | NÃO | SIM |
| block_after_refusal | NÃO | SIM |
| deadline_at | NÃO | SIM |
| default_subject | NÃO | Disponível apenas quando o estado é draft |
| default_message | NÃO | SIM |
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].
