{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"288e1634-6c08-432c-b653-dc84d864a64a","name":"Fluxsign","description":"Seja bem-vindo a documentação oficial da Fluxsign.  \nCom a nossa API você pode integrar sua aplicação, CRM, loja virtual ou qualquer outra aplicação.\n\nPara começar a utilizar é muito simples, nossa API está liberada em todos os planos de acesso, inclusive no gratuíto. [Saiba mais](https://www.fluxsign.com/precos)\n\n### Primeiro Passo: Cadastre-se na Fluxsign!\n\nCrie uma nova conta na Fluxsign, é grátis e não solicitamos cartão de crédito [Clique aqui](https://app.fluxsign.com/signin/?secure=true&register=true)\n\n### Segundo Passo: Identifique seu Token de acesso\n\nComo a API já vem habilitada em todos os planos, nós já geramos um **token** de acesso para sua conta. Para acessá-lo, basta acessar a seguinte opção:\n\n[Configurações](https://app.fluxsign.com/settings/) > Integrações e APIs\n\n<img src=\"https://content.pstmn.io/bfba7615-091d-4d24-9edf-ecf6ab0d81a6/cHJpbnRfdGVsYV9hcGkucG5n\" width=\"619\">\n\nVocê vai utilizar o **Token** para se autenticar em todos os endpoints da nossa API, é como se fosse o seu login e senha.\n\n### Terceiro Passo: Como funciona o processo de autenticação?\n\nÉ muito simples, todos os nossos endpoints utilizam o método de autenticação chamado **Bearer Token (**[mais informações](https://swagger.io/docs/specification/authentication/bearer-authentication/)**)**, que de maneira resumida é uma variável encaminhada no Header da requisição com o seguinte padrão:\n\n\"Authorization\": \"Bearer jfWAFGgTEeTZ-**\\-**\\-*\\-***\"\n\n### Versão da API: V1\n\nNossa API encontra-se na versão 1.0, identificada em nossos endpoints neste formato:\n\n[https://app.fluxsign.com/api/**v1**/acao](https://app.fluxsign.com/api/**v1**/acao)\n\nAs versões de nossas APIs são mantidas por um período mínimo de 2 anos, lançamentos de novas versões são sempre notificadas por e-mail a todos os nossos clientes.\n\n### Tratamento de erros e retornos da API\n\nAlém do status code correspondente (200 em caso de sucesso e 400 em caso de falha), todas as nossas requisições retornam um envelope json padrão:\n\n**Envelope JSON em caso de sucesso:**\n\n``` json\n{\n    \"status\": \"success\",\n    \"title\": \"Document successfully registered\",\n    \"message\": {\n        /* Dados de retorno da requisição */\n    }\n}\n\n```\n\n**Envelope JSON em caso de erro:**\n\n``` json\n{\n    \"status\": \"error\",\n    \"title\": \"validations\",\n    \"message\": {\n        \"16\": \"You have reached the subscription limit for your access plan\"\n    }\n}\n\n```\n\nTodas as mensagens de erros são em Inglês.\n\n**Legenda dos campos:**\n\nstatus: Valores possíveis: success ou error  \ntitle: Mensagem em caso de sucesso ou indicativo de erros em caso de falha  \nmessage: Retorno json com o corpo da requisição\n\n### Webhooks\n\nWebhooks são opcionais, e são utilizados para notificar sua aplicação sobre mudanças de estado e fluxo no processo de assinatura aqui na Fluxsign.\n\nExemplos de notificação que poderiam ser enviadas:\n\n*   Signatário assinou o documento;\n*   Signatário se recusou a assinar o documento;\n    \n\n**Como utilizar o webhook?**\n\nO primeiro passo é configurar a URL do sistema responsável por receber as requisições enviadas pela Fluxsign. Você pode fazer isso no painel de configurações da sua conta:\n\n[Configurações](https://app.fluxsign.com/settings/) > Integrações e APIs\n\n<img src=\"https://content.pstmn.io/ffa0773f-3238-43b3-a2af-65092065797e/cHJpbnRfdGVsYV9hcGlfMi5wbmc=\">\n\n**Tipos de notificações enviadas (eventos)**\n\nNeste momento você pode receber notificações dos seguintes eventos\n\n*   **created**: Novo documento criado (via API ou aplicação);\n*   **signed**: Documento assinado por um dos signatários;\n*   **unsigned**: Assinatura de documento recusada pelo signatário;\n*   **deleted**: Documento deletado da plataforma;\n    \n\n**Exemplos de notificação:**\n\n**created**\n\n``` json\n{\n    \"event\": \"created\",\n    \"status\": \"success\",\n    \"title\": \"Document successfully registered\",\n    \"message\": {\n        \"name\": \"Atestado de Matrícula.pdf\",\n        \"extension\": \"pdf\",\n        \"size\": \"11\",\n        \"document_key\": \"Ee05vHxTToq8RPkob7dFb9JYpx1Oac9J\",\n        \"status\": \"Unsigned\",\n        \"hash_file_original\": \"6f088873b84cb8c176d012969977430e3f3a692222d6e26f596644a46e392dc7\",\n        \"signers\": [\n            {\n                \"signing_key\": \"a1oGscl0ZhdpE30LefOylCtW87q1dwrD\",\n                \"status\": \"Pending\",\n                \"name\": \"Fulano da Silva\",\n                \"email\": \"fulano.teste@fluxsign.com\",\n                \"phone\": \"48984193232\",\n                \"positions\": [],\n                \"comments\": \"Testando o envio via api\",\n                \"send_time\": \"2022-09-17 14:25:33\",\n                \"update_time\": null,\n                \"link\": \"http://fluxsign/view/Ee05vHxTToq8RPkob7dFb9JYpx1Oac9J?signingKey=a1oGscl0ZhdpE30LefOylCtW87q1dwrD\",\n                \"auth\": \"Yes\"\n            },\n            {\n                \"signing_key\": \"V8zoaT5GiyrN9pyWti2DVq4skDWSDJLU\",\n                \"status\": \"Pending\",\n                \"name\": \"Beltrano da Silva\",\n                \"email\": \"beltrano.teste@fluxsign.com\",\n                \"phone\": \"49984195050\",\n                \"positions\": [],\n                \"comments\": \"Convite para assinar documento de Integra API: http://fluxsign/view/Ee05vHxTToq8RPkob7dFb9JYpx1Oac9J?signingKey=a1oGscl0ZhdpE30LefOylCtW87q1dwrD\",\n                \"send_time\": \"2022-09-17 14:25:36\",\n                \"update_time\": null,\n                \"link\": \"http://fluxsign/view/Ee05vHxTToq8RPkob7dFb9JYpx1Oac9J?signingKey=V8zoaT5GiyrN9pyWti2DVq4skDWSDJLU\",\n                \"auth\": \"Yes\"\n            }\n        ]\n    }\n}\n\n```\n\nsigned, unsigned e deleted\n\n``` json\n{\n    \"event\": \"signed\", // muda apenas o evento\n    \"status\": \"success\",\n    \"title\": \"Signatory signed the document\",\n    \"message\": {\n        \"name\": \"Atestado de Matrícula.pdf\",\n        \"extension\": \"pdf\",\n        \"size\": \"11\",\n        \"document_key\": \"Ee05vHxTToq8RPkob7dFb9JYpx1Oac9J\",\n        \"status\": \"Unsigned\",\n        \"hash_file_original\": \"6f088873b84cb8c176d012969977430e3f3a692222d6e26f596644a46e392dc7\",\n        \"signers\": [\n            {\n                \"signing_key\": \"a1oGscl0ZhdpE30LefOylCtW87q1dwrD\",\n                \"status\": \"Signed\",\n                \"name\": \"Fulano da Silva\",\n                \"email\": \"fulano.teste@fluxsign.com\",\n                \"phone\": \"48984193232\",\n                \"positions\": [],\n                \"comments\": \"Testando o envio via api\",\n                \"send_time\": \"2022-09-17 14:25:33\",\n                \"update_time\": null,\n                \"link\": \"http://fluxsign/view/Ee05vHxTToq8RPkob7dFb9JYpx1Oac9J?signingKey=a1oGscl0ZhdpE30LefOylCtW87q1dwrD\",\n                \"auth\": \"Yes\"\n            },\n            {\n                \"signing_key\": \"V8zoaT5GiyrN9pyWti2DVq4skDWSDJLU\",\n                \"status\": \"Pending\",\n                \"name\": \"Beltrano da Silva\",\n                \"email\": \"beltrano.teste@fluxsign.com\",\n                \"phone\": \"49984195050\",\n                \"positions\": [],\n                \"comments\": \"Convite para assinar documento de Integra API: http://fluxsign/view/Ee05vHxTToq8RPkob7dFb9JYpx1Oac9J?signingKey=a1oGscl0ZhdpE30LefOylCtW87q1dwrD\",\n                \"send_time\": \"2022-09-17 14:25:36\",\n                \"update_time\": null,\n                \"link\": \"http://fluxsign/view/Ee05vHxTToq8RPkob7dFb9JYpx1Oac9J?signingKey=V8zoaT5GiyrN9pyWti2DVq4skDWSDJLU\",\n                \"auth\": \"Yes\"\n            }\n        ]\n    }\n}\n\n```\n\n**Orientações:**\n\n*   Todas as requisições são enviadas no formato JSON;\n*   Caso sua aplicação retorno um status code diferente de 200, nossa API tentará efetuar um novo envio. Tentaremos fazer isso 3 vezes;","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"12568934","team":1245124,"collectionId":"288e1634-6c08-432c-b653-dc84d864a64a","publishedId":"2s7YmtD5LC","public":true,"publicUrl":"https://documenter-api.postman.tech/view/12568934/2s7YmtD5LC","privateUrl":"https://go.postman.co/documentation/12568934-288e1634-6c08-432c-b653-dc84d864a64a","customColor":{"top-bar":"C6ECFF","right-sidebar":"303030","highlight":"04B2D9"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.12.10","publishDate":"2022-09-17T21:40:17.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/1553b7ed0d88d60b4e23568614700873bcd72eb3813ac7f8a515206e92f61e89","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2s7YmtD5LC"}