{"_id":"54db53fdeb78f13900cf108e","user":"54da5cb85b80b62300dadc4b","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":"","parentDoc":null,"project":"54da5d2f5b80b62300dadc4e","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":98,"metadata":{"title":"","description":"","image":[]},"updates":["54ff73b1031aca0d00e480fa"],"next":{"pages":[],"description":""},"createdAt":"2015-02-11T13:07:09.415Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"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]\nUm processo de assinatura ocorre através de um documento. O documento deve ser criado fora da Clicksign preferencialmente nos formatos `PDF` ou `DOCX`. Nesta página detalharemos o fluxo dos documentos, bem como sua estrutura dentro da Clicksign.\n\nCada documento possui uma chave única que é criada no momento do seu upload. Através desta chave é feita toda referência ao documento. É necessário criar uma lista de assinatura para que o documento seja assinado.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Fluxo dos documentos\"\n}\n[/block]\n\n1. O primeiro passo é fazer o [Upload](doc:upload) de um documento para a Clicksign.\n\n2. O segundo passo é fazer a criação da [Lista de assinatura](doc:lista-de-assinatura), que é a lista dos e-mails e ações das pessoas que devem assinar o documento. As ações são a forma como as pessoas devem assinar, por exemplo, **assinar como parte** ou **assinar como testemunha**. O documento somente poderá ser assinado pelas pessoas que estiverem na lista de assinatura. \n\n3. Em seguida, deve-se cadastrar o [Webhook](doc:visao-geral-dos-webhooks) no documento. O webhook é a URL para a qual a Clicksign notifica assim que houver um fato novo sobre o documento, por exemplo, quando for assinado por uma pessoa.\n\n4. Após receber uma notificação através do webhook, deverá ser feita uma requisição de [Visualização](doc:visualizacao) para verificar as alterações ocorridas no documento.\n\n5. Caso seja necessário para o seu negócio, o último passo é fazer o [Download](doc:download) do documento. Lembrando que a Clicksign guarda todos os documentos assinados por 5 anos.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Estrutura de documentos\"\n}\n[/block]\n\n### Exemplo de um documento em JSON.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"document\\\": {\\n    \\\"key\\\": \\\"fd95b865-71ea-4abd-88f9-a9f663e3742b\\\",\\n    \\\"original_name\\\": \\\"Contrato Empresa ABC.pdf\\\",\\n    \\\"status\\\": \\\"completed\\\",\\n    \\\"created_at\\\": \\\"2015-01-30T10:37:32.859-02:00\\\",\\n    \\\"updated_at\\\": \\\"2015-01-30T10:37:32.859-02:00\\\",\\n    \\\"user_key\\\": \\\"A11D-EBAD-1D86-B7B4\\\",\\n    \\\"list\\\": {\\n      \\\"started_at\\\": \\\"2015-01-30T10:43:33.789-02:00\\\",\\n      \\\"created_at\\\": \\\"2015-01-30T10:37:32.856-02:00\\\",\\n      \\\"updated_at\\\": \\\"2015-01-30T10:43:33.791-02:00\\\",\\n      \\\"user_key\\\": \\\"A11D-EBAD-1D86-B7B4\\\",\\n      \\\"signatures\\\": [\\n        {\\n          \\\"display_name\\\": \\\"João Ramalho de Neto Alvez\\\",\\n          \\\"title\\\": null,\\n          \\\"company_name\\\": null,\\n          \\\"documentation\\\": \\\"123.321.123-40\\\",\\n          \\\"key\\\": \\\"9859-3548-062F-6A03\\\",\\n          \\\"act\\\": \\\"sign\\\",\\n          \\\"decision\\\": \\\"agreed\\\",\\n          \\\"address\\\": \\\"196.69.126.63\\\",\\n          \\\"email\\\": \\\"joao.ramalho:::at:::empresaabc.com.br\\\",\\n          \\\"signed_at\\\": \\\"2015-01-30T11:24:31.523-02:00\\\",\\n          \\\"allow_method\\\": \\\"token\\\",\\n          \\\"created_at\\\": \\\"2015-01-30T10:42:25.427-02:00\\\",\\n          \\\"updated_at\\\": \\\"2015-01-30T11:24:31.547-02:00\\\",\\n          \\\"skip_documentation\\\": false,\\n          \\\"phone_number\\\": \\\"\\\"\\n        },\\n        {\\n          \\\"display_name\\\": \\\"Renato Pereira da Silva\\\",\\n          \\\"title\\\": null,\\n          \\\"company_name\\\": null,\\n          \\\"key\\\": \\\"9CF6-CB23-F9EC-9010\\\",\\n          \\\"act\\\": \\\"sign\\\",\\n          \\\"decision\\\": \\\"agreed\\\",\\n          \\\"address\\\": \\\"189.121.156.99\\\",\\n          \\\"email\\\": \\\"renato.pereira@foxfox.com\\\",\\n          \\\"signed_at\\\": \\\"2015-01-30T10:45:03.436-02:00\\\",\\n          \\\"allow_method\\\": \\\"token\\\",\\n          \\\"created_at\\\": \\\"2015-01-30T10:42:30.501-02:00\\\",\\n          \\\"updated_at\\\": \\\"2015-01-30T10:45:03.457-02:00\\\",\\n          \\\"skip_documentation\\\": false,\\n          \\\"phone_number\\\": \\\"\\\"\\n        }\\n      ]\\n    }\\n  }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n### Definição dos atributos do documento\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`key`\",\n    \"0-1\": \"Chave única dentro do sistema\",\n    \"1-1\": \"Nome do arquivo\",\n    \"1-0\": \"`original_name`\",\n    \"2-0\": \"`status`\",\n    \"2-1\": \"Estado do documento\",\n    \"3-0\": \"`created_at`\",\n    \"3-1\": \"Data de criação do documento\",\n    \"4-0\": \"`updated_at`\",\n    \"4-1\": \"Data de última alteração no documento\",\n    \"5-0\": \"`user_key`\",\n    \"5-1\": \"Chave do usuário que criou o documento\",\n    \"6-0\": \"`list`\",\n    \"6-1\": \"Lista de assinatura\",\n    \"h-0\": \"Atributo\",\n    \"h-1\": \"Descrição\",\n    \"h-2\": \"Exemplo\",\n    \"0-2\": \"fd95b865-71ea-4abd-88f9-a9f663e3742b\",\n    \"1-2\": \"Contrato Empresa ABC.pdf\",\n    \"2-2\": \"completed\",\n    \"3-2\": \"2015-01-30T10:37:32.859-02:00\",\n    \"4-2\": \"2015-01-30T10:37:32.859-02:00\",\n    \"5-2\": \"A11D-EBAD-1D86-B7B4\",\n    \"6-2\": \"[{...}]\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]\n### Status do documento\n\nO status de um documento varia conforme a geração do preview, o estado da lista de assinatura e as próprias assinaturas. Segue abaixo a descrição do status e suas transições possíveis:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`working`\",\n    \"0-2\": \"\",\n    \"0-1\": \"Gerando preview do documento\",\n    \"1-0\": \"`editing`\",\n    \"2-0\": \"`pending`\",\n    \"3-0\": \"`running`\",\n    \"4-0\": \"`completed`\",\n    \"5-0\": \"`declined`\",\n    \"1-1\": \"Lista de assinatura aberta para edição\",\n    \"2-1\": \"Documento aguardando assinatura do usuário dono da chave da API\",\n    \"3-1\": \"Documento aguardando assinatura de outros usuários\",\n    \"4-1\": \"Documento completamente assinado\",\n    \"5-1\": \"Documento assinado com ao menos uma declinação (opção não disponível para novos documentos)\",\n    \"h-0\": \"Status\",\n    \"h-1\": \"Descrição\",\n    \"6-0\": \"`canceled`\",\n    \"6-1\": \"Documento cancelado\"\n  },\n  \"cols\": 2,\n  \"rows\": 7\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/Y3cerI2QuKgJsKra8Bs5_state-diagram.png\",\n        \"state-diagram.png\",\n        \"267\",\n        \"443\",\n        \"#dcdcdc\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n### Lista de assinatura do documento\n\nCada documento possui somente uma lista de assinatura. Ela é composta pelas assinaturas (explicadas abaixo), pelo usuário que criou e pelas datas de criação, atualização, início.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`started_at`\",\n    \"1-0\": \"`created_at`\",\n    \"2-0\": \"`updated_at`\",\n    \"3-0\": \"`user_key`\",\n    \"h-0\": \"Atributo\",\n    \"h-1\": \"Descrição\",\n    \"h-2\": \"Exemplo\",\n    \"0-1\": \"Data de início da lista de assinatura\",\n    \"0-2\": \"2015-01-30T10:43:33.789-02:00\",\n    \"1-2\": \"2015-01-30T10:37:32.856-02:00\",\n    \"2-2\": \"2015-01-30T10:43:33.791-02:00\",\n    \"3-2\": \"A11D-EBAD-1D86-B7B4\",\n    \"4-0\": \"`signatures`\",\n    \"4-2\": \"[{...}]\",\n    \"4-1\": \"Assinaturas do documento\",\n    \"1-1\": \"Data de criação da lista de assinatura\",\n    \"2-1\": \"Data de última alteração na lista de assinatura\",\n    \"3-1\": \"Chave do usuário que criou a lista de assinatura\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\n### Assinaturas do documento\n\nUma lista de assinatura contém todas as pessoas que devem assinar um documento. Quando uma lista de assinatura é criada, cada assinatura possui somente o e-mail e a ação daquela assinatura, porém quando o usuário assina, as outras informações são preenchidas. \n\n**Exemplo de lista ainda não assinada**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"      \\\"signatures\\\": [\\n        {\\n          \\\"display_name\\\": \\\"joao.ramalho@empresaabc.com.br\\\",\\n          \\\"title\\\": null,\\n          \\\"company_name\\\": null,\\n          \\\"documentation\\\": null,\\n          \\\"key\\\": null,\\n          \\\"act\\\": \\\"sign\\\",\\n          \\\"decision\\\": null,\\n          \\\"address\\\": null,\\n          \\\"email\\\": \\\"joao.ramalho@empresaabc.com.br\\\",\\n          \\\"signed_at\\\": null,\\n          \\\"allow_method\\\": \\\"token\\\",\\n          \\\"created_at\\\": \\\"2015-01-29T10:12:35.727-02:00\\\",\\n          \\\"updated_at\\\": \\\"2015-01-29T10:24:41.647-02:00\\\",\\n          \\\"skip_documentation\\\": false,\\n          \\\"phone_number\\\": \\\"\\\"\\n        },\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n**Exemplo de lista assinada**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"      \\\"signatures\\\": [\\n        {\\n          \\\"display_name\\\": \\\"João Ramalho de Neto Alvez\\\",\\n          \\\"title\\\": null,\\n          \\\"company_name\\\": null,\\n          \\\"documentation\\\": \\\"123.321.123-40\\\",\\n          \\\"key\\\": \\\"9859-3548-062F-6A03\\\",\\n          \\\"act\\\": \\\"sign\\\",\\n          \\\"decision\\\": \\\"agreed\\\",\\n          \\\"address\\\": \\\"196.69.126.63\\\",\\n          \\\"email\\\": \\\"joao.ramalho@empresaabc.com.br\\\",\\n          \\\"signed_at\\\": \\\"2015-01-30T11:24:31.523-02:00\\\",\\n          \\\"allow_method\\\": \\\"token\\\",\\n          \\\"created_at\\\": \\\"2015-01-30T10:42:25.427-02:00\\\",\\n          \\\"updated_at\\\": \\\"2015-01-30T11:24:31.547-02:00\\\",\\n          \\\"skip_documentation\\\": false,\\n          \\\"phone_number\\\": \\\"\\\"\\n        },\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`display_name`\",\n    \"1-0\": \"`title`\",\n    \"2-0\": \"`company_name`\",\n    \"4-0\": \"`key`\",\n    \"5-0\": \"`act`\",\n    \"6-0\": \"`decision`\",\n    \"7-0\": \"`address`\",\n    \"8-0\": \"`email`\",\n    \"9-0\": \"`signed_at`\",\n    \"13-0\": \"`created_at`\",\n    \"14-0\": \"`updated_at`\",\n    \"0-1\": \"Nome do signatário\",\n    \"14-1\": \"Data de última alteração na assinatura\",\n    \"13-1\": \"Data de criação da assinatura\",\n    \"9-1\": \"Data da assinatura\",\n    \"8-1\": \"E-mail do signatário\",\n    \"7-1\": \"IP do signatário\",\n    \"6-1\": \"Estado da assinatura\\n\\nOpções:\\n\\n  * `agreed`: assinatura aceita\\n  * `declined`: assinatura declinada (opção não disponível para novos documentos)\\n  * `null`: assinatura não realizada\",\n    \"5-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    \"4-1\": \"Chave do signatário\",\n    \"2-1\": \"Empresa do signatário\",\n    \"1-1\": \"Cargo do signatário\",\n    \"0-2\": \"João Ramalho de Neto Alvez\",\n    \"1-2\": \"*null*\",\n    \"2-2\": \"*null*\",\n    \"4-2\": \"9859-3548-062F-6A03\",\n    \"5-2\": \"sign\",\n    \"6-2\": \"agreed\",\n    \"7-2\": \"196.69.126.63\",\n    \"8-2\": \"joao.ramalho@empresaabc.com.br\",\n    \"9-2\": \"2015-01-30T11:24:31.523-02:00\",\n    \"13-2\": \"2015-01-30T10:42:25.427-02:00\",\n    \"14-2\": \"2015-01-30T11:24:31.547-02:00\",\n    \"h-0\": \"Atributo\",\n    \"h-1\": \"Descrição\",\n    \"h-2\": \"Exemplo\",\n    \"3-0\": \"`documentation`\",\n    \"3-1\": \"CPF ou CNPJ do signatário\",\n    \"3-2\": \"123.321.123-40\",\n    \"10-0\": \"`allow_method`\",\n    \"10-2\": \"token\",\n    \"10-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    \"11-0\": \"`phone_number`\",\n    \"11-1\": \"Número de telefone para o envio do SMS.  Disponível apenas para assinaturas através do Widget.\",\n    \"11-2\": \"11987654321\",\n    \"12-0\": \"`skip_documentation`\",\n    \"12-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    \"12-2\": \"`true`\"\n  },\n  \"cols\": 3,\n  \"rows\": 15\n}\n[/block]","excerpt":"","slug":"documentos","type":"basic","title":"Documentos"}
[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] Um processo de assinatura ocorre através de um documento. O documento deve ser criado fora da Clicksign preferencialmente nos formatos `PDF` ou `DOCX`. Nesta página detalharemos o fluxo dos documentos, bem como sua estrutura dentro da Clicksign. Cada documento possui uma chave única que é criada no momento do seu upload. Através desta chave é feita toda referência ao documento. É necessário criar uma lista de assinatura para que o documento seja assinado. [block:api-header] { "type": "basic", "title": "Fluxo dos documentos" } [/block] 1. O primeiro passo é fazer o [Upload](doc:upload) de um documento para a Clicksign. 2. O segundo passo é fazer a criação da [Lista de assinatura](doc:lista-de-assinatura), que é a lista dos e-mails e ações das pessoas que devem assinar o documento. As ações são a forma como as pessoas devem assinar, por exemplo, **assinar como parte** ou **assinar como testemunha**. O documento somente poderá ser assinado pelas pessoas que estiverem na lista de assinatura. 3. Em seguida, deve-se cadastrar o [Webhook](doc:visao-geral-dos-webhooks) no documento. O webhook é a URL para a qual a Clicksign notifica assim que houver um fato novo sobre o documento, por exemplo, quando for assinado por uma pessoa. 4. Após receber uma notificação através do webhook, deverá ser feita uma requisição de [Visualização](doc:visualizacao) para verificar as alterações ocorridas no documento. 5. Caso seja necessário para o seu negócio, o último passo é fazer o [Download](doc:download) do documento. Lembrando que a Clicksign guarda todos os documentos assinados por 5 anos. [block:api-header] { "type": "basic", "title": "Estrutura de documentos" } [/block] ### Exemplo de um documento em JSON. [block:code] { "codes": [ { "code": "{\n \"document\": {\n \"key\": \"fd95b865-71ea-4abd-88f9-a9f663e3742b\",\n \"original_name\": \"Contrato Empresa ABC.pdf\",\n \"status\": \"completed\",\n \"created_at\": \"2015-01-30T10:37:32.859-02:00\",\n \"updated_at\": \"2015-01-30T10:37:32.859-02:00\",\n \"user_key\": \"A11D-EBAD-1D86-B7B4\",\n \"list\": {\n \"started_at\": \"2015-01-30T10:43:33.789-02:00\",\n \"created_at\": \"2015-01-30T10:37:32.856-02:00\",\n \"updated_at\": \"2015-01-30T10:43:33.791-02:00\",\n \"user_key\": \"A11D-EBAD-1D86-B7B4\",\n \"signatures\": [\n {\n \"display_name\": \"João Ramalho de Neto Alvez\",\n \"title\": null,\n \"company_name\": null,\n \"documentation\": \"123.321.123-40\",\n \"key\": \"9859-3548-062F-6A03\",\n \"act\": \"sign\",\n \"decision\": \"agreed\",\n \"address\": \"196.69.126.63\",\n \"email\": \"joao.ramalho@empresaabc.com.br\",\n \"signed_at\": \"2015-01-30T11:24:31.523-02:00\",\n \"allow_method\": \"token\",\n \"created_at\": \"2015-01-30T10:42:25.427-02:00\",\n \"updated_at\": \"2015-01-30T11:24:31.547-02:00\",\n \"skip_documentation\": false,\n \"phone_number\": \"\"\n },\n {\n \"display_name\": \"Renato Pereira da Silva\",\n \"title\": null,\n \"company_name\": null,\n \"key\": \"9CF6-CB23-F9EC-9010\",\n \"act\": \"sign\",\n \"decision\": \"agreed\",\n \"address\": \"189.121.156.99\",\n \"email\": \"renato.pereira@foxfox.com\",\n \"signed_at\": \"2015-01-30T10:45:03.436-02:00\",\n \"allow_method\": \"token\",\n \"created_at\": \"2015-01-30T10:42:30.501-02:00\",\n \"updated_at\": \"2015-01-30T10:45:03.457-02:00\",\n \"skip_documentation\": false,\n \"phone_number\": \"\"\n }\n ]\n }\n }\n}", "language": "json" } ] } [/block] ### Definição dos atributos do documento [block:parameters] { "data": { "0-0": "`key`", "0-1": "Chave única dentro do sistema", "1-1": "Nome do arquivo", "1-0": "`original_name`", "2-0": "`status`", "2-1": "Estado do documento", "3-0": "`created_at`", "3-1": "Data de criação do documento", "4-0": "`updated_at`", "4-1": "Data de última alteração no documento", "5-0": "`user_key`", "5-1": "Chave do usuário que criou o documento", "6-0": "`list`", "6-1": "Lista de assinatura", "h-0": "Atributo", "h-1": "Descrição", "h-2": "Exemplo", "0-2": "fd95b865-71ea-4abd-88f9-a9f663e3742b", "1-2": "Contrato Empresa ABC.pdf", "2-2": "completed", "3-2": "2015-01-30T10:37:32.859-02:00", "4-2": "2015-01-30T10:37:32.859-02:00", "5-2": "A11D-EBAD-1D86-B7B4", "6-2": "[{...}]" }, "cols": 3, "rows": 7 } [/block] ### Status do documento O status de um documento varia conforme a geração do preview, o estado da lista de assinatura e as próprias assinaturas. Segue abaixo a descrição do status e suas transições possíveis: [block:parameters] { "data": { "0-0": "`working`", "0-2": "", "0-1": "Gerando preview do documento", "1-0": "`editing`", "2-0": "`pending`", "3-0": "`running`", "4-0": "`completed`", "5-0": "`declined`", "1-1": "Lista de assinatura aberta para edição", "2-1": "Documento aguardando assinatura do usuário dono da chave da API", "3-1": "Documento aguardando assinatura de outros usuários", "4-1": "Documento completamente assinado", "5-1": "Documento assinado com ao menos uma declinação (opção não disponível para novos documentos)", "h-0": "Status", "h-1": "Descrição", "6-0": "`canceled`", "6-1": "Documento cancelado" }, "cols": 2, "rows": 7 } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/Y3cerI2QuKgJsKra8Bs5_state-diagram.png", "state-diagram.png", "267", "443", "#dcdcdc", "" ] } ] } [/block] ### Lista de assinatura do documento Cada documento possui somente uma lista de assinatura. Ela é composta pelas assinaturas (explicadas abaixo), pelo usuário que criou e pelas datas de criação, atualização, início. [block:parameters] { "data": { "0-0": "`started_at`", "1-0": "`created_at`", "2-0": "`updated_at`", "3-0": "`user_key`", "h-0": "Atributo", "h-1": "Descrição", "h-2": "Exemplo", "0-1": "Data de início da lista de assinatura", "0-2": "2015-01-30T10:43:33.789-02:00", "1-2": "2015-01-30T10:37:32.856-02:00", "2-2": "2015-01-30T10:43:33.791-02:00", "3-2": "A11D-EBAD-1D86-B7B4", "4-0": "`signatures`", "4-2": "[{...}]", "4-1": "Assinaturas do documento", "1-1": "Data de criação da lista de assinatura", "2-1": "Data de última alteração na lista de assinatura", "3-1": "Chave do usuário que criou a lista de assinatura" }, "cols": 3, "rows": 5 } [/block] ### Assinaturas do documento Uma lista de assinatura contém todas as pessoas que devem assinar um documento. Quando uma lista de assinatura é criada, cada assinatura possui somente o e-mail e a ação daquela assinatura, porém quando o usuário assina, as outras informações são preenchidas. **Exemplo de lista ainda não assinada** [block:code] { "codes": [ { "code": " \"signatures\": [\n {\n \"display_name\": \"joao.ramalho@empresaabc.com.br\",\n \"title\": null,\n \"company_name\": null,\n \"documentation\": null,\n \"key\": null,\n \"act\": \"sign\",\n \"decision\": null,\n \"address\": null,\n \"email\": \"joao.ramalho@empresaabc.com.br\",\n \"signed_at\": null,\n \"allow_method\": \"token\",\n \"created_at\": \"2015-01-29T10:12:35.727-02:00\",\n \"updated_at\": \"2015-01-29T10:24:41.647-02:00\",\n \"skip_documentation\": false,\n \"phone_number\": \"\"\n },", "language": "json" } ] } [/block] **Exemplo de lista assinada** [block:code] { "codes": [ { "code": " \"signatures\": [\n {\n \"display_name\": \"João Ramalho de Neto Alvez\",\n \"title\": null,\n \"company_name\": null,\n \"documentation\": \"123.321.123-40\",\n \"key\": \"9859-3548-062F-6A03\",\n \"act\": \"sign\",\n \"decision\": \"agreed\",\n \"address\": \"196.69.126.63\",\n \"email\": \"joao.ramalho@empresaabc.com.br\",\n \"signed_at\": \"2015-01-30T11:24:31.523-02:00\",\n \"allow_method\": \"token\",\n \"created_at\": \"2015-01-30T10:42:25.427-02:00\",\n \"updated_at\": \"2015-01-30T11:24:31.547-02:00\",\n \"skip_documentation\": false,\n \"phone_number\": \"\"\n },", "language": "json" } ] } [/block] [block:parameters] { "data": { "0-0": "`display_name`", "1-0": "`title`", "2-0": "`company_name`", "4-0": "`key`", "5-0": "`act`", "6-0": "`decision`", "7-0": "`address`", "8-0": "`email`", "9-0": "`signed_at`", "13-0": "`created_at`", "14-0": "`updated_at`", "0-1": "Nome do signatário", "14-1": "Data de última alteração na assinatura", "13-1": "Data de criação da assinatura", "9-1": "Data da assinatura", "8-1": "E-mail do signatário", "7-1": "IP do signatário", "6-1": "Estado da assinatura\n\nOpções:\n\n * `agreed`: assinatura aceita\n * `declined`: assinatura declinada (opção não disponível para novos documentos)\n * `null`: assinatura não realizada", "5-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", "4-1": "Chave do signatário", "2-1": "Empresa do signatário", "1-1": "Cargo do signatário", "0-2": "João Ramalho de Neto Alvez", "1-2": "*null*", "2-2": "*null*", "4-2": "9859-3548-062F-6A03", "5-2": "sign", "6-2": "agreed", "7-2": "196.69.126.63", "8-2": "joao.ramalho@empresaabc.com.br", "9-2": "2015-01-30T11:24:31.523-02:00", "13-2": "2015-01-30T10:42:25.427-02:00", "14-2": "2015-01-30T11:24:31.547-02:00", "h-0": "Atributo", "h-1": "Descrição", "h-2": "Exemplo", "3-0": "`documentation`", "3-1": "CPF ou CNPJ do signatário", "3-2": "123.321.123-40", "10-0": "`allow_method`", "10-2": "token", "10-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.", "11-0": "`phone_number`", "11-1": "Número de telefone para o envio do SMS. Disponível apenas para assinaturas através do Widget.", "11-2": "11987654321", "12-0": "`skip_documentation`", "12-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`.", "12-2": "`true`" }, "cols": 3, "rows": 15 } [/block]