Visualizar documento
GET /api/v1/documents/:key
Requisição para a visualização dos metadados dos documentos na Clicksign. Essa é uma requisição
GET
para/api/v1/documents/:key
, sendo:key
a chave do documento na Clicksign.
GET /api/v1/documents/:key?access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json
Nesta documentação, dividimos o retorno da requisição em blocos para facilitar o seu entendimento. Os blocos são:
No final, você poderá conferir um exemplo completo.
Document: atributos do documento
Atributo | Descrição | Exemplo |
---|---|---|
| Chave única do documento dentro da Clicksign. | 55fea7c2-0e5b-40dc-bacf-50fb8529f866 |
| Caminho completo do documento dentro da Clicksign. | /Pasta 1/Pasta 2/Contrato de Prestação de Serviços-123.pd |
| Nome do documento. | Contrato de Prestação de Serviços-123.pdf |
| Data de upload do documento. | 2018-06-21T16:47:32.115Z |
| Data de atualização do documento. | 2018-06-21T16:47:34.280Z |
| Data de finalização do documento. | null |
| Data limite para a realização das assinaturas no documento. | 2018-06-28T17:30:59.000Z |
| Status do documento. Possíveis valores:
| running |
| Determina se o documento será finalizado automaticamente logo após a assinatura do último signatário. | true |
| Determina o idioma do documento. Os e-mails, página de assinatura e Log do documento assinado estarão no idioma definido. | pt-BR |
| Determina se o documento terá a funcionalidade de ordenação de assinaturas ativada. | true |
| Grupo de signatários que está assinável. | 1 |
| Determina se o documento terá opção de lembretes automáticos ativada. O intervalo é medido em dias. | 3 |
| Determina se o processo de assinatura tem que ser pausado ou não após um signatário ter recusado. Valor padrão é | true |
{
"document": {
"key": "f217e111-8a16-4842-af21-644d39d9bc6f",
"path": "/Contrato de Prestação de Serviços-123.pdf",
"filename": "Contrato de Prestação de Serviços-123.pdf",
"uploaded_at": "2018-06-22T02:32:20.459Z",
"updated_at": "2018-06-22T02:33:10.763Z",
"finished_at": "2018-06-22T02:32:45.211Z",
"deadline_at": "2018-06-28T17:30:59.000Z",
"status": "closed",
"auto_close": true,
"locale": "pt-BR",
"metadata": {},
"sequence_enabled": true,
"signable_group": 1,
"remind_interval": 3,
"block_after_refusal": true
//...
}
}
Download: atributos para baixar o documento
As URLs de download têm validade de 5 minutos
Atributo | Descrição |
---|---|
| URL para download do documento original. |
| URL para download do ZIP contendo o documento original e o assinado. Disponível alguns segundos após o documento ser finalizado ou cancelado. |
| URL para download do documento assinado. Disponível alguns segundos após o documento ser finalizado ou cancelado. |
| Valor hash do arquivo assinado que mostra a soma de verificação do conteúdo. A soma de verificação ajuda a confirmar a integridade do arquivo e a identificar alterações não autorizadas. |
{
"document": {
"...",
"downloads": {
"original_file_url": "https://clicksign-content-sandbox.s3.amazonaws.com/2018/06/22/02/32/20/4939a5c3-da99-42de-8f01-800bc6b60ea4/file.pdf?X-Amz-Expires=299&X-Amz-Date=20180622T023341Z&X-Amz-Security-Token=FQoDYXdzEDsaDFeK2dVzbdrkJD3uMSK3A094xU7i6THk/K%2BYqCWqt0A8I0BEOtgRBQgX8Mc/2jotxKZyls4l%2BrXJQjVp0UyP7Au7132pFpyng1OaRIF3ZXVxkJZ%2ByzfD23kKkqnGD5MtIKBNTGJ4mbqzF8Am9hC9cVEpmRDEJUkms2XpUIz3K8QgWbYdmxK6OsUu0yoRzHWKoMKu2Bv4sL5K3AP/M7Nq7vk8zH2u3qYvlOq84sw/HAijJK25LiR8Xpfv4mmpam8BQb0Q98bHSIanPpDltcWMpyiCISPjZ1dPzW3DW/UaiKZCg11iW24fHOswrztm90Okrz761AO5L3j5HD0bJV7AMANQzCmraQrn92lj0Ih/cSjckAuctRTj%2BrmoQVOqGxUJdEEiPU/7W1Dj1KSrT2wWtEWCsT1OFO2avWoV/7wcbV9oSQoYS7TCjIWke/rp2Fl2PtlcmN66uCSLmprwba0pCE7drEaLIFfGK2HMFzL2FxxwlQDjFK6UXClqDmPos8UW1G0jCxnRSGJ8bWWAdNkt86eSIgcF5OQ6e1dRGlavHqp8yKlv8n%2BR/J5erwHySRngsETBtwfXo/dxtaG6aWtQbYWXLcxyOBUo9aSx2QU%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAIFAE6CWQID5X7YLA/20180622/us-east-1/s3/aws4_request&X-Amz-SignedHeaders=host&X-Amz-Signature=c9c111c9724f6d2705ee358eec58bbdb43534449c5e478e53245d5356074ab3d",
"signed_file_url": "https://clicksign-content-sandbox.s3.amazonaws.com/2018/06/22/02/32/49/cd797ad2-575e-46fb-bff0-d8f9117a26d7/Contrato%20de%20Presta%C3%A7%C3%A3o%20de%20Servi%C3%A7os-123%20-%20Clicksign.pdf?X-Amz-Expires=300&X-Amz-Date=20180622T023341Z&X-Amz-Security-Token=FQoDYXdzEDsaDFeK2dVzbdrkJD3uMSK3A094xU7i6THk/K%2BYqCWqt0A8I0BEOtgRBQgX8Mc/2jotxKZyls4l%2BrXJQjVp0UyP7Au7132pFpyng1OaRIF3ZXVxkJZ%2ByzfD23kKkqnGD5MtIKBNTGJ4mbqzF8Am9hC9cVEpmRDEJUkms2XpUIz3K8QgWbYdmxK6OsUu0yoRzHWKoMKu2Bv4sL5K3AP/M7Nq7vk8zH2u3qYvlOq84sw/HAijJK25LiR8Xpfv4mmpam8BQb0Q98bHSIanPpDltcWMpyiCISPjZ1dPzW3DW/UaiKZCg11iW24fHOswrztm90Okrz761AO5L3j5HD0bJV7AMANQzCmraQrn92lj0Ih/cSjckAuctRTj%2BrmoQVOqGxUJdEEiPU/7W1Dj1KSrT2wWtEWCsT1OFO2avWoV/7wcbV9oSQoYS7TCjIWke/rp2Fl2PtlcmN66uCSLmprwba0pCE7drEaLIFfGK2HMFzL2FxxwlQDjFK6UXClqDmPos8UW1G0jCxnRSGJ8bWWAdNkt86eSIgcF5OQ6e1dRGlavHqp8yKlv8n%2BR/J5erwHySRngsETBtwfXo/dxtaG6aWtQbYWXLcxyOBUo9aSx2QU%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAIFAE6CWQID5X7YLA/20180622/us-east-1/s3/aws4_request&X-Amz-SignedHeaders=host&X-Amz-Signature=d16123052bd86d907853150345f2732fe1fb5fbb4246564f7c7c14481f841260",
"ziped_file_url": "https://clicksign-content-sandbox.s3.amazonaws.com/2018/06/22/02/32/49/e0dad224-2be3-4f9a-a7df-cb1e486256a7/Contrato%20de%20Presta%C3%A7%C3%A3o%20de%20Servi%C3%A7os-123%20-%20Clicksign.zip?X-Amz-Expires=300&X-Amz-Date=20180622T023341Z&X-Amz-Security-Token=FQoDYXdzEDsaDFeK2dVzbdrkJD3uMSK3A094xU7i6THk/K%2BYqCWqt0A8I0BEOtgRBQgX8Mc/2jotxKZyls4l%2BrXJQjVp0UyP7Au7132pFpyng1OaRIF3ZXVxkJZ%2ByzfD23kKkqnGD5MtIKBNTGJ4mbqzF8Am9hC9cVEpmRDEJUkms2XpUIz3K8QgWbYdmxK6OsUu0yoRzHWKoMKu2Bv4sL5K3AP/M7Nq7vk8zH2u3qYvlOq84sw/HAijJK25LiR8Xpfv4mmpam8BQb0Q98bHSIanPpDltcWMpyiCISPjZ1dPzW3DW/UaiKZCg11iW24fHOswrztm90Okrz761AO5L3j5HD0bJV7AMANQzCmraQrn92lj0Ih/cSjckAuctRTj%2BrmoQVOqGxUJdEEiPU/7W1Dj1KSrT2wWtEWCsT1OFO2avWoV/7wcbV9oSQoYS7TCjIWke/rp2Fl2PtlcmN66uCSLmprwba0pCE7drEaLIFfGK2HMFzL2FxxwlQDjFK6UXClqDmPos8UW1G0jCxnRSGJ8bWWAdNkt86eSIgcF5OQ6e1dRGlavHqp8yKlv8n%2BR/J5erwHySRngsETBtwfXo/dxtaG6aWtQbYWXLcxyOBUo9aSx2QU%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAIFAE6CWQID5X7YLA/20180622/us-east-1/s3/aws4_request&X-Amz-SignedHeaders=host&X-Amz-Signature=eea514f102f922e9242ad83a811519137bc915650d947bd75262d96db2f9b3da"
},
"..."
}
}
Template: atributos do template que o documento foi criado
Atributo | Descrição | Exemplo |
---|---|---|
key | Chave do template utilizado. | 996a799a-52ef-4805-ae9f-b2edfd75a30 |
data | Dados variáveis enviados para a criação do documento. | { "Company": "Banco Acme", "Address": "Av. Brasil 277", "Phone": "(11) 1234-5678" } |
{
"template": {
"key": "996a799a-5873-4805-ae9f-b2edfd49a730",
"data": {
"Company Name": "Clicksign Gestão de Documentos S.A.",
"Address": "R. Teodoro Sampaio 2767, 10° andar",
"Phone": "(11) 3145-2570",
"Website": "https://www.clicksign.com"
}
}
}
Signers: atributos dos signatários
Atributo | Descrição | Exemplo |
---|---|---|
key | Chave do signatário. Essa chave é utilizada no Widget Embedded e na requisição para Remover Signatários. | 0a122d4c-b3e7-44dc-9e3c-518a30f1ffbf |
list_key | Essa chave é utilizada na requisição para Remover Signatários do documento. | 48232cff-c592-47e7-83da-bf9cff04c928 |
request_signature_key | Essa chave é utilizada nas requisições de notificação e no Widget Embedded. | 5d1a3a98-aa86-47b6-850c-f3e7bb974556 |
email | E-mail do signatário que deverá assinar o documento. | [email protected] |
sign_as | A que título será realizada a assinatura. | sign |
auths | Tipo de autenticação para realizar assinatura. | [ "sms" ] |
phone_number | Número de telefone para o envio do SMS. | 11987654321 |
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 | Não solicita 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. | |
group | Grupo que o signatário está vinculado. | 1 |
created_at | Data de criação do signatário no documento. | 2018-06-21T16:47:32.123Z |
Signatures: atributos das assinaturas
Atributo | Descrição | Exemplo |
---|---|---|
| Nome informado ou confirmado pelo signatário. | Marcos Zumba |
| E-mail informado pelo operador. | |
| Data de nascimento informada ou confirmada pelo signatário. | 1983-03-31 |
| CPF informado ou confirmado pelo signatário. | 123.321.123-40 |
| Validação na receita federal dos dados do signatário. Possíveis valores:
| cpf_not_found |
| Retorno do nome recebido pela validação na receita federal dos dados do signatário. | Marcos Zumba |
| Endereço de IP público sobre o qual a assinatura foi realizada. | 200.148.122.227 |
{
"document": {
"...",
"signers": [
{
"key": "935be7d1-b181-444f-8adc-bbff0b9ba48b",
"list_key": "48232cff-c592-47e7-83da-bf9cff04c928",
"request_signature_key": "5d1a3a98-aa86-47b6-850c-f3e7bb974556",
"email": "[email protected]",
"name": "Marcos Zumba",
"has_documentation": true,
"documentation": "123.321.123-40",
"birthday": "1983-03-31",
"phone_number": "11999999999",
"sign_as": "sign",
"delivery": "email",
"group": 1,
"url": "https://sandbox.clicksign.com/sign/935be7d1-b181-444f-8adc-bbff0b9ba48b",
"auths": [
"email"
],
"created_at": "2018-06-22T02:32:20.476Z",
"signature": {
"name": "Marcos Zumba",
"email": "[email protected]",
"birthday": "1983-03-31",
"documentation": "123.321.123-40",
"validation": {
"status": "cpf_not_found",
"name": "Marcos Zumba"
},
"ip_address": "200.148.122.227",
"selfie": {
"name": "Anexo: 03 set 2020, 09-17-28.jpeg",
"original_url": "https://clicksign-content-sandbox.s3.amazonaws.com/2018/06/21/16/47/31/f584f1a1-8852-4558-a4d1-95fb35cb9d62/file.pdf?X-Amz-Expires=302&X-Amz-Date=20180621T164730Z&X-Amz-Security-Token=FQoDYXdzEDIaDE%2Bf7UhIxCKtI31saiK3A2N1i1fbRCKQ2HTv47/yOD/qr99LoWLS7DCWg6fL8O2seb9e4TFWkp052eEoDVkK5bwuN2omOrw60B/Bp5A0DjhOSaSYf%2Bv2g%2BJg0tyMNVCJGk8l1hmkEFwnS2bBv8MeT/fd84QlRcfEstT8jQc7buKT7zbUeQrN7u8Jn3jWlpePjiZ4tF/MVI55JAf7rbhjROjmi7zG0RIS8ijX7gHeO52YUAsNuWW8Ajgo8yyfqqvihoHVZ8bYomRRMX9ALhZcM9AjgzUYEQdopmzx%2B2w3T84cTUYo5ATzsUe%2Bfn%2BsgNHhNGj0tHNBOQZ3Hfn1qiHC2iimY/x4cRayS82Dq1cCTkTSdsscEAUOfl9oJSysQ/VwJCLdtOdo22SixQ3DVQzjXoDGLCIdzbzAECgWJHj%2BDW8/nHje%2BocAmrwdQSRobzrzI5/FxUjaX4ebIURnGgp62O563tX9Hlz4X0IIxZftUKxzzYMe7u%2BsCR9pJ%2BFeVrRNFe6ARsB3b0ZjgvBz2dWpLRhDaz5Dqmj4qDq%2Bbe7s%2BRyMzgeN68g7pDfWHGqb3OfEecSmb%2Bv2CqbegRwUovdGYHicq5V%2BQkMo5aev2QU%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAIX7YN2T5IL35PUBA/20180621/us-east-1/s3/aws4_request&X-Amz-SignedHeaders=host&X-Amz-Signature=e0ed9f8577338a4c5f079a744f2574b5e613a7e6cba40ce10c624594fefa90d6",
}
}
}
],
"..."
}
}
Events: atributos dos eventos
Atributo | Descrição | Exemplo |
---|---|---|
| Nome do evento ocorrido. Listagem dos eventos disponível na página Eventos. | auto_close |
| Dados contendo os detalhes do evento. | null |
| Data na qual o evento ocorreu | 2018-06-22T02:32:45.375Z |
{
"document": {
"...",
"events": [
{
"name": "auto_close",
"data": null,
"occurred_at": "2018-06-22T02:32:45.375Z"
},
{
"name": "sign",
"data": {
"signer": {
"name": "Marcos Zumba",
"documentation": "123.321.123-40",
"birthday": "1983-03-31",
"address": "200.148.122.227",
"key": "935be7d1-b181-444f-8adc-bbff0b9ba48b",
"email": "[email protected]",
"has_documentation": true,
"created_at": "2018-06-21T23:32:20.476-03:00",
"sign_as": "sign",
"auths": [
"email"
],
"url": "https://sandbox.clicksign.com/sign/935be7d1-b181-444f-8adc-bbff0b9ba48b"
},
"account": {
"key": "35286aca-beef-490d-ad23-bc5e78441231"
},
"log_version": "1.6.0",
"url": "http://tavola.clicksign-staging.com"
},
"occurred_at": "2018-06-22T02:32:45.156Z"
},
{
"name": "add_signer",
"data": {
"user": {
"email": "[email protected]",
"name": "Michael Dois"
},
"account": {
"key": "35286aca-beef-490d-ad23-bc5e78441231"
},
"signers": [
{
"key": "935be7d1-b181-444f-8adc-bbff0b9ba48b",
"email": "[email protected]",
"name": "Marcos Zumba",
"birthday": "1983-03-31",
"documentation": "123.321.123-40",
"has_documentation": true,
"created_at": "2018-06-21T23:32:20.476-03:00",
"sign_as": "sign",
"auths": [
"email"
],
"url": "https://sandbox.clicksign.com/sign/935be7d1-b181-444f-8adc-bbff0b9ba48b"
}
]
},
"occurred_at": "2018-06-22T02:32:20.551Z"
},
{
"name": "upload",
"data": {
"user": {
"email": "[email protected]",
"name": "Michael Dois"
},
"account": {
"key": "35286aca-beef-490d-ad23-bc5e78441231"
},
"deadline_at": "2018-06-28T14:30:59.000-03:00",
"auto_close": true,
"locale": "pt-BR"
},
"occurred_at": "2018-06-22T02:32:20.512Z"
}
]
}
}
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.
Exemplo completo
Request
GET /api/v1/documents/55fea7c2-0e5b-40dc-bacf-50fb8529f866?access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"document": {
"key": "55fea7c2-0e5b-40dc-bacf-50fb8529f866",
"path": "/Pasta 1/Pasta 2/Contrato de Prestação de Serviços-123.pdf",
"filename": "Contrato de Prestação de Serviços-123.pdf",
"uploaded_at": "2018-06-21T16:47:32.115Z",
"updated_at": "2018-06-21T16:47:32.125Z",
"finished_at": null,
"deadline_at": "2018-06-28T17:30:59.000Z",
"status": "running",
"auto_close": true,
"locale": "pt-BR",
"metadata": {},
"sequence_enabled": false,
"signable_group": null,
"remind_interval": null,
"block_after_refusal": true,
"downloads": {
"original_file_url": "https://clicksign-content-sandbox.s3.amazonaws.com/2018/06/21/16/47/31/f584f1a1-8852-4558-a4d1-95fb35cb9d62/file.pdf?X-Amz-Expires=302&X-Amz-Date=20180621T164730Z&X-Amz-Security-Token=FQoDYXdzEDIaDE%2Bf7UhIxCKtI31saiK3A2N1i1fbRCKQ2HTv47/yOD/qr99LoWLS7DCWg6fL8O2seb9e4TFWkp052eEoDVkK5bwuN2omOrw60B/Bp5A0DjhOSaSYf%2Bv2g%2BJg0tyMNVCJGk8l1hmkEFwnS2bBv8MeT/fd84QlRcfEstT8jQc7buKT7zbUeQrN7u8Jn3jWlpePjiZ4tF/MVI55JAf7rbhjROjmi7zG0RIS8ijX7gHeO52YUAsNuWW8Ajgo8yyfqqvihoHVZ8bYomRRMX9ALhZcM9AjgzUYEQdopmzx%2B2w3T84cTUYo5ATzsUe%2Bfn%2BsgNHhNGj0tHNBOQZ3Hfn1qiHC2iimY/x4cRayS82Dq1cCTkTSdsscEAUOfl9oJSysQ/VwJCLdtOdo22SixQ3DVQzjXoDGLCIdzbzAECgWJHj%2BDW8/nHje%2BocAmrwdQSRobzrzI5/FxUjaX4ebIURnGgp62O563tX9Hlz4X0IIxZftUKxzzYMe7u%2BsCR9pJ%2BFeVrRNFe6ARsB3b0ZjgvBz2dWpLRhDaz5Dqmj4qDq%2Bbe7s%2BRyMzgeN68g7pDfWHGqb3OfEecSmb%2Bv2CqbegRwUovdGYHicq5V%2BQkMo5aev2QU%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAIX7YN2T5IL35PUBA/20180621/us-east-1/s3/aws4_request&X-Amz-SignedHeaders=host&X-Amz-Signature=e0ed9f8577338a4c5f079a744f2574b5e613a7e6cba40ce10c624594fefa90d6"
},
"template": {
"key": "996a799a-5873-4805-ae9f-b2edfd49a730",
"data": {
"Company Name": "Clicksign Gestão de Documentos S.A.",
"Address": "R. Teodoro Sampaio 2767, 10° andar",
"Phone": "(11) 3145-2570",
"Website": "https://www.clicksign.com"
}
}
},
"signers": [
{
"key": "935be7d1-b181-444f-8adc-bbff0b9ba48b",
"list_key": "48232cff-c592-47e7-83da-bf9cff04c928",
"request_signature_key": "5d1a3a98-aa86-47b6-850c-f3e7bb974556",
"email": "[email protected]",
"name": "Marcos Zumba",
"has_documentation": true,
"documentation": "123.321.123-40",
"birthday": "1983-03-31",
"sign_as": "sign",
"url": "http://www.uol.com.br",
"auths": [
"email"
],
"created_at": "2018-06-21T16:47:32.123Z"
}
],
"events": [
{
"name": "add_signer",
"data": {
"user": {
"email": "[email protected]",
"name": "Michael Dois"
},
"account": {
"key": "35286aca-beef-490d-ad23-bc5e78441231"
},
"signers": [
{
"key": "0a122d4c-b3e7-44dc-9e3c-518a30f1ffbf",
"email": "[email protected]",
"name": "Marcos Zumba",
"birthday": "1983-03-31",
"documentation": "123.321.123-40",
"has_documentation": true,
"created_at": "2018-06-21T13:47:32.123-03:00",
"sign_as": "sign",
"auths": [
"email"
],
"url": "http://www.uol.com.br"
}
]
},
"occurred_at": "2018-06-21T16:47:32.168Z"
},
{
"name": "upload",
"data": {
"user": {
"email": "[email protected]",
"name": "Michael Dois"
},
"account": {
"key": "35286aca-beef-490d-ad23-bc5e78441231"
},
"deadline_at": "2018-06-28T14:30:59.000-03:00",
"auto_close": true,
"locale": "pt-BR",
"block_after_refusal": true
},
"occurred_at": "2018-06-21T16:47:32.137Z"
}
]
}
Updated about 1 month ago