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

Visualizar signatário

GET /api/v1/signers/:key

📘

Requisição para a visualização dos metadados dos signatários na Clicksign. Essa é uma requisição GET para /api/v1/signers/:key, sendo :keya chave do signatário na Clicksign.

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

Signer: atributos do signatário

AtributoDescriçãoExemplo
keyChave do signatário. Essa chave é utilizada para adicionar esse signatário aos documentos e na requisição para criação de assinatura em lote.0a122d4c-b3e7-44dc-9e3c-518a30f1ffbf
emailE-mail do signatário que deverá assinar o documento.[email protected]
phone_numberNúmero de telefone para o envio do SMS.11987654321
authsTipo de autenticação para realizar assinatura.[ "sms" ]
nameNome completo do signatário.Marcos Zumba
documentationCPF do signatário.123.321.123-40
birthdayData de nascimento do signatário.1983-03-31
has_documentationSolicita ou não os campos CPF e data de nascimento do signatário no momento da assinatura. Útil para signatários que não possuem CPF.true
deliveryInforma como o signatário receberá as notificações de confirmação de assinatura e de documento finalizado.email
created_atData de criação do signatário.2018-06-21T16:47:32.123Z
updated_atData de atualização do signatário.2018-06-21T16:47:32.123Z
{
  "signer": {
    "key": "935be7d1-b181-444f-8adc-bbff0b9ba48b",
    "email": "[email protected]",
    "phone_number": "11999999999",
    "auths": [
      "email"
    ],
    "name": "Marcos Zumba",
    "documentation": "123.321.123-40",
    "birthday": "1983-03-31",
    "has_documentation": true,
    "delivery": "email",
    "created_at": "2018-06-21T16:47:32.123Z",
    "updated_at": "2018-06-21T16:47:32.123Z"
  }
}
❗️

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.