--- title: "NF-e Completa por Chave de Acesso" description: "API NF-e Completa por Chave de Acesso" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/01bada17-ea67-4472-ac2b-b0a63ced9dfd markdown: https://doc.apibrasil.io/apis/creditos/01bada17-ea67-4472-ac2b-b0a63ced9dfd.md source: apibrasil-documentation --- # NF-e Completa por Chave de Acesso > API NF-e Completa por Chave de Acesso - **Categoria:** Dados e Utilidades - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 2,86 por consulta - **Limite:** 990.000 por mês - **Cadastro:** exige CNPJ - **Versão:** v2 - **Publicada por:** APIBrasil - **Especificação OpenAPI:** https://doc.apibrasil.io/apis/creditos/01bada17-ea67-4472-ac2b-b0a63ced9dfd/openapi.json ## Como chamar **Endereço base:** `https://gateway.apibrasil.io/api/v2` Autenticação: cabeçalho `Authorization: Bearer `. Nada além disso. Com `homolog: true` no corpo, o gateway responde de uma base fixa, com a forma real da resposta, e não cobra. O CPF 00000000000 é dessa base e não é de ninguém: use-o nos testes, nunca em produção. ## Endpoints (1 endpoint) ### 1. POST /consulta/cpf/credits Envie um POST com tipo=nfe-completa e a chave de acesso da NF-e (44 dígitos; espaços, pontos e hífens são removidos; a UF e o dígito verificador são conferidos). A resposta vem em data.dados e traz chave_acesso, identificacao, emitente, destinatario, itens, totais, formas_pagamento, transporte, informacoes_complementares, resumo e o link pdf da nota. A cobrança acontece quando a nota é localizada e traz conteúdo; nota não encontrada responde HTTP 404, sem cobrança; campo chave ausente ou inválido é recusado com HTTP 400, sem cobrança. Fonte indisponível responde HTTP 502, 503 ou 504, também sem cobrança. Em homologação (homolog=true) a resposta é uma amostra fictícia completa, sem cobrança, para qualquer chave válido. - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/cpf/credits` - **Versão da rota:** v2 **Cabeçalhos** | Cabeçalho | Valor | | --- | --- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer $APIBRASIL_TOKEN` | **Corpo da requisição** ```json { "tipo": "nfe-completa", "chave": "35260811222333000181550010000123451123456780", "homolog": true } ``` **Em cURL** ```bash curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/cpf/credits" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $APIBRASIL_TOKEN" \ -d '{"tipo":"nfe-completa","chave":"35260811222333000181550010000123451123456780","homolog":true}' ``` Este endpoint aceita `homolog: true` no corpo: a resposta volta com dados válidos, `api_limit_for` igual a `homolog` e sem tarifação. **Resposta de exemplo, do catálogo** ```json { "user": { "first_name": "[omitido]", "email": "[omitido]", "cellphone": "[omitido]", "notification": "yes" }, "balance": "397,140", "balance_before": "400,000", "tax": "2,860", "status_code": 200, "error": false, "message": "Dados validos! Voce foi tarifado em R$ 2,86.", "valor_consulta": 2.86, "api_limit_for": "credit", "homolog": false, "data": { "dados": { "chave_acesso": "35260811222333000181550010000123451123456780", "destinatario": { "documento": "40442820135", "email": "[omitido]", "endereco": { "bairro": "Centro", "cep": "01000000", "logradouro": "Rua Teste", "municipio": "Município Teste", "numero": "200", "telefone": "1100000000", "uf": "SP" }, "indicador_ie": "Não contribuinte", "inscricao_estadual": null, "nome": "FULANO DE TESTE" }, "emitente": { "cnpj": "11222333000181", "endereco": { "bairro": "Centro", "cep": "01000000", "logradouro": "Rua Teste", "municipio": "Município Teste", "numero": "100", "telefone": "1100000000", "uf": "SP" }, "inscricao_estadual": "111222333444", "nome_fantasia": "EMPRESA TESTE", "razao_social": "EMPRESA TESTE LTDA" }, "formas_pagamento": [ { "data_pagamento": "01/08/2026", "descricao": "Dinheiro", "forma": "01", "indicador": "À vista", "valor": 105 } ], "identificacao": { "data_emissao": "01/08/2026", "modelo": 55, "natureza_operacao": "Venda de mercadoria", "numero": 12345, "serie": 1, "tipo_operacao": "Saída" }, "informacoes_complementares": "Nota fiscal fictícia para homologação", "itens": [ { "cest": "0100100", "cfop": "5102", "codigo_produto": "P001", "descricao": "Produto fictício A", "impostos": { "aliquota_icms": 18, "base_icms": 60, "cofins": { "aliquota": 7.6, "base_calculo": 60, "cst": "01", "valor": 4.56 }, "pis": { "aliquota": 1.65, "base_calculo": 60, "cst": "01", "valor": 0.99 }, "valor_icms": 10.8 }, "ncm": "12345678", "numero_item": 1, "quantidade": 2, "unidade": "UN", "valor_total": 60, "valor_unitario": 30 }, { "cest": null, "cfop": "5102", "codigo_produto": "P002", "descricao": "Produto fictício B", "impostos": { "aliquota_icms": 18, "base_icms": 40, "cofins": { "aliquota": 7.6, "base_calculo": 40, "cst": "01", "valor": 3.04 }, "pis": { "aliquota": 1.65, "base_calculo": 40, "cst": "01", "valor": 0.66 }, "valor_icms": 7.2 }, "ncm": "87654321", "numero_item": 2, "quantidade": 1, "unidade": "UN", "valor_total": 40, "valor_unitario": 40 } ], "pdf": "(link do PDF da consulta)", "resumo": { "quantidade_itens": 2, "valor_total_nfe": 105, "valor_total_tributos": 27.25 }, "totais": { "base_cbs": 0, "base_ibs": 0, "base_icms": 100, "valor_cbs": 0, "valor_cofins": 7.6, "valor_desconto": 5, "valor_frete": 10, "valor_ibs": 0, "valor_icms": 18, "valor_ipi": 0, "valor_outros": 0, "valor_pis": 1.65, "valor_produtos": 100, "valor_seguro": 0, "valor_total_nfe": 105, "valor_total_tributos": 27.25 }, "transporte": { "cnpj": "11222333000181", "modalidade_frete": "Por conta do remetente", "razao_social": "TRANSPORTADORA TESTE LTDA", "volume": { "especie": "Caixa", "peso_bruto": 12.5, "peso_liquido": 11, "quantidade": 3 } } } } } ``` Nos exemplos de resposta, os campos da conta que gerou o exemplo (`user.first_name`, `user.email`, `user.cellphone`) saem como `[omitido]`. O resto é o que o catálogo publica. ## Armadilhas: o que uma integração erra sem avisar Apuradas nas respostas que o próprio catálogo publica. Em todas elas o código funciona no caminho feliz e falha em silêncio no resto: 1. **O erro chega no CORPO, com HTTP 200.** A resposta traz um campo `error` booleano e uma `message`. Checar só `response.ok` ou o status HTTP deixa passar falha como sucesso. Confira SEMPRE `error === false` antes de ler `data`. 2. **`balance`, `tax` e `extra_charges.total` são STRING em formato brasileiro — e o formato varia entre APIs.** Valores observados no catálogo: `"154,380"`, `"497,84"`, `"0,000"` e `"0.19"`. Vírgula em umas, ponto em outra; três casas decimais em umas, duas em outra. Em JavaScript, `parseFloat("154,380")` devolve `154` e perde os centavos sem erro nenhum, e `Number("154,380")` devolve `NaN`. Escreva um conversor que trate os dois separadores, e nunca use esses campos numa decisão financeira sem convertê-los. 3. **Cada chamada custa dinheiro.** Retry cego multiplica a conta. Nunca repita automaticamente um 4xx: parâmetro errado repetido continua errado e continua cobrando. Repita só tempo esgotado e 5xx, com recuo exponencial e um teto pequeno de tentativas. 4. **HTTP 402 é saldo insuficiente, e repetir não resolve.** É o único status que exige ação humana — recarregar. Trate-o como erro terminal, com mensagem própria, e não o jogue no mesmo balde dos 4xx genéricos. 5. **`extra_charges` cobra à parte do preço da consulta.** Quando o corpo pede serviços adicionais, a resposta traz cada um com o preço e um `total` que NÃO está incluso no valor base. Se você mostra custo a quem usa, some os dois. ## Ver também - Especificação OpenAPI: https://doc.apibrasil.io/apis/creditos/01bada17-ea67-4472-ac2b-b0a63ced9dfd/openapi.json - Catálogo de APIs: [Catálogo de APIs](https://doc.apibrasil.io/apis.md) - SDKs oficiais: [SDKs oficiais](https://doc.apibrasil.io/sdks.md) - Índice da documentação: https://doc.apibrasil.io/llms.txt - Versão HTML desta página: https://doc.apibrasil.io/apis/creditos/01bada17-ea67-4472-ac2b-b0a63ced9dfd