### Clone Embedded Test Repository Source: https://developers.clicksign.com/v1.0/docs/implementacao-teste-tokenless Command to clone the public GitHub repository containing test examples for the Clicksign Widget. This allows quick setup for testing the widget functionality. ```shell git clone https://github.com/clicksign/embedded-test.git cd embedded-test/tokenless ``` -------------------------------- ### Retrieve Account Info via Clicksign API JSON Source: https://developers.clicksign.com/v1.0/docs/primeiros-passos This JSON example demonstrates the response structure from a Clicksign API authentication test, including account name and admin email details. It serves as a reference for expected output when querying the accounts endpoint with a valid access token. No specific dependencies or inputs are handled in this static snippet; actual API calls require replacing placeholders in the URL. ```json { "account": { "name": "Nome da sua conta", "admins": [ { "email": "admin@suaconta.com" } ] } } ``` -------------------------------- ### HTTP Request Example Source: https://developers.clicksign.com/v1.0/docs/informacoes-gerais Demonstrates a sample HTTP GET request to the Clicksign API. This example includes details on headers like Accept and Content-Type, as well as the access token parameter in the path. ```http GET /api/v1/documents/55fea7c2-0e5b-40dc-bacf-50fb8529f866?access_token={{access_token}} HTTP/1.1 Host: sandbox.clicksign.com Accept: application/json Content-Type: application/json ``` -------------------------------- ### GET /api/v1/accounts Source: https://developers.clicksign.com/v1.0/docs/primeiros-passos This endpoint allows you to retrieve account information using an access token. It's used for testing authentication and verifying your access token's validity. ```APIDOC ## GET /api/v1/accounts ### Description This endpoint retrieves account information using an access token. ### Method GET ### Endpoint /api/v1/accounts?access_token={access_token} ### Parameters #### Query Parameters - **access_token** (string) - Required - Your ClickSign access token. ### Request Example ### Response #### Success Response (200) - **account** (object) - Account details. - **name** (string) - The name of your account. - **admins** (array) - An array of administrators for the account. - **email** (string) - The email address of an administrator. #### Response Example ```json { "account": { "name": "Nome da sua conta", "admins": [ { "email": "admin@suaconta.com" } ] } } ``` ``` -------------------------------- ### Document Downloads Example in JSON Source: https://developers.clicksign.com/v1.0/docs/visualizar-documento This JSON example illustrates the structure of a document object with download attributes. It includes URLs for original, signed, and zipped files, available post-document completion. Requires no external dependencies; outputs are URLs and checksum strings. Limitations include 5-minute URL validity and delayed availability for signed/zipped files. ```json { "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" }, "..." } } ``` -------------------------------- ### List Acceptances API Response JSON Source: https://developers.clicksign.com/v1.0/docs/visualizar-todos-os-aceites-enviados-atrav%C3%A9s-do-aceite-via-whatsapp This JSON snippet demonstrates an example response from the Clicksign API for listing document acceptances. It includes an array of acceptance objects with keys, names, sender and signer details, content, status, and timestamps, along with pagination information. The response is for a single page with no dependencies on external libraries, assuming a GET request to the acceptances endpoint. ```json { "acceptances": [ { "key": "27817cd0-bed4-4df4-a89a-52fb99c0fa69", "name": "plano internet", "sender_name": "Implementação Observer", "sender_phone": "55999078674", "content": "o valor do plano subiu", "status": "sent", "signer_phone": "55999078674", "signer_name": "Alice example", "sent_at": "2022-07-12T14:52:34.653-03:00" } ], "page_infos": { "total_pages": 1, "current_page": 1, "next_page": null, "prev_page": null, "first_page?": true, "last_page?": true } } ``` -------------------------------- ### Form with Widget Integration Source: https://developers.clicksign.com/v1.0/docs/implementacao-teste-tokenless Example HTML form integrating the Clicksign Widget, including input fields for CPF and birthdate, and a submit button for signature. ```html





``` -------------------------------- ### Example Duplicate Document Request - HTTP Source: https://developers.clicksign.com/v1.0/docs/duplicar-documento An example of a complete HTTP request to duplicate a document. This demonstrates the actual endpoint usage with a sample document key and access token. It includes the necessary headers for the request. ```http POST /api/v1/documents/996a799a-52ef-4805-ae9f-b2edfd49a730/duplicate?access_token={{access_token}} HTTP/1.1 Host: sandbox.clicksign.com Content-Type: application/json Accept: application/json ``` -------------------------------- ### Get Document Details Request Source: https://developers.clicksign.com/v1.0/docs/visualizar-documento An example HTTP GET request to retrieve details of a specific document using the Clicksign API. Requires an access token for authentication. ```http 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 ``` -------------------------------- ### Open Test Page in Browser Source: https://developers.clicksign.com/v1.0/docs/implementacao-teste-tokenless Commands to open the test HTML page in Firefox or Google Chrome browsers for viewing the widget in action. ```shell firefox index.html ``` ```shell google-chrome index.html ``` -------------------------------- ### Initialize Tokenless Widget in JavaScript Source: https://developers.clicksign.com/v1.0/docs/implementacao-teste-tokenless Initializes the Tokenless Widget with a request signature key. The widget can be configured for sandbox or production environments. The injectLoader method allows customization of the loading experience. ```javascript const tw = new TokenlessWidget('93649147-db14-4279-b7f8-48acdc8fb898') tw.injectLoader('
') ``` ```javascript const tw_sandbox = new TokenlessWidget('request_signature_key','sandbox') ``` -------------------------------- ### JSON Example: Clicksign Template Data Source: https://developers.clicksign.com/v1.0/docs/visualizar-documento This snippet shows an example of the JSON data structure used for template and signer attributes when creating documents. It includes fields like company name, address, phone number, and website, which are essential for dynamic document generation. ```json { "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" } } } ``` -------------------------------- ### Mount Tokenless Widget with Container and Template Source: https://developers.clicksign.com/v1.0/docs/implementacao-teste-tokenless Mounts the Tokenless Widget into a specified container with a text template. The containerId and textTemplate are required parameters for proper widget rendering. ```javascript tw.mount({ 'containerId':'cs-widget-tokenless', 'textTemplate': 'banco_acme_1' }) ``` -------------------------------- ### Clicksign Tokenless Widget Integration (HTML + JavaScript) Source: https://developers.clicksign.com/v1.0/docs/implementacao-teste-tokenless Complete page integrating the Clicksign tokenless widget. It loads the official SDK, sets up UI controls, initializes the tokenlessWidget with a key and environment, mounts the widget in a container, attaches a click handler to submit the signer payload, and updates the UI on success or error. ```HTML + JavaScript Clicksign - Tokenless

⚙️ Configurações

🙋 Preencha seus dados
``` -------------------------------- ### Example JSON payload for Signers field Source: https://developers.clicksign.com/v1.0/docs/exemplo-signers Demonstrates the structure of the Signers object required by Clicksign API events. Includes identifiers, signer details, delivery method, and timestamps. No external dependencies; replace placeholder values with real data. ```json { "list_key":"bdd45421-1d0b-4d35-9023-c7491d1639aa", "key":"3361ae3d-0f5d-4f94-bdff-4fd65782a886", "request_signature_key":"56a9dd19-xxxx-xxxx-xxxx-548dd35f03d0", "email":"alice@example.com", "name":"Alice in Chains", "has_documentation":true, "documentation":"000.000.000-00", "birthday":"1984-02-03", "phone_number":null, "sign_as":"contractor", "delivery":"email", "refusable":false, "url":"http://app.clicksign.com/sign/56a9dd19-xxxx-xxxx-xxxx-548dd35f03d0", "auths":["email"], "created_at":"2023-03-15T14:27:34.150Z" } ``` -------------------------------- ### Create Widget Container Div Source: https://developers.clicksign.com/v1.0/docs/implementacao-teste-tokenless HTML div element to serve as the container where the Clicksign Widget will be mounted. ```html
``` -------------------------------- ### GET /api/v2/acceptance_term/whatsapps Source: https://developers.clicksign.com/v1.0/docs/visualizar-todos-os-aceites-enviados-atrav%C3%A9s-do-aceite-via-whatsapp Lista metadados dos aceites enviados via WhatsApp com suporte a paginação. Use o parâmetro page para navegar pelas páginas e access_token para autenticação. ```APIDOC ## GET /api/v2/acceptance_term/whatsapps ### Description Retorna uma lista paginada com parte dos metadados dos aceites enviados via WhatsApp na Clicksign. ### Method GET ### Endpoint /api/v2/acceptance_term/whatsapps/ ### Parameters #### Path Parameters Nenhum. #### Query Parameters - **page** (number) - Optional - Número da página para listagem paginada (padrão: 1). - **access_token** (string) - Required - Token de acesso para autenticação. #### Request Body Não aplicável (GET). ### Request Example { "page": 1, "access_token": "{{access_token}}" } ### Response #### Success Response (200) - **whatsapps** (array) - Lista de aceites via WhatsApp. - **page_infos** (object) - Metadados de paginação. #### Response Example { "whatsapps": [ { "key": "27817cd0-bed4-4df4-a89a-52fb99c0fa69", "name": "Alteração de plano de internet", "sender_name": "Clicksign API", "sender_phone": "55999078674", "content": "Eu, {{nome_destinatario}}, declaro que fui informado sobre a mudança de plano e aumento de valor na mensalidade para R$: 129,99.", "status": "sent", "signer_phone": "55999078674", "signer_name": "Fernando Sacchet", "sent_at": "2022-07-11T11:21:28.207-03:00" } ], "page_infos": { "total_pages": 1, "current_page": 1, "next_page": null, "prev_page": null, "first_page?": true, "last_page?": true } } ``` -------------------------------- ### Retrieve WhatsApp Acceptance Terms via HTTP GET Source: https://developers.clicksign.com/v1.0/docs/visualizar-todos-os-aceites-enviados-atrav%C3%A9s-do-aceite-via-whatsapp This snippet demonstrates a GET request to fetch a list of acceptance terms sent via WhatsApp from the Clicksign API. It uses the endpoint /api/v2/acceptance_term/whatsapps with pagination. Requires an access_token for authentication. Input is the page number; output is JSON with acceptance details and pagination info. Limited to authenticated users with appropriate permissions. ```http GET /api/v2/acceptance_term/whatsapps?page=number&access_token={{access_token}} HTTP/1.1 Host: sandbox.clicksign.com Content-Type: application/json Accept: application/json ``` ```http GET /api/v2/acceptance_term/whatsapps?page=1&access_token={{access_token}} HTTP/1.1 Host: sandbox.clicksign.com Content-Type: application/json Accept: application/json ``` -------------------------------- ### Include Clicksign Widget JavaScript Source: https://developers.clicksign.com/v1.0/docs/implementacao-teste-tokenless HTML script tags to include the Clicksign Widget JavaScript library in the head of your webpage for both Sandbox and Production environments. ```html ``` ```html ``` -------------------------------- ### GET /api/v2/signers Source: https://developers.clicksign.com/v1.0/docs/visualizar-todos-os-signat%C3%A1rios Retrieves a list of signers associated with the client's account. This is a GET request to /api/v2/signers?page=number, where 'number' is the page number. Signer attributes will appear in the response body. ```APIDOC ## GET /api/v2/signers ### Description Retrieves a paginated list of signers linked to the client's account. ### Method GET ### Endpoint /api/v2/signers #### Query Parameters - **page** (number) - Optional - The page number to retrieve. Up to 30 signers are listed per page. ### Response #### Success Response (200) - **signers** (array) - A list of signer objects. - **key** (string) - The signer's unique key. - **name** (string) - The signer's name. - **email** (string) - The signer's email address. - **documentation** (string) - The signer's identification document. - **page_infos** (object) - Information about the pagination. - **total_pages** (integer) - The total number of pages available. - **current_page** (integer) - The current page number being viewed. - **next_page** (integer) - The page number of the next page. - **prev_page** (integer) - The page number of the previous page. - **first_page?** (boolean) - True if this is the first page, false otherwise. - **last_page?** (boolean) - True if this is the last page, false otherwise. #### Response Example ```json { "signers": [ { "key": "4c833e5c-86ed-414d-9b83-2f12d1af4438", "name": "João Silva", "email": "joao.silva@clicksign.com", "documentation": "123.321.123-40" } ], "page_infos": { "total_pages": 3, "current_page": 1, "next_page": 2, "prev_page": null, "first_page?": true, "last_page?": false } } ``` ### Error Handling Refer to the 'Error Messages' documentation for details on why a request might fail. ``` -------------------------------- ### GET /api/v2/templates - List Templates Source: https://developers.clicksign.com/v1.0/docs/criar-modelo-via-upload This endpoint retrieves a list of template models. It requires the access token to authenticate. ```APIDOC ## GET /api/v2/templates ### Description This endpoint retrieves a list of template models. ### Method GET ### Endpoint /api/v2/templates?access_token={{access_token}} ### Parameters #### Path Parameters - **access_token** (string) - Required - Your Clicksign access token. #### Query Parameters None #### Request Body None ### Request Example ```http GET /api/v2/templates?access_token={{access_token}} HTTP/1.1 Host: sandbox.clicksign.com Content-Type: application/json Accept: application/json ``` ### Response #### Success Response (200) - **templates** (array) - An array of template objects. #### Response Example ```json { "templates": [ { "key": "f8b5ab9e-0f9b-47f4-badf-8f01c03abdd3", "name": "teste_modelo", "color": "#1474f5", "created_at": "2021-08-17T15:34:15.720-03:00", "updated_at": "2021-08-17T15:34:15.720-03:00", "url": "https://app.clicksign.com/media/W1siZiIsIjIwMjEvMDgvMTcvMTgvMzQvMTUvMmU0NDllY2UtNGUyNC00YjgzLTg0MTAtOTQ2MzY5ODUxNDg1L0RvY3VtZW50b190ZXN0ZS5kb2N4Il1d/Documento_teste.docx?sha=95ee48ad2964023f" } } ``` ``` -------------------------------- ### Event Attributes Source: https://developers.clicksign.com/v1.0/docs/visualizar-documento This section details the attributes available for events within the ClickSign API, including their names, descriptions, and examples. ```APIDOC ## Events: Event Attributes This table describes the attributes associated with events in the ClickSign API. | Attribute | Description | |--------------|---------------------------------------------------------------------------------| | `name` | The name of the event that occurred. Refer to the [Events](doc:eventos) page for a list of available events. | | `data` | Data containing the event details. | | `occurred_at`| The date and time when the event occurred. | ### Example Event Data ```json { "name": "auto_close", "data": null, "occurred_at": "2018-06-22T02:32:45.375Z" } ``` ```json { "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": "fulano@example.com", "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" } ``` ``` -------------------------------- ### Visualizar Signatário (HTTP Request) Source: https://developers.clicksign.com/v1.0/docs/visualizar-signatario Requisição HTTP GET para obter os metadados de um signatário específico na Clicksign. A chave do signatário deve ser incluída no path. Depende de um access_token válido. Retorna os detalhes do signatário em formato JSON. ```http GET /api/v1/signers/:key?access_token={{access_token}} HTTP/1.1 Host: sandbox.clicksign.com Content-Type: application/json Accept: application/json ``` -------------------------------- ### Clicksign API: Create Acceptance via WhatsApp - HTTP Request Source: https://developers.clicksign.com/v1.0/docs/criando-um-aceite-via-whatsapp Example of an HTTP POST request to create an acceptance term via WhatsApp. This demonstrates the necessary headers and URL structure for interacting with the Clicksign API. ```http POST /api/v2/acceptance_term/whatsapps?access_token={{access_token}} HTTP/1.1 Host: sandbox.clicksign.com Content-Type: application/json Accept: application/json ``` -------------------------------- ### Retrieve Document Events Source: https://developers.clicksign.com/v1.0/docs/visualizar-documento Example JSON response showing various events associated with a document, such as auto_close, sign, add_signer, and upload. Includes detailed data about signers, accounts, and timestamps. ```json { "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": "fulano@example.com", "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": "fulano@example.com", "name": "Michael Dois" }, "account": { "key": "35286aca-beef-490d-ad23-bc5e78441231" }, "signers": [ { "key": "935be7d1-b181-444f-8adc-bbff0b9ba48b", "email": "fulano@example.com", "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": "fulano@example.com", "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" } ] } } ``` -------------------------------- ### Fetch document metadata via HTTP GET Source: https://developers.clicksign.com/v1.0/docs/visualizar-documento This snippet shows how to make a GET request to retrieve document metadata from Clicksign. Requires document key and access token as parameters. Returns JSON response with document details. ```http GET /api/v1/documents/:key?access_token={{access_token}} HTTP/1.1 Host: sandbox.clicksign.com Content-Type: application/json Accept: application/json ``` -------------------------------- ### Webhook JSON Payload Source: https://developers.clicksign.com/v1.0/docs/disparos-de-webhooks-1 Example JSON payload sent in the body of a webhook for an 'acceptance_term_sent' event. Contains structured data about the event, including user and account details, acceptance information, and message logs with timestamps. Requires a JSON parsing library in the receiving application; inputs are event-driven from Clicksign, and outputs are parsed objects for further processing. Limited to this specific event example with Brazilian Portuguese content. ```json { "event": { /* Evento que disparou o Webhook */ "name": "acceptance_term_sent", "data": { "user": { "email": "john@example.com", "name": "John Admin" }, "account": { "key": "a63c9e1a-de14-4434-b448-ec8601d2186b" } }, "occurred_at": "2022-07-26T16:24:04.879-03:00" }, "acceptance": { "key": "a8a19bb3-3154-48b9-9ac7-a6eb4826a0be", "name": "Alteração Plano de Internet", "sender_name": "John Admin", "sender_phone": "", "content": "O valor do plano subiu para 129.90", "status": "sent", "signer_phone": "00999999999", "signer_name": "Fernando Sacchet", "sent_at": "2022-07-25T14:19:07.497-03:00", "created_at": "2022-07-25T14:18:37.455-03:00", "messages": [ { "message_id": "SMf9cd2d5293f4448d9f23e8fa44368a03", "message": "Olá *Fernando*!\n\n O Remetente *John Admin* enviou *Alteração de Plano* para você analisar e a Clicksign foi contratada para registrar o seu Aceite. Toque em Visualizar para ter acesso ao conteúdo.\n\n Lembre-se que o processo de Aceite precisa ser finalizado em até *24 horas* para não expirar.\n\n Ao visualizar, você confirma que é *Fernando*, concorda com os Termos de Uso da Clicksign e declara estar ciente da Política de Privacidade.\n\n Termos de Uso 👉 https://www.clicksign.com/termos\n\n Política de Privacidade 👉 https://www.clicksign.com/politica-de-privacidade", "profile_name": "Fernando", "error_message": "", "direction": "sent", "created_at": "2022-07-25T14:19:07.497-03:00" } ] } } ``` -------------------------------- ### Document Field JSON Example Source: https://developers.clicksign.com/v1.0/docs/exemplo-document This JSON object represents the structure of the Document field within the ClickSign API. It includes details such as file keys, paths, upload and update timestamps, status, and URLs for different file versions. This is a core component for managing documents in the system. ```json { "key":"db4a2cf7-0a48-481f-b669-54f2a2260ac2", "account_key":"f9d9b699-fa73-4949-b8c5-c45df202744b", "path":"/blank-4.pdf", "filename":"blank-4.pdf", "uploaded_at":"2023-03-13T14:28:02.235Z", "updated_at":"2023-03-13T16:37:09.228Z", "finished_at":"2023-03-13T16:37:02.628Z", "deadline_at":"2023-04-12T11:27:53.617-03:00", "status":"closed", "auto_close":true, "locale":"pt-BR", "metadata":{}, "sequence_enabled":false, "signable_group":null, "remind_interval":3, "block_after_refusal":false, "downloads": { "original_file_url": "/2023/03/13/888twv3942_blank_4.pdf", "signed_file_url": "/2023/03/13/1q42v26p3o_blank_4_Clicksign.pdf", "ziped_file_url": "/2023/03/13/99e8ang3j2_blank_4_Clicksign.zip" }, "template":null, "signers": [ < Veja exemplo de Signatários > ], "events": [ < Veja exemplos de Eventos >], "attachments":[], "links": {"self":"/db4a2cf7-0a48-481f-b669-54f2a2260ac2"} } ``` -------------------------------- ### GET /api/v2/webhooks Source: https://developers.clicksign.com/v1.0/docs/cadastro-de-webhooks-via-api Retrieves the list of registered webhooks. Send a GET request to /api/v2/webhooks to get details of all webhooks associated with the account. ```APIDOC ## GET /api/v2/webhooks ### Description Retrieves the list of all registered webhooks for the account. ### Method GET ### Endpoint /api/v2/webhooks ### Parameters #### Query Parameters - **access_token** (string) - Required - Access token for authentication ### Request Example GET /api/v2/webhooks?access_token={{access_token}} ### Response #### Success Response (200) - **hooks** (array of objects) - List of webhooks #### Response Example { "hooks": [ { "endpoint": "https://webhook.site/#!/4e398798-1460-4757-95af-ae15fc56ea59", "secret": "df68e1bf3efad0dfb445923e73b98c40", "status": "active", "events": [ "add_image", "upload" ], "key": "60160f41-9dc6-481b-9a4f-bfd83add1cb8", "created_at": "2021-07-28T10:34:44.849-03:00", "updated_at": "2021-07-28T10:34:44.849-03:00" } ] } ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.