Doc

Classe para a criação de documentos

Propriedades:

nometipodescrição

sandbox

boolean

Se verdadeiro, o documento será um teste e não terá validade jurídica.

name

string

nome do documento

lang

string

idioma do documento. Valores possíveis: "pt-br" (português), "es" (espanhol), "en" (inglês). Default: "pt-br"

disable_signer_emails

boolean

para desativar os e-mails enviados aos signatários, envie esse parâmetro como true. Default: false

signed_file_only_finished

boolean

para desativar os botões "Baixar original" e "Baixar assinado" da experiência de signatário, ative este flag. Assim, você é quem se encarregará de entregar o signed_file ao signatário. Default: false

brand_logo

string

se deseja personalizar a logomarca da experiência de assinatura deste documento específico, envie a URL da imagem (precisa ser um link publicamente acessível). Default: ""

brand_primary_color

string

se deseja personalizar a cor primária (do botão) da experiência de assinatura deste documento específico, envie em rgb ou hexadecimal. Ex: "#0011ee". Default: ""

brand_name

string

se deseja personalizar o nome do remetente dos e-mails enviados ao signatário, insira aqui o nome da marca. Por exemplo, se inserido "XPTO Advogados", o remetente do e-mail será "XPTO Advogados via ZapSign". Max-length: 100 caracteres. Default: ""

external_id

string

ID do documento na sua aplicação. Default: ""

folder_path

string

caminho da pasta dentro da ZapSign em que o documento será colocado. Se as pastas não existirem, serão criadas automaticamente. Requisitos: (1) o folder_path pode ter até 255 caracteres, (2) cada pasta pode ter até 50 caracteres, (3) há um limite de 5 níveis de pasta. Ex.: "/api/" ou "/pasta1/pasta2/pasta3/". Default: "/" (sem pasta).

date_limit_to_sign

Date

Data limite para assinatura do documento. (Formatos aceitos: YYYY-MM-DD, YYYY-MM-DDTH:m:s.ssssssZ)

signature_order_active

boolean

Se verdadeiro, as assinaturas do signatário serão solicitadas sequencialmente. Default: false

observers

string[]

Representa os observadores do documento (limite de 20), ou seja, endereços de e-mails que serão notificados após a conclusão do fluxo de assinatura. É um array de strings.

signers

Representa os signatários do documento

reminder_every_n_days

number

Representa o intervalo de dias entre os lembretes que serão enviados para os signatários.

created_by

contem quem criou o documento

Last updated