📘
Requisição para criar um novo requisito em um envelope na plataforma Clicksign, utilizada para configurar a funcionalidade Rubrica. Um requisito é uma condição que deve ser cumprida por um signatário para que ele possa assinar. Rubrica é 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. Essa é uma requisição POST para /envelopes/{{envelopeid}}/requirements, sendo {{envelopeid}}a variável id gerada na criação do envelope. Em Authorization adicione o access token de sua conta. No body, deverão ser enviados os atributos listados abaixo.

POST /api/v3/envelopes/{{envelopeid}}/requirements HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Authorization: access token

Tipo de dados

Atributo	Descrição	Obrigatório
`type`	Determina o tipo de dados, que aqui deve ser `requirements`.	Sim

Atributos do requisito de qualificação

Atributo Descrição Obrigatório Padrão Exemplo

action Determina a ação que o signatário deve realizar para cumprir o requisito, que aqui deve ser rubricate. Sim rubricate rubricate

Atributo	Descrição	Obrigatório	Padrão	Exemplo
`action`	Determina a ação que o signatário deve realizar para cumprir o requisito, que aqui deve ser `rubricate`.	Sim	`rubricate`	rubricate
`pages`	Indica quais páginas possuirão rubrica. 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.	Sim	Sem valor padrão	all

pages

Indica quais páginas possuirão rubrica.

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.

Sim

Sem valor padrão

all

Relações do requisito

Em relationships deve ser indicado o signer e o document, descritos a seguir:

Atributo Descrição Obrigatório Padrão Exemplo

Atributo	Descrição	Obrigatório	Padrão	Exemplo
`document`	Um objeto com as relações do requisito com outros recursos. Em `"type": "documents", "id": "{{documentid}}"` adicione o `id` gerado ao criar o documento.	Sim	Sem valor padrão	{ "data": { "type": "documents", "id": "6793c70a-360a-42a8-966c-473998c9a2ed"} }
`signers`	Um objeto com as relações do requisito com outros recursos. Em `"type": "signers", "id": "{{signerid}}"` adicione o `id` gerado ao criar o signatário.	Sim	Sem valor padrão	{ "data": { "type": "signers", "id": "8b3ec0c2-16f8-4fb9-9c2b-cbf51abc9e87"} }

document

Um objeto com as relações do requisito com outros recursos.

Em "type": "documents", "id": "{{documentid}}" adicione o id gerado ao criar o documento.

Sim

Sem valor padrão

{
"data": { "type": "documents", "id": "6793c70a-360a-42a8-966c-473998c9a2ed"}
}

signers

Um objeto com as relações do requisito com outros recursos.

Em "type": "signers", "id": "{{signerid}}" adicione o id gerado ao criar o signatário.

Sim

Sem valor padrão

{
"data": { "type": "signers", "id": "8b3ec0c2-16f8-4fb9-9c2b-cbf51abc9e87"}
}

❗️
Se a requisição para a Clicksign falhar
Sempre verifique o BODY da resposta. O retorno da requisição mostrará o motivo pelo qual a requisição não foi aceita pelos servidores da Clicksign. Confira mais detalhes em Mensagens de erro.

Exemplo completo

Request

POST /api/v3/envelopes/{{envelopeid}}/requirements HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Authorization: access token

{
  "data": {
    "type": "requirements",
    "attributes": {
        "action": "rubricate",
      	"pages": "all"
    },
    "relationships": {
        "document":{
            "data": { "type": "documents", "id": "{{documentid}}"}
        },
        "signer":{
            "data": { "type": "signers", "id": "{{signerid}}"}
      }
    }
  }
}

Response

HTTP/1.1 201 Created
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": "rubricate",
          	"pages": "all",
            "created": "2023-07-04T11:54:24.632-03:00",
            "modified": "2023-07-04T11:54:24.632-03:00"
        }
    }
}