These docs are for v2.0. Click to read the latest docs for v3.2.

Visualizar signatário

GET api/v3/envelopes/{{envelopeid}}/signers

📘

Requisição para visualizar dados de signatário já criado na Clicksign. Essa é uma requisição GET para /envelopes/{{envelopeid}}/signers. Em Authorizationadicione o access token de sua conta. No body, deverão ser enviados os atributos listados abaixo.

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

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

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

Response

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json; charset=utf-8
{
   "data":[
      {
         "id":"8860fa83-d15c-4c3f-8c37-26977713bbb9",
         "type":"signers",
         "links":{
            "self":"https://3.clicksign.dev/api/v3/envelopes/6bbdda29-5a14-4767-bf22-cd69f6547122/signers/8860fa83-d15c-4c3f-8c37-26977713bbb9"
         },
         "attributes":{
            "name":"João Silva",
            "birthday":"1984-10-22",
            "email":"[email protected]",
            "phone_number":"37988562143",
            "has_documentation":true,
            "documentation":null,
            "refusable":true,
            "group":3,
            "communicate_events":{
               "document_signed":"email",
               "signature_request":"none",
               "signature_reminder":"email"
            },
            "created":"2023-08-04T15:36:08.657-03:00",
            "modified":"2023-08-04T15:36:08.657-03:00"
         }
      }
   ],
   "meta":{
      "record_count":1
   },
   "links":{
      "first":"https://3.clicksign.dev/api/v3/envelopes/6bbdda29-5a14-4767-bf22-cd69f6547122/signers?page%5Bnumber%5D=1&page%5Bsize%5D=20",
      "last":"https://3.clicksign.dev/api/v3/envelopes/6bbdda29-5a14-4767-bf22-cd69f6547122/signers?page%5Bnumber%5D=1&page%5Bsize%5D=20"
   }
}