📘
Requisição para permitir a vincular signatário na lista de assinatura presencial. Esta é uma requisição POST para /api/v1/lists. No body, deverão ser enviados os atributos do signatário e do documento.

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

Atributos para vincular os signatários na lista de assinatura presencial

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: `sign`: Assinar `approve`: Assinar para aprovar `party`: Assinar como parte `witness`: Assinar como testemunha `intervening`: Assinar como interveniente `receipt`: Assinar para acusar recebimento `endorser`: Assinar como endossante `endorsee`: Assinar como endossatário `administrator`: Assinar como administrador `guarantor`: Assinar como avalista `transferor`: Assinar como cedente `transferee`: Assinar como cessionário `contractee`: Assinar como contratada `contractor`: Assinar como contratante `joint_debtor`: Assinar como devedor solidário `issuer`: Assinar como emitente `manager`: Assinar como gestor `buyer`: Assinar como parte compradora `seller`: Assinar como parte vendedora `attorney`: Assinar como procurador `legal_representative`: Assinar como representante legal `co_responsible`: Assinar como responsável solidário `validator`: Assinar como validador `ratify`: Assinar para homologar `lessor`: Assinar como locador `lessee`: Assinar como locatário `surety`: Assinar como fiador `employer`: Assinar como empregador `employee`: Assinar como empregado `consenting`: Assinar como anuente `accountant`: Assinar como contador `debtor`: Assinar como devedor `franchisee`: Assinar como franqueado `broker`: Assinar como corretor `creditor`: Assinar como credor `franchisor`: Assinar como franqueador `insured`: Assinar como segurado `grantor`: Assinar como outorgante `president`: Assinar como presidente `partner`: Assinar como sócio `comforter`: Assinar como comodante `account_holder`: Assinar como correntista `distracted`: Assinar como distratado `distracting`: Assinar como distratante `lender`: Assinar como mutuante `associate`: Assinar como associado É permitido adicionar um mesmo signatário diversas vezes a um documento, desde que com `sign_as` diferentes. No momento da assinatura, ele realizará todas as assinaturas de uma única vez.	sign
`group`	Determina a qual grupo o signatário é vinculado.	1

❗️
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/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": "validator",
    "group": "1"
  }
}

Response

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8
{
  "list": {
        "key": "fbd989e1-319a-4e25-9360-b2448fd05bb2",
        "request_signature_key": "bf2e8af2-bfed-42c7-b848-06ebab422da6",
        "document_key": "27b02527-a576-46ee-b01c-bb4e694036c4",
        "signer_key": "79301388-9567-4320-90ce-9e6f60e70d28",
        "sign_as": "validator",
        "refusable": false,
        "created_at": "2022-12-20T11:24:39.281-03:00",
        "updated_at": "2022-12-20T11:24:39.281-03:00",
        "url": "https://app.clicksign.com/sign/bf2e8af2-bfed-42c7-b848-06ebab422da6"
    }
}

📘
Passo 3/3
Permitir a assinatura presencial de signatários