📘
Requisição para criar um novo requisito em um envelope na plataforma Clicksign. Um requisito é uma condição que deve ser cumprida por um signatário para que ele possa assinar. O requisito de qualificação serve para indicar como o signatário deve assinar o documento. 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 agree. Sim agree agree

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 `agree`.	Sim	`agree`	agree
`role`	A que título será realizada a assinatura. Opções: `account_holder`: Assinar como correntista `accountant`: Assinar como contador `administrator`: Assinar como administrador `approve`: Assinar para aprovar `associate`: Assinar como associado `attorney`: Assinar como procurador `bailee`: Assinar como fiel depositário `borrower`: Assinar como comodatário `broker`: Assinar como corretor `building_manager`: Assinar como síndico(a) `buyer`: Assinar como parte compradora `co_responsible`: Assinar como responsável solidário `collateral_provider`: Assinar como caucionante `comforter`: Assinar como comodante `condominium_member`: Assinar como condômino `consented`: Assinar como anuído `consenting`: Assinar como anuente `consenting_intervenor`: Assinar como interveniente anuente `consignee`: Assinar como consignatário, `contractee`: Assinar como contratada `contractor`: Assinar como contratante `creditor`: Assinar como credor `debtor`: Assinar como devedor `director`: Assinar como diretor(a) `distracted`: Assinar como distratado `distracting`: Assinar como distratante `employee`: Assinar como empregado `employer`: Assinar como empregador `endorsee`: Assinar como endossatário `endorser`: Assinar como endossante `franchisee`: Assinar como franqueado `franchisor`: Assinar como franqueador `grantee`: Assinar como outorgado `grantor`: Assinar como outorgante `guarantor`: Assinar como avalista `guarantor_spouse`: Assinar como cônjuge do fiador `insurance_broker`: Assinar como corretor de seguros `insured`: Assinar como segurado `intermediary`: Assinar como intermediário(a) `intervening`: Assinar como interveniente `intervening_guarantor`: Assinar como interveniente garantidor `issuer`: Assinar como emitente `joint_debtor`: Assinar como devedor solidário `lawyer`: Assinar como advogado `legal_guardian`: Assinar como responsável legal `legal_representative`: Assinar como representante legal `lender`: Assinar como mutuante `lessee`: Assinar como locatário `lessor`: Assinar como locador `licensed`: Assinar como licenciada `licensor`: Assinar como licenciante `manager`: Assinar como gestor `owner`: Assinar como proprietário(a) `partner`: Assinar como sócio `party`: Assinar como parte `pledged`: Assinar como consignado `president`: Assinar como presidente `ratify`: Assinar para homologar `real_estate_broker`: Assinar como corretor de imóveis `receipt`: Assinar para acusar recebimento `resident`: Assinar como morador(a) `secretary`: Assinar como secretário(a) `secured`: Assinar como afiançado `seller`: Assinar como parte vendedora `service_provider`: Assinar como prestador(a) de serviços `sign`: Apenas assinar `surety`: Assinar como fiador `surveyor`: Assinar como vistoriador `transferee`: Assinar como cessionário `transferor`: Assinar como cedente `treasurer`: Assinar como tesoureiro(a) `validator`: Assinar como validador `witness`: Assinar como testemunhaÉ permitido adicionar um mesmo signatário diversas vezes a um documento, desde que com `role` diferentes. No momento da assinatura, ele realizará todas as assinaturas de uma única vez.	Sim	Sem valor padrão	partner

role

A que título será realizada a assinatura.

Opções:

account_holder: Assinar como correntista
accountant: Assinar como contador
administrator: Assinar como administrador
approve: Assinar para aprovar
associate: Assinar como associado
attorney: Assinar como procurador
bailee: Assinar como fiel depositário
borrower: Assinar como comodatário
broker: Assinar como corretor
building_manager: Assinar como síndico(a)
buyer: Assinar como parte compradora
co_responsible: Assinar como responsável solidário
collateral_provider: Assinar como caucionante
comforter: Assinar como comodante
condominium_member: Assinar como condômino
consented: Assinar como anuído
consenting: Assinar como anuente
consenting_intervenor: Assinar como interveniente anuente
consignee: Assinar como consignatário,
contractee: Assinar como contratada
contractor: Assinar como contratante
creditor: Assinar como credor
debtor: Assinar como devedor
director: Assinar como diretor(a)
distracted: Assinar como distratado
distracting: Assinar como distratante
employee: Assinar como empregado
employer: Assinar como empregador
endorsee: Assinar como endossatário
endorser: Assinar como endossante
franchisee: Assinar como franqueado
franchisor: Assinar como franqueador
grantee: Assinar como outorgado
grantor: Assinar como outorgante
guarantor: Assinar como avalista
guarantor_spouse: Assinar como cônjuge do fiador
insurance_broker: Assinar como corretor de seguros
insured: Assinar como segurado
intermediary: Assinar como intermediário(a)
intervening: Assinar como interveniente
intervening_guarantor: Assinar como interveniente garantidor
issuer: Assinar como emitente
joint_debtor: Assinar como devedor solidário
lawyer: Assinar como advogado
legal_guardian: Assinar como responsável legal
legal_representative: Assinar como representante legal
lender: Assinar como mutuante
lessee: Assinar como locatário
lessor: Assinar como locador
licensed: Assinar como licenciada
licensor: Assinar como licenciante
manager: Assinar como gestor
owner: Assinar como proprietário(a)
partner: Assinar como sócio
party: Assinar como parte
pledged: Assinar como consignado
president: Assinar como presidente
ratify: Assinar para homologar
real_estate_broker: Assinar como corretor de imóveis
receipt: Assinar para acusar recebimento
resident: Assinar como morador(a)
secretary: Assinar como secretário(a)
secured: Assinar como afiançado
seller: Assinar como parte vendedora
service_provider: Assinar como prestador(a) de serviços
sign: Apenas assinar
surety: Assinar como fiador
surveyor: Assinar como vistoriador
transferee: Assinar como cessionário
transferor: Assinar como cedente
treasurer: Assinar como tesoureiro(a)
validator: Assinar como validador
witness: Assinar como testemunhaÉ permitido adicionar um mesmo signatário diversas vezes a um documento, desde que com role diferentes. No momento da assinatura, ele realizará todas as assinaturas de uma única vez.

Sim

Sem valor padrão

partner

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": "agree",
        "role": "intervening"
    },
    "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": "agree",
            "role": "intervening",
            "created": "2023-07-04T11:54:24.632-03:00",
            "modified": "2023-07-04T11:54:24.632-03:00"
        }
    }
}