{"_id":"54dbb31d3408c51700fed874","category":{"_id":"54db48c86db3861700c840c5","__v":13,"version":"54da5d305b80b62300dadc51","pages":["54db4c2c7dadb3230051136b","54db4f1c74dfff3700f161d9","54db53fdeb78f13900cf108e","54db65ec1a14312100313971","54dbad189f8ef11900f4df66","54dbccb800add623007578b4","54ff74002882a10d00546966","55de2abb9067202b00ddfffb","55e4d19fe252ac0d00303a73","5654c2d82308e12b00a14add","56980f9c080e0c0d00a835dc","569810e0895fd40d00d4b2f8","56e30b3051857d0e008e77a1"],"project":"54da5d2f5b80b62300dadc4e","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-02-11T12:19:20.398Z","from_sync":false,"order":0,"slug":"rest-api","title":"Rest API"},"githubsync":"","version":{"_id":"54da5d305b80b62300dadc51","project":"54da5d2f5b80b62300dadc4e","__v":7,"createdAt":"2015-02-10T19:34:08.062Z","releaseDate":"2015-02-10T19:34:08.062Z","categories":["54da5d305b80b62300dadc52","54da704b11dfeb1900430309","54da705c44b1090d00072b34","54db48c86db3861700c840c5","54db48cd7dadb32300511364","54dbaa0c7dadb3230051143b","572b89f0b352ab0e003daca2"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1.0","version_clean":"1.0.0","version":"1"},"__v":115,"parentDoc":null,"user":"54da5cb85b80b62300dadc4b","project":"54da5d2f5b80b62300dadc4e","metadata":{"title":"","description":"","image":[]},"updates":["54dcdad5db3b362100131238","5592a822c39c4b2d00127ad5"],"next":{"pages":[],"description":""},"createdAt":"2015-02-11T19:53:01.058Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"[block:callout]\n{\n  \"type\": \"danger\",\n  \"body\": \"Sugerimos que você utilize a nova plataforma da Clicksign. Consulte a documentação da API em https://developers.clicksign.com. \\n\\nEsta documentação é referente à API da plataforma Clicksign Classic.\",\n  \"title\": \"Utilize a nova plataforma de assinatura\"\n}\n[/block]\nA lista de assinatura define quem deve assinar o documento, e informa o status da assinatura (se o documento está ou não está assinado). Os elementos de definição da lista de assinatura são (i) e-mail do signatário, e (ii) ação, por exemplo, \"assinar\", \"aprovar\", \"assinar como testemunha\".\n\nApós a assinatura, a lista de assinatura é atualizada com o nome do signatário, o horário em que assinou o documento, e outras informações pertinentes.\n\nCada documento possui somente uma lista de assinatura. \n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"É possível fazer uma requisição do upload do documento, e em seguida uma segunda requisição para criar a lista de assinatura. Porém, sugerimos a utilização de [upload juntamente com a lista de assinatura](doc:upload-e-lista-de-assinatura) em uma única requisição, para evitar uma chamada desnecessária.\",\n  \"title\": \"Upload + lista de assinatura\"\n}\n[/block]\n### Requisição\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Method\",\n    \"1-0\": \"Path\",\n    \"2-0\": \"Headers\",\n    \"0-1\": \"`POST`\",\n    \"1-1\": \"`/v1/documents/:key/list?access_token=string`\\n\\n`:key` deve ser substituída pela key do documento. Exemplo: `88c4ebfa-05d8-44d8-bb42-cb2cf8e240f3`\",\n    \"2-1\": \"`Content-Type: application/json`\\n\\n`Accept: application/json`\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\nParâmetros:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`signers`\",\n    \"h-1\": \"Descrição\",\n    \"h-2\": \"Obrigatório\",\n    \"h-0\": \"Atributo\",\n    \"1-0\": \"`message`\",\n    \"2-0\": \"`skip_email`\",\n    \"0-2\": \"`true`\",\n    \"0-1\": \"O campo `signers` deverá ser um `Array` contendo os signatários. \\n**Vide tabela abaixo**.\",\n    \"1-2\": \"`false`\",\n    \"1-1\": \"Mensagem a ser enviada pela Clicksign dentro do e-mail de notificação de novo documento para assinar.\",\n    \"2-1\": \"Caso o parâmetro seja  `true` não será enviado e-mail no momento do fechamento da lista aos signatários. \\n\\nÉ importante notar que caso o parâmetro `skip_email` seja `true`, o parâmetro `message` torna-se desnecessário. \\n\\nEsse parâmetro é necessário para assinatura através de **Widget**.\",\n    \"2-2\": \"`false`\",\n    \"h-3\": \"\",\n    \"0-3\": \"\",\n    \"1-3\": \"\",\n    \"2-3\": \"\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n**Signers**\n\nCada signatário é especificado através de um e-mail e uma ação. Não há limites de signatários por documento, apenas a restrição de e-mails não duplicados. \n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`email`\",\n    \"1-0\": \"`act`\",\n    \"3-0\": \"`phone_number`\",\n    \"2-0\": \"`allow_method`\",\n    \"1-1\": \"Ação da assinatura\\n\\nOpções:\\n\\n  * `sign`: Assinar\\n  * `approve`: Aprovar\\n  * `acknowledge`: Reconhecer\\n  * `party`: Assinar como parte\\n  * `witness`: Assinar como testemunha\\n  * `intervening`: Assinar como interveniente\\n  * `receipt`: Acusar recebimento\",\n    \"0-2\": \"`true`\",\n    \"h-0\": \"Atributo\",\n    \"h-1\": \"Descrição\",\n    \"h-2\": \"Obrigatório\",\n    \"0-1\": \"E-mail do signatário que deverá assinar o documento.\",\n    \"1-2\": \"`true`\",\n    \"2-2\": \"`false`\",\n    \"3-2\": \"`false`\",\n    \"2-1\": \"Tipo de autenticação para realizar assinatura. Disponível apenas para assinaturas através do Widget.\\n\\nOpções:\\n\\n  * `token`: envio de token por e-mail (padrão).\\n  * `sms`: envio de token por SMS.\\n  * `password`: assinatura através de senha para usuários previamente cadastrados.\",\n    \"3-1\": \"Número de telefone para o envio do SMS.  Disponível apenas para assinaturas através do Widget.\",\n    \"h-3\": \"Exemplo\",\n    \"3-3\": \"11987654321\",\n    \"2-3\": \"token\",\n    \"1-3\": \"sign\",\n    \"0-3\": \"joao.ramalho:::at:::empresaabc.com.br\",\n    \"7-0\": \"`skip_documentation`\",\n    \"7-1\": \"Não solicita os campos CPF e data de nascimento do signatário no momento da assinatura. Útil para assinantes que não possuem CPF. O valor padrão é `false`.\\nÉ possível utilizar esta opção junto o widget com os campos *read-only*. Se for `true`, não é necessário enviar os campos `documentation` e `birthday`.\",\n    \"7-2\": \"`false`\",\n    \"7-3\": \"true\",\n    \"4-0\": \"`display_name`\",\n    \"5-0\": \"`documentation`\",\n    \"6-0\": \"`birthday`\",\n    \"4-2\": \"`false`\",\n    \"5-2\": \"`false`\",\n    \"6-2\": \"`false`\",\n    \"4-3\": \"João Ramalho\",\n    \"5-3\": \"123.321.123-40\",\n    \"4-1\": \"Nome completo do signatário. Enviar apenas quando for utilizar o widget com os campos *read-only*. \\nNecessário enviar os 3 campos `display_name`, `documentation` e `birthday`.\",\n    \"5-1\": \"CPF do signatário. Enviar apenas quando for utilizar o widget com os campos *read-only*. \\nNecessário enviar os 3 campos `display_name`, `documentation` e `birthday`.\",\n    \"6-1\": \"Data de nascimento do signatário. Enviar apenas quando for utilizar o widget com os campos *read-only*. \\nNecessário enviar os 3 campos `display_name`, `documentation` e `birthday`.\",\n    \"6-3\": \"1980-10-30\"\n  },\n  \"cols\": 4,\n  \"rows\": 8\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"signers\\\": [\\n    { \\\"email\\\": \\\"foo@example.com\\\", \\\"act\\\": \\\"sign\\\", \\\"allow_method\\\": \\\"token\\\" },\\n    { \\\"email\\\": \\\"bar@example.com\\\", \\\"act\\\": \\\"sign\\\", \\\"allow_method\\\": \\\"token\\\", \\\"skip_documentation\\\": \\\"true\\\" },\\n    { \\\"email\\\": \\\"qux@example.com\\\", \\\"act\\\": \\\"witness\\\", \\\"allow_method\\\": \\\"sms\\\", \\\"phone_number\\\": \\\"11987654321\\\" },\\n    { \\\"email\\\": \\\"yui@example.com\\\", \\\"act\\\": \\\"witness\\\", \\\"allow_method\\\": \\\"password\\\" },    \\n    { \\\"email\\\": \\\"gaz@example.com\\\", \\\"act\\\": \\\"approve\\\", \\\"allow_method\\\": \\\"token\\\", \\\"display_name\\\": \\\"João Ramalho\\\", \\\"documentation\\\": \\\"12332112340\\\", \\\"birthday\\\": \\\"1980-10-30\\\" },\\n    { \\\"email\\\": \\\"kiu@example.com\\\", \\\"act\\\": \\\"acknowledge\\\", \\\"allow_method\\\": \\\"token\\\", \\\"display_name\\\": \\\"João Ramalho\\\", \\\"skip_documentation\\\": \\\"true\\\" }\\n  ],\\n  \\\"message\\\": \\\"\\\",\\n  \\\"skip_email\\\": true\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Body\"\n    }\n  ]\n}\n[/block]\nNota: Se o signatário já estiver cadastrado na Clicksign, os dados da assinatura serão os dados do cadastro na Clicksign. Isso vale para qualquer assinatura, não apenas com o widget *read-only*.","excerpt":"","slug":"lista-de-assinatura","type":"basic","title":"Lista de assinatura"}

Lista de assinatura


[block:callout] { "type": "danger", "body": "Sugerimos que você utilize a nova plataforma da Clicksign. Consulte a documentação da API em https://developers.clicksign.com. \n\nEsta documentação é referente à API da plataforma Clicksign Classic.", "title": "Utilize a nova plataforma de assinatura" } [/block] A lista de assinatura define quem deve assinar o documento, e informa o status da assinatura (se o documento está ou não está assinado). Os elementos de definição da lista de assinatura são (i) e-mail do signatário, e (ii) ação, por exemplo, "assinar", "aprovar", "assinar como testemunha". Após a assinatura, a lista de assinatura é atualizada com o nome do signatário, o horário em que assinou o documento, e outras informações pertinentes. Cada documento possui somente uma lista de assinatura. [block:callout] { "type": "warning", "body": "É possível fazer uma requisição do upload do documento, e em seguida uma segunda requisição para criar a lista de assinatura. Porém, sugerimos a utilização de [upload juntamente com a lista de assinatura](doc:upload-e-lista-de-assinatura) em uma única requisição, para evitar uma chamada desnecessária.", "title": "Upload + lista de assinatura" } [/block] ### Requisição [block:parameters] { "data": { "0-0": "Method", "1-0": "Path", "2-0": "Headers", "0-1": "`POST`", "1-1": "`/v1/documents/:key/list?access_token=string`\n\n`:key` deve ser substituída pela key do documento. Exemplo: `88c4ebfa-05d8-44d8-bb42-cb2cf8e240f3`", "2-1": "`Content-Type: application/json`\n\n`Accept: application/json`" }, "cols": 2, "rows": 3 } [/block] Parâmetros: [block:parameters] { "data": { "0-0": "`signers`", "h-1": "Descrição", "h-2": "Obrigatório", "h-0": "Atributo", "1-0": "`message`", "2-0": "`skip_email`", "0-2": "`true`", "0-1": "O campo `signers` deverá ser um `Array` contendo os signatários. \n**Vide tabela abaixo**.", "1-2": "`false`", "1-1": "Mensagem a ser enviada pela Clicksign dentro do e-mail de notificação de novo documento para assinar.", "2-1": "Caso o parâmetro seja `true` não será enviado e-mail no momento do fechamento da lista aos signatários. \n\nÉ importante notar que caso o parâmetro `skip_email` seja `true`, o parâmetro `message` torna-se desnecessário. \n\nEsse parâmetro é necessário para assinatura através de **Widget**.", "2-2": "`false`", "h-3": "", "0-3": "", "1-3": "", "2-3": "" }, "cols": 3, "rows": 3 } [/block] **Signers** Cada signatário é especificado através de um e-mail e uma ação. Não há limites de signatários por documento, apenas a restrição de e-mails não duplicados. [block:parameters] { "data": { "0-0": "`email`", "1-0": "`act`", "3-0": "`phone_number`", "2-0": "`allow_method`", "1-1": "Ação da assinatura\n\nOpções:\n\n * `sign`: Assinar\n * `approve`: Aprovar\n * `acknowledge`: Reconhecer\n * `party`: Assinar como parte\n * `witness`: Assinar como testemunha\n * `intervening`: Assinar como interveniente\n * `receipt`: Acusar recebimento", "0-2": "`true`", "h-0": "Atributo", "h-1": "Descrição", "h-2": "Obrigatório", "0-1": "E-mail do signatário que deverá assinar o documento.", "1-2": "`true`", "2-2": "`false`", "3-2": "`false`", "2-1": "Tipo de autenticação para realizar assinatura. Disponível apenas para assinaturas através do Widget.\n\nOpções:\n\n * `token`: envio de token por e-mail (padrão).\n * `sms`: envio de token por SMS.\n * `password`: assinatura através de senha para usuários previamente cadastrados.", "3-1": "Número de telefone para o envio do SMS. Disponível apenas para assinaturas através do Widget.", "h-3": "Exemplo", "3-3": "11987654321", "2-3": "token", "1-3": "sign", "0-3": "joao.ramalho@empresaabc.com.br", "7-0": "`skip_documentation`", "7-1": "Não solicita os campos CPF e data de nascimento do signatário no momento da assinatura. Útil para assinantes que não possuem CPF. O valor padrão é `false`.\nÉ possível utilizar esta opção junto o widget com os campos *read-only*. Se for `true`, não é necessário enviar os campos `documentation` e `birthday`.", "7-2": "`false`", "7-3": "true", "4-0": "`display_name`", "5-0": "`documentation`", "6-0": "`birthday`", "4-2": "`false`", "5-2": "`false`", "6-2": "`false`", "4-3": "João Ramalho", "5-3": "123.321.123-40", "4-1": "Nome completo do signatário. Enviar apenas quando for utilizar o widget com os campos *read-only*. \nNecessário enviar os 3 campos `display_name`, `documentation` e `birthday`.", "5-1": "CPF do signatário. Enviar apenas quando for utilizar o widget com os campos *read-only*. \nNecessário enviar os 3 campos `display_name`, `documentation` e `birthday`.", "6-1": "Data de nascimento do signatário. Enviar apenas quando for utilizar o widget com os campos *read-only*. \nNecessário enviar os 3 campos `display_name`, `documentation` e `birthday`.", "6-3": "1980-10-30" }, "cols": 4, "rows": 8 } [/block] [block:code] { "codes": [ { "code": "{\n \"signers\": [\n { \"email\": \"foo@example.com\", \"act\": \"sign\", \"allow_method\": \"token\" },\n { \"email\": \"bar@example.com\", \"act\": \"sign\", \"allow_method\": \"token\", \"skip_documentation\": \"true\" },\n { \"email\": \"qux@example.com\", \"act\": \"witness\", \"allow_method\": \"sms\", \"phone_number\": \"11987654321\" },\n { \"email\": \"yui@example.com\", \"act\": \"witness\", \"allow_method\": \"password\" }, \n { \"email\": \"gaz@example.com\", \"act\": \"approve\", \"allow_method\": \"token\", \"display_name\": \"João Ramalho\", \"documentation\": \"12332112340\", \"birthday\": \"1980-10-30\" },\n { \"email\": \"kiu@example.com\", \"act\": \"acknowledge\", \"allow_method\": \"token\", \"display_name\": \"João Ramalho\", \"skip_documentation\": \"true\" }\n ],\n \"message\": \"\",\n \"skip_email\": true\n}", "language": "json", "name": "Body" } ] } [/block] Nota: Se o signatário já estiver cadastrado na Clicksign, os dados da assinatura serão os dados do cadastro na Clicksign. Isso vale para qualquer assinatura, não apenas com o widget *read-only*.