Datasets para validação de notas fiscais

O dataset Documento Fiscal - Acompanhamento (FISCAL_TRACKING) tem como finalidade consultar e coletar dados de autenticidade de documentos fiscais em fontes públicas oficiais (se houver automação compatível disponível).

Esse dataset é uma evolução do serviço Invoice Extraction.

Clique aqui para baixar a última versão da lista de cobertura da consulta de autenticidade.

TIP

Não encontrou o tipo de documento fiscal ou a localidade desejada em nossa lista de cobertura? Entre em contato com nosso Suporte e forneça amostras dos documentos fiscais. Assim, poderemos avaliar a viabilidade de atender a esse tipo de documento ou localidade.

Os tipos de documentos aceitos

Tipo	Descrição	Tipo do parâmetro necessário para consulta de autenticidade à fonte oficial
DANFe	Documento Auxiliar da NFe – Nota Fiscal Eletrônica (modelo 55).	`chave_acesso`
DANFCe	Nota Fiscal de Consumidor Eletrônica (modelo 65).	`qrcode`
DANFSe	Documento Auxiliar da NFSe – Nota Fiscal de Serviço Eletrônica.	A consulta será realizada utilizando o qrcode presente na NFSe. Caso o `qrcode` não esteja disponível no documento, a consulta será feita com base no conjunto de dados exigidos pela fonte, que pode variar conforme a localidade. Esse conjunto de dados será automaticamente identificado pela camada de consulta de autenticidade, utilizando as informações previamente extraídas pela camada iOCR.
DACTe	Documento Auxiliar do CTe – Conhecimento de Transporte Eletrônico.	`chave_acesso` ou `qrcode`
NF3e	Nota Fiscal de Energia Elétrica Eletrônica (modelo 66).	A consulta será realizada utilizando o `qrcode` presente na fatura de energia elétrica que contém o link para a verificação da autenticidade da NF3e.
DAMDFe	Documento Auxiliar do MDF-e – Manifesto Eletrônico de Documentos Fiscais.	`chave_acesso` ou `qrcode`
CIOT	Código Identificador da Operação de Transporte (CIOT) na ANTT.	`ciot` ou `rntrc`

Parâmetros obrigatórios

É preciso informar, no corpo da requisição ao Enrichment, pelo menos um dos seguintes parâmetros:

mostqiResponse: Resultado em JSON da extração previamente realizada na rota Content Extraction.

mostqiResponseBase64: Resultado da extração realizada na rota Content Extraction convertido em base64 .

chave_acesso: Número de 44 dígitos presentes na Nota Fiscal.

qrcode: QRCode que contenha a URL de acesso.

ciot: Código Identificador da Operação de Transporte.

rntrc: Registro Nacional de Transportadores Rodoviários de Cargas.

Sugestão de fluxo

Para otimizar os resultados e automatizar o processo, recomendamos que o dataset FISCAL_TRACKING seja usado em conjunto com a rota Content Extraction, seguindo o fluxo abaixo.

Esse fluxo garante maior precisão e eficiência na análise dos documentos fiscais.

Etapa 1: Extração de Dados

Envie o documento fiscal para a rota Content Extraction para realizar a extração das informações.

Etapa 2: Enriquecimento de Dados

Na requisição ao serviço Enrichment, inserir:

O response da rota Content Extraction (JSON) no atributo mostqiResponse.

O nome da consulta (query) FISCAL_TRACKING no atributo query.

Exemplo do corpo de requisição para o fluxo acima

   {
       "query": "FISCAL_TRACKING",
       "parameters": 
           {"mostqiResponse":
               {
                 "result": [...]
               }
           }
   }

TIP

💡 Importante: Certifique-se de definir o atributo Metadata da rota Content Extraction como verdadeiro!

Isso permite a extração de QR Codes presentes em documentos fiscais, mesmo para modelos não treinados pelo mostQI, ampliando significativamente a abrangência e a relevância do dataset FISCAL_TRACKING.

INFO

Uma query pode incluir um ou mais datasets. Os nomes das consultas (queries) são definidos pelo Suporte da MOST ou pelo próprio cliente.

A query FISCAL_TRACKING foi criada especificamente para retornar os dados do dataset FISCAL_TRACKING. No entanto, é fundamental ressaltar que o nome da query nem sempre será idêntico ao nome do dataset que ela contém.

Dados retornados

Os dados retornados variam de acordo com as informações disponibilizadas pela fonte oficial correspondente a cada tipo de documento fiscal e/ou localidade.
As informações coletadas estarão organizadas nos objetos fields e tables, cada um contendo duas identificações:

name: apresenta o nome do campo padronizado.

origin_name: apresenta o título original do campo conforme disponibilizado pela fonte oficial.

Veja o exemplo abaixo com um trecho de retorno:

{
                "name": "fiscal_tracking",
                "code": "fiscal_tracking_ondemand_fiscal_817669",
                "status": "DONE",
                "fromCache": false,
                "errors": [],
                "data": [
                    {
                        "type": "documento-fiscal",
                        "stdType": null,
                        "score": null,
                        "tags": null,
                        "extractions": [
                            {
                                "source": "official",
                                "score": null,
                                "tags": [
                                    "country=bra",
                                    "goal=query",
                                    "has=address",
                                    "id=bra-fiscal-nfse-369840-1",
                                    "language=pt-BR",
                                    "of=service",
                                    "std-type=fiscal-document",
                                    "subtype=invoice",
                                    "subtype=nfse",
                                    "type=documento-fiscal"
                                ],
                                "sections": [
                                    {
                                        "name": null,
                                        "score": 1,
                                        "pages": [
                                            {
                                                "number": 1
                                            }
                                        ],
                                        "fields": [
                                            {
                                "name": "natureza_operacao",
                                "origin_name": "Natureza da operação",
                                "value": "VENDAS MERC.SUB.TRIBUTARIA DENTRO DO ESTADO",
                                "score": null
                                            },
                                            {
                                "name": "tipo_operacao",
                                "origin_name": "Tipo da operação",
                                "value": "1 - Saída",
                                "score": null
                                            }
                                        ]
                                            ...

INFO

Se houver automação compatível para a nota processada pelo iOCR, será realizada a navegação para a consulta do documento fiscal na fonte oficial. No entanto, se o documento não for encontrado na fonte, o resultado da fonte "official" não será retornado, exceto para casos em que a fonte explicitar se tratar de uma nota falsificada ou inválida.

Se a nota for encontrada na fonte, além dos campos coletados, o atributo autenticidade_nota será retornado com o valor "1".

            {
              "name": "autenticidade_nota",
              "value": "1",
              "score": 1
            }

Se a nota não for encontrada na fonte, mas a fonte retornar explicitamente que se trata de uma nota falsificada ou inválida, o resultado da fonte "official" será retornado com o atributo autenticidade_nota definido como "0".

            {
              "name": "autenticidade_nota",
              "value": "0",
              "score": 1
            }

Clique aqui para baixar a última versão da lista de cobertura da consulta de autenticidade.

TIP

Não encontrou o tipo de documento fiscal ou a localidade desejada em nossa lista de cobertura? Entre em contato com nosso Suporte e forneça amostras dos documentos fiscais. Assim, poderemos avaliar a viabilidade de atender a esse tipo de documento ou localidade.

Dataset de Documentos Fiscais

Os tipos de documentos aceitos#

Parâmetros obrigatórios#

Sugestão de fluxo#

Exemplo do corpo de requisição para o fluxo acima#

Dados retornados#

Os tipos de documentos aceitos

Parâmetros obrigatórios

Sugestão de fluxo

Exemplo do corpo de requisição para o fluxo acima

Dados retornados