{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"d020d6ef-180e-4c3a-9fdb-d43ad2103b00","name":"ConsultarNFe.com","description":"# Integração REST ConsultarNFe.com\n\nEste documento descreve o **fluxo completo de autenticação**, os **pré-requisitos para integração**, o **funcionamento do modelo de segurança** e o **detalhamento da requisição de autenticação** da API do **ConsultarNFe**.\n\n## 1\\. Visão Geral da Integração\n\nA API do ConsultarNFe utiliza um **modelo de autenticação em duas etapas**, garantindo maior segurança e controle de acesso:\n\n1. **Personal Access Token (PAT)**  \n    Token permanente, gerado manualmente pelo usuário no portal.\n    \n2. **Bearer Token JWT (temporário)**  \n    Token de curta duração, gerado via API, utilizado nas requisições autenticadas.\n    \n\n👉 O **Personal Access Token nunca deve ser usado diretamente nas requisições de negócio**, apenas para gerar o Bearer Token JWT.\n\n## 2\\. O que o usuário deve fazer antes de integrar\n\nAntes de iniciar a integração com a API, o usuário deve obrigatoriamente seguir os passos abaixo:\n\n### 2.1 Cadastro no Portal\n\n1. Acessar o portal:  \n    👉 `https://app.consultarnfe.com`\n    \n2. Realizar o cadastro informando os dados solicitados.\n    \n3. Confirmar o e-mail de ativação enviado após o cadastro.\n    \n4. Efetuar login no portal.\n    \n\n---\n\n### 2.2 Geração do Personal Access Token\n\nApós acessar o portal:\n\n1. Clicar no menu **“Meus Dados”**\n    \n2. Selecionar a opção **“Personal Access Token”**\n    \n3. Clicar em **“Novo Token”**\n    \n4. Informar:\n    \n    - **Descrição** do token (ex: _Integração ERP_, _Sistema Financeiro_, etc.)\n        \n    - **Validade** em dias\n        \n5. Confirmar a operação\n    \n\n✅ Um novo token será exibido na tela.\n\n⚠️ **Importante**\n\n> O token é exibido apenas uma única vez. \n  \n\nNão será possível recuperá-lo posteriormente.\n\nCaso o token seja perdido ou comprometido, será necessário gerar um novo token.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"4920659","team":5754166,"collectionId":"d020d6ef-180e-4c3a-9fdb-d43ad2103b00","publishedId":"2sBXVcmCjH","public":true,"publicUrl":"https://documenter-api.postman.tech/view/4920659/2sBXVcmCjH","privateUrl":"https://go.postman.co/documentation/4920659-d020d6ef-180e-4c3a-9fdb-d43ad2103b00","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2563eb"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"O ConsultarNFe é uma plataforma especializada em consulta, importação, validação e disponibilização de documentos fiscais eletrônicos, projetada para atender empresas, desenvolvedores e sistemas que necessitam acessar informações fiscais de forma segura, confiável e escalável.\n\nA solução permite a obtenção de NF-e a pa"},{"name":"title","value":"ConsultarNFe"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/78e003d6-a5a7-41f3-84b4-494c515efbb2/ZmF2aWNvbl8yNTYucG5n","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"2563eb"}},{"name":"light","logo":"https://content.pstmn.io/3636ac8d-d2be-4878-a5e2-851a08576dd3/ZmF2aWNvbl8yNTYucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2563eb"}}]}},"version":"8.10.1","publishDate":"2026-01-04T17:38:24.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"ConsultarNFe","description":"O ConsultarNFe é uma plataforma especializada em consulta, importação, validação e disponibilização de documentos fiscais eletrônicos, projetada para atender empresas, desenvolvedores e sistemas que necessitam acessar informações fiscais de forma segura, confiável e escalável.\n\nA solução permite a obtenção de NF-e a pa"},"logos":{"logoLight":"https://content.pstmn.io/3636ac8d-d2be-4878-a5e2-851a08576dd3/ZmF2aWNvbl8yNTYucG5n","logoDark":"https://content.pstmn.io/78e003d6-a5a7-41f3-84b4-494c515efbb2/ZmF2aWNvbl8yNTYucG5n"}},"statusCode":200},"environments":[{"name":"Documentação ConsultarNFe.com","id":"50eb4a6c-37aa-4e2d-9b60-93cea958cb5b","owner":"4920659","values":[{"key":"host","value":"https://api.consultarnfe.com","enabled":true,"type":"default"},{"key":"token","value":"","enabled":true,"type":"any"},{"key":"identificacao","value":"api.consultarnfe.com","enabled":true,"type":"default"},{"key":"certificadoNumeroSerie","value":"5141796999995113557","enabled":true,"type":"default"},{"key":"uuid-documento","value":"d7a58e33-dab5-4b9e-8bd8-aeaf4afc96aa","enabled":true,"type":"any"},{"key":"chaveAcesso","value":"31240112345678000123570990000000011000001551","enabled":true,"type":"default"},{"key":"personal-access-token","value":"personal-access-token","enabled":true,"type":"default"},{"key":"chaveAcessoNfe","value":"12345678901234567890123456789012345678901234","enabled":true,"type":"default"},{"key":"xmlNFeBase64","value":"XML_NFE_BASE64","enabled":true,"type":"default"}],"published":true}],"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/29ccdf57c5136de59f794ead1a195eb369e21880bc18874d3788243cd77c82dc","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"},{"label":"Documentação ConsultarNFe.com","value":"4920659-50eb4a6c-37aa-4e2d-9b60-93cea958cb5b"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sBXVcmCjH"}