Destacar Cláusulas em um Documento (API)
Esta seção da API D4Sign permite que você cadastre informações de texto para serem destacadas em um documento para um signatário específico. Isso é útil para chamar a atenção do signatário para cláusulas importantes que precisam de revisão ou reconhecimento especial.
🚧 Importante: Não esqueça de enviar o tokenAPI e cryptKey em sua requisição.
Exemplo: https://secure.d4sign.com.br/api/v1/documents/{UUID-DOCUMENT}/addhighlight?tokenAPI={SEU-TOKEN}&cryptKey={SEU-CRYPT-KEY}
Este endpoint irá cadastrar o texto de uma cláusula para que ela seja destacada para um signatário específico em um documento.
POST /documents/{UUID-DOCUMENT}/addhighlight
Parâmetros de Requisição (URL)
Parâmetro |
Descrição |
|
(obrigatório) O UUID do documento onde a cláusula será destacada. |
Header
{
"Content-Type": "application/json"
}
Body
Parâmetro |
Descrição |
|
Chave do signatário (pode ser obtida ao listar os signatários do documento). |
|
(obrigatório) E-mail do signatário previamente cadastrado no documento. |
|
A cláusula (texto) que será destacada para o signatário. |
{
"key_signer": "NwYj=",
"email": "seusignatario@email.com",
"text": "Cláusula que será destacada"
}
Resposta
Em caso de sucesso, a resposta confirmará que a cláusula foi cadastrada para destaque.
{
"success": 1,
"email": "seusignatario@email.com",
"key_signer": "ODkyMzI0",
"text": "Cláusula que será destacada"
}