Basta acessar a documentação da Clicksign API 2.0 Envelope e, em Envelope, clicar em Adicionar requisito Concordância.
O que é a Rubrica eletrônica?
A Rubrica eletrônica se assemelha a rubrica nos documentos físicos. Quando solicitada ao signatário do documento, ele deverá inserir suas iniciais, que serão automaticamente distribuídas para as páginas do documento, indicando que ele está de acordo com seu conteúdo e suas cláusulas.
Como solicitar a Rubrica eletrônica via API?
Esta é uma requisição para criar um novo requisito em um envelope na plataforma Clicksign, também utilizada para configurar a funcionalidade Rubrica.
Um requisito é uma condição que deve ser cumprida por um signatário para que ele possa assinarConcordância significa que o signatário deve concordar com os termos do documento. Essa é uma requisição POST para /envelopes//requirements, sendo a variável id gerada na criação do envelope.
1. Em Authorization adicione o access token de sua conta.
2. No body, deverão ser enviados os atributos listados na documentação disponível.
Exemplo completo
Request
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Authorization: access token
"data": {
"type": "requirements",
"attributes": {
"action": "agree",
"rubric_pages": "all",
"role": "intervening"
},
"relationships": {
"document":{
"data": { "type": "documents", "id": ""}
},
"signer":{
"data": { "type": "signers", "id": ""}
}
}
}
}
Response
Content-Type: application/vnd.api+json; charset=utf-8
"data": {
"id": "3f522102-e372-49a0-ae9b-fb8babf90d5f",
"type": "requirements",
"links": {
"self": "https://3.clicksign.dev/api/v3/envelopes/62ff38bc-b8fd-4e02-a1ce-6a1ff0f502a7/requirements/3f522102-e372-49a0-ae9b-fb8babf90d5f"
},
"attributes": {
"action": "agree",
"rubric_pages": "all",
"role": "intervening",
"created": "2023-07-04T11:54:24.632-03:00",
"modified": "2023-07-04T11:54:24.632-03:00"
}
}
}
O atributo rubric_pages é o responsável por configurar a Rubrica. Ele indica quais páginas possuirão rubrica, isto é, a marcação que o signatário faz em uma ou mais páginas do documento para indicar que concorda com o seu conteúdo. Para que todas as páginas sejam rubricadas, informe o valor all. Para que páginas especificas sejam rubricadas, informe os números das páginas separadas por vírgula. 1, 4,6, por exemplo.