Retorno do Webhook

Quando um webhook é informado no envio do documento, o mostValid notifica a URL configurada quando o documento é encaminhado para revisão e quando o processo é concluído, enviando o resultado do processamento. Dessa forma, não é necessário consultar periodicamente a rota Consultar status para saber se o resultado está disponível.

Configurando o webhook

O webhook é configurado no objeto webhook da requisição de envio do documento.

Parâmetro	Obrigatório	Descrição
`webhook.url`	Não. Obrigatório quando o webhook for informado.	URL que receberá as notificações do processo.
`webhook.fallbackUrl`	Não	URL alternativa, utilizada quando não for possível entregar a notificação na `webhook.url`.
`webhook.authorization`	Não	Dados de autenticação que o mostValid envia em cada notificação, para que sua aplicação valide a origem da requisição. Aceita uma lista de `headers` e uma lista de `queryStrings`, cada item com `name` e `value`.

Exemplo:

{
  "fileUrl": "https://exemplo.com.br/documentos/nota-fiscal.pdf",
  "webhook": {
    "url": "https://seu-dominio.com.br/webhook/mostvalid",
    "fallbackUrl": "https://seu-dominio.com.br/webhook/mostvalid-fallback",
    "authorization": {
      "headers": [
        {
          "name": "Authorization",
          "value": "Bearer seu-token"
        }
      ]
    }
  }
}

Importante: as URLs informadas devem ser públicas, utilizar HTTPS e estar preparadas para receber requisições POST com corpo application/json.

Quando o webhook é enviado

`processStatus`	Quando ocorre
`TO_ANALYSIS`	Notificação intermediária, enviada ao término da extração automática quando o documento precisa de revisão. Indica quais itens estão pendentes de revisão humana (`TO_ANALYSIS`) e quais não precisam de revisão (`MOSTQIIOCR`).
`FINISHED`	O processo foi concluído e o resultado está disponível, com ou sem revisão.
`ERROR`	Ocorreu uma falha durante o processamento.

Atenção: um mesmo processo pode gerar mais de uma notificação. Quando o documento vai para revisão, sua aplicação recebe primeiro um webhook com TO_ANALYSIS e, após a conclusão da revisão, um segundo webhook com FINISHED. Utilize o campo processStatus para identificar a etapa de cada notificação.

Estrutura do payload

Campo	Tipo	Descrição
`processId`	string (UUID)	Identificador do processo, o mesmo retornado no envio do documento. Utilize-o para relacionar o webhook à requisição original.
`mostQIRequestId`	string	Identificador da requisição de extração.
`processStatus`	string	Status do processo no momento da notificação.
`result`	array	Lista com os documentos encontrados no arquivo. Cada item traz os campos (`fields`), as tabelas (`tables`), o tipo do documento (`type` e `stdType`), a página em que foi encontrado (`pageNumber`), as `tags` de classificação, o `score`, a origem do resultado (`processType`), o `status` de revisão do documento e, quando solicitado no envio, a imagem tipificada (`image`).
`metadata`	object	Informações adicionais do processamento, como os códigos de barras lidos no arquivo (`barcodes`).
`status`	object	Código e mensagem de status (`message`, `code` e `errors`).

Status dos itens no resultado

Cada documento, campo, cabeçalho e célula de tabela possui um status que indica se o item passou por revisão e qual foi o resultado:

Status	Descrição
`TO_ANALYSIS`	O item necessita de revisão e está aguardando análise. Aparece apenas no webhook de `TO_ANALYSIS`.
`MOSTQIIOCR`	O item não foi enviado para revisão, pois, conforme as regras do cliente, a extração feita já é considerada válida.
`MODIFIED`	O item foi enviado para revisão e o seu conteúdo original foi modificado pelo revisor.
`UNREADABLE`	O item foi enviado para revisão e foi marcado como ilegível pelo revisor.
`REVIEWED`	O item foi enviado para revisão e o seu conteúdo original não foi modificado pelo revisor.
`DEPRECATED`	O item corresponde a um campo depreciado. Ele ainda pode ser retornado, mas não é considerado na geração de tarefas nem exibido na revisão. Recomenda-se utilizar o campo atualizado correspondente.

Use o finalValue. O campo value contém o valor extraído automaticamente; o finalValue contém o valor final, já considerando a revisão. No webhook de TO_ANALYSIS, o finalValue de todos os itens é enviado como null, inclusive dos itens MOSTQIIOCR; ele é preenchido apenas no webhook de FINISHED.

Exemplos de payload

Processo finalizado (FINISHED)

Exemplo de webhook de uma DANFE finalizada após revisão. Observe que:

o documento retorna com status REVIEWED, pois passou por revisão, mas nenhum valor foi alterado;

a maior parte dos campos e todas as células da tabela de produtos foram confirmados pelo revisor (REVIEWED);

o campo chave_acesso não precisou de revisão (MOSTQIIOCR);

os campos cep, cep_logradouro, cep_tipo_logradouro, cep_bairro, cep_cidade e cep_uf são campos depreciados (DEPRECATED) e não devem ser utilizados;

o campo image é null, pois o envio não solicitou o retorno da imagem (returnImage).

{
  "processId": "7c1e9a3b-5d2f-4b8a-9e6c-0a2b4c6d8e1f",
  "mostQIRequestId": "Wq3eRt6YuI9oPa2SdF5Gh",
  "processStatus": "FINISHED",
  "result": [
    {
      "fields": [
        {
          "name": "identificacao_emitente",
          "stdName": null,
          "value": "EMPRESA EXEMPLO ENERGIA S.A.\nROD EXEMPLO, KM 100\nDISTRITO INDUSTRIAL - 23900 - 000\nCIDADE FICTÍCIA - RJ Fone/Fax: 2130000000",
          "finalValue": "EMPRESA EXEMPLO ENERGIA S.A.\nROD EXEMPLO, KM 100\nDISTRITO INDUSTRIAL - 23900 - 000\nCIDADE FICTÍCIA - RJ Fone/Fax: 2130000000",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "codigo_barras_leitura_1",
          "stdName": null,
          "value": "33250311222333000181550000000123451123456780",
          "finalValue": "33250311222333000181550000000123451123456780",
          "score": 1,
          "status": "REVIEWED"
        },
        {
          "name": "entrada_saida",
          "stdName": "input_output",
          "value": "1",
          "finalValue": "1",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "chave_acesso",
          "stdName": null,
          "value": "33250311222333000181550000000123451123456780",
          "finalValue": "33250311222333000181550000000123451123456780",
          "score": 1,
          "status": "MOSTQIIOCR"
        },
        {
          "name": "numero_documento",
          "stdName": null,
          "value": "000012345",
          "finalValue": "000012345",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "serie",
          "stdName": null,
          "value": "000",
          "finalValue": "000",
          "score": 1,
          "status": "REVIEWED"
        },
        {
          "name": "natureza_operacao",
          "stdName": null,
          "value": "Remessa de merc. ou bem p conserto ou reparo",
          "finalValue": "Remessa de merc. ou bem p conserto ou reparo",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "numero_protocolo",
          "stdName": null,
          "value": "333250000012345",
          "finalValue": "333250000012345",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "data_protocolo",
          "stdName": null,
          "value": "2025-03-10",
          "finalValue": "2025-03-10",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "hora_protocolo",
          "stdName": null,
          "value": "09:15:00",
          "finalValue": "09:15:00",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "inscricao_estadual_emitente",
          "stdName": null,
          "value": "12345678",
          "finalValue": "12345678",
          "score": 1,
          "status": "REVIEWED"
        },
        {
          "name": "inscricao_estadual_st",
          "stdName": null,
          "value": "",
          "finalValue": "",
          "score": 0.8,
          "status": "REVIEWED"
        },
        {
          "name": "cpf_cnpj_emitente",
          "stdName": null,
          "value": "11222333000181",
          "finalValue": "11222333000181",
          "score": 1,
          "status": "REVIEWED"
        },
        {
          "name": "nome",
          "stdName": null,
          "value": "INSTITUTO EXEMPLO DE METROLOGIA E QUALIDADE",
          "finalValue": "INSTITUTO EXEMPLO DE METROLOGIA E QUALIDADE",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "cpf_cnpj",
          "stdName": null,
          "value": "11444777000161",
          "finalValue": "11444777000161",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "data_emissao",
          "stdName": null,
          "value": "2025-03-10",
          "finalValue": "2025-03-10",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "endereco_logradouro",
          "stdName": null,
          "value": "AVENIDA DAS FLORES, 100",
          "finalValue": "AVENIDA DAS FLORES, 100",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "endereco_bairro",
          "stdName": null,
          "value": "CENTRO",
          "finalValue": "CENTRO",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "endereco_cep",
          "stdName": null,
          "value": "25500000",
          "finalValue": "25500000",
          "score": 1,
          "status": "REVIEWED"
        },
        {
          "name": "data_saida",
          "stdName": null,
          "value": "",
          "finalValue": "",
          "score": 0.8,
          "status": "REVIEWED"
        },
        {
          "name": "endereco_municipio",
          "stdName": null,
          "value": "CIDADE EXEMPLO",
          "finalValue": "CIDADE EXEMPLO",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "endereco_uf",
          "stdName": null,
          "value": "RJ",
          "finalValue": "RJ",
          "score": 0.84,
          "status": "REVIEWED"
        },
        {
          "name": "telefone",
          "stdName": null,
          "value": "+552130000000",
          "finalValue": "+552130000000",
          "score": 1,
          "status": "REVIEWED"
        },
        {
          "name": "inscricao_estadual",
          "stdName": null,
          "value": "",
          "finalValue": "",
          "score": 0.8,
          "status": "REVIEWED"
        },
        {
          "name": "hora_saida",
          "stdName": null,
          "value": "",
          "finalValue": "",
          "score": 0.8,
          "status": "REVIEWED"
        },
        {
          "name": "valor_base_calculo_icms",
          "stdName": null,
          "value": "0.00",
          "finalValue": "0.00",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "valor_icms",
          "stdName": null,
          "value": "0.00",
          "finalValue": "0.00",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "valor_base_calculo_icms_st",
          "stdName": null,
          "value": "0.00",
          "finalValue": "0.00",
          "score": 0.98,
          "status": "REVIEWED"
        },
        {
          "name": "valor_icms_st",
          "stdName": null,
          "value": "0.00",
          "finalValue": "0.00",
          "score": 0.81,
          "status": "REVIEWED"
        },
        {
          "name": "valor_importacao",
          "stdName": null,
          "value": "0.00",
          "finalValue": "0.00",
          "score": 0.97,
          "status": "REVIEWED"
        },
        {
          "name": "valor_fcp",
          "stdName": null,
          "value": "0.00",
          "finalValue": "0.00",
          "score": 0.98,
          "status": "REVIEWED"
        },
        {
          "name": "valor_total_produto",
          "stdName": null,
          "value": "58107.54",
          "finalValue": "58107.54",
          "score": 0.98,
          "status": "REVIEWED"
        },
        {
          "name": "valor_frete",
          "stdName": null,
          "value": "0.00",
          "finalValue": "0.00",
          "score": 0.97,
          "status": "REVIEWED"
        },
        {
          "name": "valor_seguro",
          "stdName": null,
          "value": "0.00",
          "finalValue": "0.00",
          "score": 0.97,
          "status": "REVIEWED"
        },
        {
          "name": "valor_desconto",
          "stdName": null,
          "value": "0.00",
          "finalValue": "0.00",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "valor_outras_despesas",
          "stdName": null,
          "value": "0.00",
          "finalValue": "0.00",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "valor_total_ipi",
          "stdName": null,
          "value": "0.00",
          "finalValue": "0.00",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "valor_icms_destino",
          "stdName": null,
          "value": "0.00",
          "finalValue": "0.00",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "valor_tributo",
          "stdName": null,
          "value": "0.00",
          "finalValue": "0.00",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "valor_total_nota",
          "stdName": null,
          "value": "58107.54",
          "finalValue": "58107.54",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "nome_transportador",
          "stdName": null,
          "value": "EMPRESA EXEMPLO ENERGIA S.A.",
          "finalValue": "EMPRESA EXEMPLO ENERGIA S.A.",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "frete_por_conta",
          "stdName": null,
          "value": "0",
          "finalValue": "0",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "codigo_antt",
          "stdName": null,
          "value": "",
          "finalValue": "",
          "score": 0.8,
          "status": "REVIEWED"
        },
        {
          "name": "placa",
          "stdName": null,
          "value": "",
          "finalValue": "",
          "score": 0.8,
          "status": "REVIEWED"
        },
        {
          "name": "uf_emplacamento",
          "stdName": null,
          "value": "",
          "finalValue": "",
          "score": 0.8,
          "status": "REVIEWED"
        },
        {
          "name": "cpf_cnpj_transportador",
          "stdName": null,
          "value": "11222333000181",
          "finalValue": "11222333000181",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "endereco_logradouro_transportador",
          "stdName": null,
          "value": "ROD EXEMPLO S N, KM 100",
          "finalValue": "ROD EXEMPLO S N, KM 100",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "endereco_municipio_transportador",
          "stdName": null,
          "value": "CIDADE FICTÍCIA",
          "finalValue": "CIDADE FICTÍCIA",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "endereco_uf_transportador",
          "stdName": null,
          "value": "RJ",
          "finalValue": "RJ",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "inscricao_estadual_transportador",
          "stdName": null,
          "value": "12345678",
          "finalValue": "12345678",
          "score": 1,
          "status": "REVIEWED"
        },
        {
          "name": "quantidade",
          "stdName": null,
          "value": "",
          "finalValue": "",
          "score": 0.8,
          "status": "REVIEWED"
        },
        {
          "name": "especie",
          "stdName": null,
          "value": "",
          "finalValue": "",
          "score": 0.8,
          "status": "REVIEWED"
        },
        {
          "name": "marca",
          "stdName": null,
          "value": "",
          "finalValue": "",
          "score": 0.8,
          "status": "REVIEWED"
        },
        {
          "name": "numeracao",
          "stdName": null,
          "value": "",
          "finalValue": "",
          "score": 0.8,
          "status": "REVIEWED"
        },
        {
          "name": "peso_bruto",
          "stdName": null,
          "value": "",
          "finalValue": "",
          "score": 0.8,
          "status": "REVIEWED"
        },
        {
          "name": "peso_liquido",
          "stdName": null,
          "value": "",
          "finalValue": "",
          "score": 0.8,
          "status": "REVIEWED"
        },
        {
          "name": "outras_informacoes",
          "stdName": null,
          "value": "Inf. Contribuinte: MATERIAL DE PROPRIEDADE DA EMPRESA EXEMPLO SEGUINDO PARA REPARO COM POSTERIOR RETORNO DADOS 01 TERMORESISTENCIA ID 000001 MODELO 00001A NP000001 DADOS 02 TERMORESISTENCIA ID 000002 PT100 MOD 00002NP000002 DADOS 03 AMPLIFICADOR MODELO 0000A ID000003 NP000003 DADOS 04 AMPLIFICADOR MODELO 0000A ID000004 NP000004 PLACA DO VEICULO ABC1D23 NAO INCIDENCIA DE ICMS CONSOANTE INCISO IIIART47LIVRO I DO RICMS RJ DECRETO 27427 2000 CST 041 NAO TRIBUTADA",
          "finalValue": "Inf. Contribuinte: MATERIAL DE PROPRIEDADE DA EMPRESA EXEMPLO SEGUINDO PARA REPARO COM POSTERIOR RETORNO DADOS 01 TERMORESISTENCIA ID 000001 MODELO 00001A NP000001 DADOS 02 TERMORESISTENCIA ID 000002 PT100 MOD 00002NP000002 DADOS 03 AMPLIFICADOR MODELO 0000A ID000003 NP000003 DADOS 04 AMPLIFICADOR MODELO 0000A ID000004 NP000004 PLACA DO VEICULO ABC1D23 NAO INCIDENCIA DE ICMS CONSOANTE INCISO IIIART47LIVRO I DO RICMS RJ DECRETO 27427 2000 CST 041 NAO TRIBUTADA",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "cep",
          "stdName": "postal_code",
          "value": "25500000",
          "finalValue": "25500000",
          "score": 1,
          "status": "DEPRECATED"
        },
        {
          "name": "cep_logradouro",
          "stdName": "postal_place",
          "value": "AVENIDA DAS FLORES",
          "finalValue": "AVENIDA DAS FLORES",
          "score": 1,
          "status": "DEPRECATED"
        },
        {
          "name": "cep_tipo_logradouro",
          "stdName": "postal_place_kind",
          "value": null,
          "finalValue": null,
          "score": null,
          "status": "DEPRECATED"
        },
        {
          "name": "cep_bairro",
          "stdName": "postal_suburb",
          "value": "CENTRO",
          "finalValue": "CENTRO",
          "score": 1,
          "status": "DEPRECATED"
        },
        {
          "name": "cep_cidade",
          "stdName": "postal_city",
          "value": "CIDADE EXEMPLO",
          "finalValue": "CIDADE EXEMPLO",
          "score": 1,
          "status": "DEPRECATED"
        },
        {
          "name": "cep_uf",
          "stdName": "postal_state",
          "value": "RJ",
          "finalValue": "RJ",
          "score": 1,
          "status": "DEPRECATED"
        }
      ],
      "image": null,
      "type": "documento-fiscal",
      "stdType": "fiscal-document",
      "pageNumber": 1,
      "tags": [
        "country=bra",
        "has=address",
        "id=bra-danfe-187",
        "language=pt-BR",
        "process-type=extraction",
        "std-type=fiscal-document",
        "subtype=danfe",
        "type=documento-fiscal"
      ],
      "score": 0.98,
      "tables": [
        {
          "name": "tabela_produto_servico",
          "stdName": null,
          "headers": [
            {
              "score": 0.99,
              "name": "codigo",
              "stdName": null,
              "status": "REVIEWED"
            },
            {
              "score": 0.99,
              "name": "descricao",
              "stdName": null,
              "status": "REVIEWED"
            },
            {
              "score": 0.99,
              "name": "ncm_sh",
              "stdName": null,
              "status": "REVIEWED"
            },
            {
              "score": 0.99,
              "name": "cst_csosn",
              "stdName": null,
              "status": "REVIEWED"
            },
            {
              "score": 0.95,
              "name": "cfop",
              "stdName": null,
              "status": "REVIEWED"
            },
            {
              "score": 0.99,
              "name": "unidade",
              "stdName": null,
              "status": "REVIEWED"
            },
            {
              "score": 0.99,
              "name": "quantidade",
              "stdName": null,
              "status": "REVIEWED"
            },
            {
              "score": 0.99,
              "name": "valor_unitario",
              "stdName": null,
              "status": "REVIEWED"
            },
            {
              "score": 0.99,
              "name": "valor_total",
              "stdName": null,
              "status": "REVIEWED"
            },
            {
              "score": 0.99,
              "name": "valor_desconto",
              "stdName": null,
              "status": "REVIEWED"
            },
            {
              "score": 0.99,
              "name": "valor_base_calculo_icms",
              "stdName": null,
              "status": "REVIEWED"
            },
            {
              "score": 0.99,
              "name": "valor_icms",
              "stdName": null,
              "status": "REVIEWED"
            },
            {
              "score": null,
              "name": "valor_ipi",
              "stdName": null,
              "status": "REVIEWED"
            },
            {
              "score": 0.99,
              "name": "aliquota_icms",
              "stdName": null,
              "status": "REVIEWED"
            },
            {
              "score": null,
              "name": "aliquota_ipi",
              "stdName": null,
              "status": "REVIEWED"
            }
          ],
          "values": [
            [
              {
                "value": "000000000000000001",
                "finalValue": "000000000000000001",
                "score": 0.99,
                "name": "codigo",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "TERMORESISTENCIA PLATINA NAO INCIDENCIA DE ICMS, CONSOANTE INCISO III, ART. 47, LIVRO I DO RICMS/RJ, DECRETO 27.427/2000. CST - 041 - NAO TRIBUTADA.",
                "finalValue": "TERMORESISTENCIA PLATINA NAO INCIDENCIA DE ICMS, CONSOANTE INCISO III, ART. 47, LIVRO I DO RICMS/RJ, DECRETO 27.427/2000. CST - 041 - NAO TRIBUTADA.",
                "score": 0.99,
                "name": "descricao",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "85489010",
                "finalValue": "85489010",
                "score": 1,
                "name": "ncm_sh",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "041",
                "finalValue": "041",
                "score": 0.99,
                "name": "cst_csosn",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "5915",
                "finalValue": "5915",
                "score": 0.99,
                "name": "cfop",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "PC",
                "finalValue": "PC",
                "score": 0.99,
                "name": "unidade",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "1.0000",
                "finalValue": "1.0000",
                "score": 0.99,
                "name": "quantidade",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "6887.1000",
                "finalValue": "6887.1000",
                "score": 1,
                "name": "valor_unitario",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "6887.10",
                "finalValue": "6887.10",
                "score": 1,
                "name": "valor_total",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "0.00",
                "finalValue": "0.00",
                "score": 0.99,
                "name": "valor_desconto",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "0.00",
                "finalValue": "0.00",
                "score": 0.99,
                "name": "valor_base_calculo_icms",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "0.00",
                "finalValue": "0.00",
                "score": 0.99,
                "name": "valor_icms",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": null,
                "finalValue": null,
                "score": null,
                "name": "valor_ipi",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "0.00",
                "finalValue": "0.00",
                "score": 0.99,
                "name": "aliquota_icms",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": null,
                "finalValue": null,
                "score": null,
                "name": "aliquota_ipi",
                "stdName": null,
                "status": "REVIEWED"
              }
            ],
            [
              {
                "value": "000000000000000001",
                "finalValue": "000000000000000001",
                "score": 0.99,
                "name": "codigo",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "TERMORESISTENCIA PLATINA NAO INCIDENCIA DE ICMS, CONSOANTE INCISO III, ART. 47, LIVRO I DO RICMS/RJ, DECRETO 27.427/2000. CST - 041 - NAO TRIBUTADA.",
                "finalValue": "TERMORESISTENCIA PLATINA NAO INCIDENCIA DE ICMS, CONSOANTE INCISO III, ART. 47, LIVRO I DO RICMS/RJ, DECRETO 27.427/2000. CST - 041 - NAO TRIBUTADA.",
                "score": 0.99,
                "name": "descricao",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "85489010",
                "finalValue": "85489010",
                "score": 1,
                "name": "ncm_sh",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "041",
                "finalValue": "041",
                "score": 0.99,
                "name": "cst_csosn",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "5915",
                "finalValue": "5915",
                "score": 1,
                "name": "cfop",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "PC",
                "finalValue": "PC",
                "score": 0.99,
                "name": "unidade",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "1.0000",
                "finalValue": "1.0000",
                "score": 0.99,
                "name": "quantidade",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "6887.1000",
                "finalValue": "6887.1000",
                "score": 0.99,
                "name": "valor_unitario",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "6887.10",
                "finalValue": "6887.10",
                "score": 0.99,
                "name": "valor_total",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "0.00",
                "finalValue": "0.00",
                "score": 0.99,
                "name": "valor_desconto",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "0.00",
                "finalValue": "0.00",
                "score": 0.99,
                "name": "valor_base_calculo_icms",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "0.00",
                "finalValue": "0.00",
                "score": 0.99,
                "name": "valor_icms",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": null,
                "finalValue": null,
                "score": null,
                "name": "valor_ipi",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "0.00",
                "finalValue": "0.00",
                "score": 0.99,
                "name": "aliquota_icms",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": null,
                "finalValue": null,
                "score": null,
                "name": "aliquota_ipi",
                "stdName": null,
                "status": "REVIEWED"
              }
            ],
            [
              {
                "value": "000000000000000002",
                "finalValue": "000000000000000002",
                "score": 0.99,
                "name": "codigo",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "AMPLIFICADOR NAO INCIDENCIA DE ICMS, CONSOANTE INCISO III, ART. 47, LIVRO I DO RICMS/RJ, DECRETO 27.427/2000. CST - 041 - NAO TRIBUTADA.",
                "finalValue": "AMPLIFICADOR NAO INCIDENCIA DE ICMS, CONSOANTE INCISO III, ART. 47, LIVRO I DO RICMS/RJ, DECRETO 27.427/2000. CST - 041 - NAO TRIBUTADA.",
                "score": 0.99,
                "name": "descricao",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "85184000",
                "finalValue": "85184000",
                "score": 1,
                "name": "ncm_sh",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "141",
                "finalValue": "141",
                "score": 0.99,
                "name": "cst_csosn",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "5915",
                "finalValue": "5915",
                "score": 1,
                "name": "cfop",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "UN",
                "finalValue": "UN",
                "score": 1,
                "name": "unidade",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "1.0000",
                "finalValue": "1.0000",
                "score": 0.99,
                "name": "quantidade",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "28994.5000",
                "finalValue": "28994.5000",
                "score": 0.99,
                "name": "valor_unitario",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "28994.50",
                "finalValue": "28994.50",
                "score": 0.99,
                "name": "valor_total",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "0.00",
                "finalValue": "0.00",
                "score": 0.99,
                "name": "valor_desconto",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "0.00",
                "finalValue": "0.00",
                "score": 0.99,
                "name": "valor_base_calculo_icms",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "0.00",
                "finalValue": "0.00",
                "score": 0.98,
                "name": "valor_icms",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": null,
                "finalValue": null,
                "score": null,
                "name": "valor_ipi",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "0.00",
                "finalValue": "0.00",
                "score": 0.98,
                "name": "aliquota_icms",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": null,
                "finalValue": null,
                "score": null,
                "name": "aliquota_ipi",
                "stdName": null,
                "status": "REVIEWED"
              }
            ],
            [
              {
                "value": "000000000000000002",
                "finalValue": "000000000000000002",
                "score": 0.99,
                "name": "codigo",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "AMPLIFICADOR NAO INCIDENCIA DE ICMS, CONSOANTE INCISO III, ART. 47, LIVRO I DO RICMS/RJ, DECRETO 27.427/2000. CST - 041 - NAO TRIBUTADA.",
                "finalValue": "AMPLIFICADOR NAO INCIDENCIA DE ICMS, CONSOANTE INCISO III, ART. 47, LIVRO I DO RICMS/RJ, DECRETO 27.427/2000. CST - 041 - NAO TRIBUTADA.",
                "score": 0.99,
                "name": "descricao",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "85184000",
                "finalValue": "85184000",
                "score": 0.99,
                "name": "ncm_sh",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "141",
                "finalValue": "141",
                "score": 0.99,
                "name": "cst_csosn",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "5915",
                "finalValue": "5915",
                "score": 0.82,
                "name": "cfop",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "UN",
                "finalValue": "UN",
                "score": 1,
                "name": "unidade",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "1.0000",
                "finalValue": "1.0000",
                "score": 0.99,
                "name": "quantidade",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "15338.8400",
                "finalValue": "15338.8400",
                "score": 0.99,
                "name": "valor_unitario",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "15338.84",
                "finalValue": "15338.84",
                "score": 0.99,
                "name": "valor_total",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "0.00",
                "finalValue": "0.00",
                "score": 0.99,
                "name": "valor_desconto",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "0.00",
                "finalValue": "0.00",
                "score": 0.97,
                "name": "valor_base_calculo_icms",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "0.00",
                "finalValue": "0.00",
                "score": 0.99,
                "name": "valor_icms",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": null,
                "finalValue": null,
                "score": null,
                "name": "valor_ipi",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": "0.00",
                "finalValue": "0.00",
                "score": 0.99,
                "name": "aliquota_icms",
                "stdName": null,
                "status": "REVIEWED"
              },
              {
                "value": null,
                "finalValue": null,
                "score": null,
                "name": "aliquota_ipi",
                "stdName": null,
                "status": "REVIEWED"
              }
            ]
          ],
          "score": 0.99,
          "status": "MOSTQIIOCR"
        }
      ],
      "processType": "extraction",
      "status": "REVIEWED"
    }
  ],
  "metadata": {
    "barcodes": []
  },
  "status": {
    "message": "Ok",
    "code": "S100",
    "errors": null
  }
}

Processo enviado para revisão (TO_ANALYSIS)

O webhook de TO_ANALYSIS segue a mesma estrutura do exemplo de FINISHED. O result traz os dados extraídos automaticamente, e os itens que aguardam revisão aparecem com status TO_ANALYSIS. Esse webhook serve para informar que o documento está em revisão; o resultado definitivo deve ser considerado apenas no webhook de FINISHED.

Boas práticas para receber o webhook

Valide a origem. Utilize o parâmetro webhook.authorization para que o mostValid envie um header ou query string conhecido pela sua aplicação, e rejeite requisições que não o contenham.

Responda rapidamente. Retorne um status HTTP 2xx assim que receber a requisição e processe o conteúdo de forma assíncrona, evitando que a entrega seja considerada como falha.

Use o processId como chave. Relacione o webhook ao documento enviado por meio do processId. Como um mesmo processo pode notificar TO_ANALYSIS e depois FINISHED, use o processStatus para decidir a ação e trate de forma idempotente uma mesma notificação recebida mais de uma vez.

Identifique os itens pelo nome. A ordem dos documentos, campos e células não é garantida. Utilize sempre o atributo name para localizar cada valor.

Ignore os campos depreciados. Itens com status DEPRECATED podem deixar de ser retornados em versões futuras. Utilize os campos atualizados correspondentes.

Tenha uma alternativa. Caso sua aplicação não receba o webhook, o resultado pode ser consultado na rota Consultar status, informando o processId, por até uma hora após o processo atingir um status final.

Retorno do Webhook

Configurando o webhook#

Quando o webhook é enviado#

Estrutura do payload#

Status dos itens no resultado#

Exemplos de payload#

Processo finalizado (FINISHED)#

Processo enviado para revisão (TO_ANALYSIS)#

Boas práticas para receber o webhook#