📘
Requisição para adicionar um signatário a um documento na Clicksign. Esta é uma requisição POST para /api/v1/lists. No body, deverão ser enviados os atributos chave do documento, chave do signatário e como o signatário assinará o documento.

POST /api/v1/lists?access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json

Atributos

Atributo	Descrição	Exemplo
`document_key` Obrigatório	Chave única do documento dentro da Clicksign.	27b02527-a576-46ee-b01c-bb4e694036c4
`signer_key` Obrigatório	Chave única do signatário dentro da Clicksign.	79301388-9567-4320-90ce-9e6f60e70d28
`sign_as` Obrigatório	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 `signed`: Apenas assinou `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.	sign
`group`	Determina o grupo que o signatário deve ser vinculado. Deve ser número, inteiro e maior que 0. O parâmetro funciona com `sequence_enabled` como `true`. Não adicione esse parâmetro caso não deseje uma ordenação de assinaturas.	1
`message`	Mensagem que será enviada no body do e-mail de solicitação de assinatura aos signatários. Utilize `\n` para quebra de linha. O parâmetro funciona com `sequence_enabled` como `true` e `group` é obrigatório. Caso não esteja utilizando ordenação de assinaturas, disponibilize a mensagem conforme seção Notificações. Utilize também este atributo para inserir uma mensagem no e-mail enviado por meio dos lembretes automáticos, mesmo que o documento não tenha ordenação de assinaturas.	Por favor, assine o documento.
`refusable`	Determina se o signatário pode recusar ou não a assinatura do documento. O parâmetro funciona como `true`/`false` Por padrão ele está configurado como `false`.	false

❗️
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

Request

POST /api/v1/lists?access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json

{
  "list": {
    "document_key": "27b02527-a576-46ee-b01c-bb4e694036c4",
    "signer_key": "79301388-9567-4320-90ce-9e6f60e70d28",
    "sign_as": "sign",
    "refusable": true,
    "group": 1,
    "message": "Prezado João,\nPor favor assine o documento.\n\nQualquer dúvida estou à disposição.\n\nAtenciosamente,\nGuilherme Alvez"
  }
}

Response

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8

{
  "list": {
    "key": "4a84a059-fbce-4a61-a887-dfff4a94f409",
    "request_signature_key": "7fb6585e-a835-44af-83ec-9d2a5a25e593",
    "document_key": "27b02527-a576-46ee-b01c-bb4e694036c4",
    "signer_key": "79301388-9567-4320-90ce-9e6f60e70d28",
    "sign_as": "sign",
    "refusable": true,
    "created_at": "2020-07-13T13:36:11.626-03:00",
    "updated_at": "2020-07-13T13:36:11.626-03:00",
    "url": "https://sandbox.clicksign.com/sign/7fb6585e-a835-44af-83ec-9d2a5a25e593",
    "group": 1,
    "message": "Prezado João,\nPor favor assine o documento.\n\nQualquer dúvida estou à disposição.\n\nAtenciosamente,\nGuilherme Alvez"
  }
}