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:key
a 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
Atributo | Descrição | Exemplo |
---|---|---|
key | Chave 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 |
email | E-mail do signatário que deverá assinar o documento. | [email protected] |
phone_number | Número de telefone para o envio do SMS. | 11987654321 |
auths | Tipo de autenticação para realizar assinatura. | [ "sms" ] |
name | Nome completo do signatário. | Marcos Zumba |
documentation | CPF do signatário. | 123.321.123-40 |
birthday | Data de nascimento do signatário. | 1983-03-31 |
has_documentation | Solicita 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 |
delivery | Informa como o signatário receberá as notificações de confirmação de assinatura e de documento finalizado. | |
created_at | Data de criação do signatário. | 2018-06-21T16:47:32.123Z |
updated_at | Data 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 falharSempre 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.
Updated about 1 month ago