Visualizar documento

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

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

Atributos de status do documento

Atributo	Descrição
`draft`	Documento em rascunho.
`running`	Documento em processo de assinatura.
`closed`	Documento finalizado.
`canceled`	Documento cancelado.

Download: atributos para baixar o documento

🚧
As URLs de download têm validade de 5 minutos

Atributo Descrição

original URL para download do documento original.

Atributo	Descrição
`original`	URL para download do documento original.
`ziped`	URL para download do ZIP contendo o documento original e o assinado. Disponível alguns segundos após o documento ser finalizado ou cancelado.
`signed`	URL para download do documento assinado. Disponível alguns segundos após o documento ser finalizado ou cancelado.

ziped

URL para download do ZIP contendo o documento original e o assinado.

Disponível alguns segundos após o documento ser finalizado ou cancelado.

signed

URL para download do documento assinado.

Disponível alguns segundos após o documento ser finalizado ou cancelado.

❗️
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/envelope{{envelopeid}}/documents/{{documentid}} 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": "9cb2a94e-6aea-4177-b292-a9b3ee403741",
        "type": "documents",
        "links": {
            "self": "https://3.clicksign.dev/api/v3/envelopes/6bbdda29-5a14-4767-bf22-cd69f6547122/documents/9cb2a94e-6aea-4177-b292-a9b3ee403741",
            "files": {
                "original": "https://tavola-staging.s3.amazonaws.com/2023/08/04/17/44/27/d32f9ec6-f08d-4c91-a030-c9e0dc59f16e/Nome.pdf?X-Amz-Expires=300&X-Amz-Date=20230804T174503Z&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEIn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJHMEUCIQD3pppAHrFxwwrVSlsyYTQpj1iy4F3fI1KCgdcbBskPWwIgbp6hBQsP19RfUZrRTg8Kw3Gr4BjGjBzivDaHiT2rXgAqsAUIMhAAGgw2NzU3NDQ0MTM1NjkiDKYztCHsDBPLCQE17yqNBe86Q98r7y0Ym9mrm2bFi6EO4G5ofXA6ioRyQq03D%2FXHPfUZ0WlhakGKHAAKpHIHAXMVIKqP0wTBtqHkp1fCkPzgSsNv765Vdm%2BAdPGR9PL7pHSz0KqFzBBFmDKdGbTABBZspHB5j%2ByAUD35%2FcYP2pskVK78O9M78QrVBAHaDK7XxJ4eETXDLCc6r2AOhQX6W1WYMqJVDoBjyf%2FTHvZL6hE%2Bl4Jkhg7UnnNj8KE5xBYrZuCWU7Y5HlTriOekip0o1%2BdoKhMP5JfuX2tzQMG1ryimsf5SS7rCCmTYgJyihoEjiroxBUqVf3ynwAXl4iTH%2FxJdj02dcxVZHKU3KD1fV%2BhF1qs97x3U6cNRmCMGK1cYCEEsd%2FiohuPDazmwXPNLRUHsRxGHkHb3CsWIOm3XRZw2ylLtaIx7CpUvIFG9uM8CnSEITfCdQs%2FoflEGfMpwnrzh1w%2BiIXRxN8Eno%2BuxekKlDA5BZvSWtgIoRgcqofanhS77OrMTKPaBM2jTEMpd9RfIMVdOZX5%2FcqQdCZ%2BnIgy%2FeGLuAEw1c373R0veMiesgg02oS%2FbYKq0MVaVZU8yQXV2xoFbK9UCj%2Bw5myXpMbohqyUFSN8%2BCV4uonI7pbu3TMKnjRXKfA3krPLbHCnr6U5I1wGwWApD8KCKOmFGgiQBrgm18l5xFV12fvCWCSGAqxi4jR6Pc%2BLplTNvPxbxYs7xXhe6u3l%2BhVT7pq1aPd%2FKcEROTqPdBZKNiuMOXQaJnnw%2Bg0i%2FfIkd%2FddEF%2BvCv00kI3RmGdQohZbZ34ZxkdazfYi4baD8yX5Fm3p39fYyQsI4cUT0LuOIqVryz5RlP3HMzB8b1U1xslzNcS%2F3YMmgorjvbWXKIWelk0NHMPbZtKYGOrEB82%2BL9feJ8M1iEAC6gKk7SDqZn%2FK3AHFBMiSoisgCmGkt9AyRSXrDx6eOCT0%2FU14E6NYi0dso86ICD6fULmlANbZ3bYqFJKSiO0MbLklY%2BOeFuHttmFErlHN4siqjOq8WLRUtN7vh55LeLgz3ilS41zVdCGWJbHKhQmijHCNr8ZMUDQFRTWBPRXdSblc9rDK9WdVRyhwHX8I3p5ShsStqaPMOfkK4ZzxOrHzPKkaFWsyc&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAZ2VMBO6AZ6BTYUCJ%2F20230804%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-SignedHeaders=host&X-Amz-Signature=c6fd89b73552a06424ab977b4c7f5d55e3f29f46f91760170661697c0bc0f00f"
            }
        },
        "attributes": {
            "status": "draft",
            "filename": "Nome.pdf",
            "template": null,
            "metadata": {},
            "created": "2023-08-04T14:44:27.249-03:00",
            "modified": "2023-08-04T14:44:27.263-03:00"
        }
    }
}