Consultar status [application/json]

Status

Caso prefira monitorar o progresso ou em caso de falha no webhook, os dados ficam disponíveis para consulta por até 1 hora.

Limite de Consulta: Esta rota permite até 8 requisições por segundo por cliente, sendo recomendada para o acompanhamento pontual do status ou como mecanismo de contingência ao Webhook.

Atenção sobre a estrutura do JSON: a ordem das seções, campos e células no resultado é dinâmica e pode ser alterada sem aviso prévio. Identifique cada item pelo atributo name (ou stdName), e nunca pela sua posição no array. Assim, novos campos ou mudanças na ordem não impactam sua integração.

Status do processo

Abaixo tabela com os possíveis status do processo retornado no campo processStatus.

Nome	Descrição
IN_PROCESS	O arquivo enviado está sendo tipificado e processado para verificar se necessita de complementação.
ERROR	Indica que ocorreu um erro durante uma ou mais etapas do processo.
TO_ANALYSIS	O arquivo necessita de complementação e está aguardando para ser analisado.
IN_ANALYSIS	O arquivo necessita de complementação e está sendo analisado por um complementador.
FINISHED	O arquivo foi analisado com sucesso e retornou o resultado, com complementação ou não.

Status dos atributos

Abaixo tabela com possíveis status retornados no campo status dos atributos, onde o contexto pode se referir à extração, à seção, ao campo, à célula da tabela ou ao cabeçalho da tabela.

Status	Descrição
TO_ANALYSIS	O item necessita de revisão e está aguardando análise.
MOSTQIIOCR	O item não foi enviado para validação pelo revisor, pois conforme as regras do cliente, a extração feita já é considerada válida.
MODIFIED	O item sofreu alguma alteração durante a revisão. Em campos e células, indica que o valor original foi alterado pelo revisor. Em extrações e seções, indica que houve alteração em itens contidos nelas durante a revisão.
UNREADABLE	O item foi enviado para validação, pois foi verificado que ele necessitava de revisão, conforme as regras definidas pelo cliente; sendo marcado como ilegível pelo revisor.
REVIEWED	O item foi enviado para validação, pois foi verificado que ele necessitava de revisão, conforme as regras definidas pelo cliente, e o seu conteúdo original não foi modificado pelo revisor.
DEPRECATED	Trata-se de um item com nome do campo depreciado e que não será exibido no Portal mostValid para análise durante a tarefa de revisão. Recomenda-se considerar os nomes de campos correspondentes atualizados.

Códigos de solicitação

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200OK

application/json

Bodyapplication/json

Examples

Sucesso - TO_ANALYSISSucesso - FINISHED

{
    "mostQiRequestId": "Ac3dEf6GhI9jKl2MnO5pQ",
    "processId": "4f7a2c9e-1b3d-4e6f-8a0b-2c4d6e8f0a1b",
    "processStatus": "TO_ANALYSIS",
    "processStatusDescription": "To analysis",
    "result": [
        {
            "type": "fiscal-document",
            "stdType": "fiscal-document",
            "extractions": [
                {
                    "source": "iocr",
                    "score": 0.9,
                    "status": "TO_ANALYSIS",
                    "tags": [
                        "id=zzz-nlp-invoice-1",
                        "language=en-US",
                        "goal=charge",
                        "subtype=invoice",
                        "std-type=fiscal-document",
                        "type=fiscal-document"
                    ],
                    "sections": [
                        {
                            "name": "section_header",
                            "stdName": "section_header",
                            "score": 0.98,
                            "status": "TO_ANALYSIS",
                            "fields": [
                                {
                                    "name": "invoice_number",
                                    "stdName": "invoice_number",
                                    "value": "INV20250901",
                                    "finalValue": "INV20250901",
                                    "score": 0.99,
                                    "status": "MOSTQIIOCR"
                                },
                                {
                                    "name": "issue_date",
                                    "stdName": "issue_date",
                                    "value": "2025-09-02",
                                    "finalValue": "2025-09-02",
                                    "score": 0.91,
                                    "status": "MOSTQIIOCR"
                                },
                                {
                                    "name": "currency",
                                    "stdName": "currency",
                                    "value": "USD",
                                    "finalValue": "USD",
                                    "score": 0.99,
                                    "status": "MOSTQIIOCR"
                                },
                                {
                                    "name": "po_number",
                                    "stdName": "po_number",
                                    "value": null,
                                    "finalValue": null,
                                    "score": null,
                                    "status": "TO_ANALYSIS"
                                },
                                {
                                    "name": "contract_number",
                                    "stdName": "contract_number",
                                    "value": null,
                                    "finalValue": null,
                                    "score": null,
                                    "status": "TO_ANALYSIS"
                                },
                                {
                                    "name": "lc_number",
                                    "stdName": "lc_number",
                                    "value": null,
                                    "finalValue": null,
                                    "score": null,
                                    "status": "TO_ANALYSIS"
                                },
                                {
                                    "name": "client_code",
                                    "stdName": "client_code",
                                    "value": null,
                                    "finalValue": null,
                                    "score": null,
                                    "status": "TO_ANALYSIS"
                                },
                                {
                                    "name": "delivery_address",
                                    "stdName": "delivery_address",
                                    "value": "BAIRRO EXEMPLO, CIDADE FICTÍCIA/SC.",
                                    "finalValue": "BAIRRO EXEMPLO, CIDADE FICTÍCIA/SC.",
                                    "score": 0.99,
                                    "status": "MOSTQIIOCR"
                                },
                                {
                                    "name": "incoterms",
                                    "stdName": "incoterms",
                                    "value": null,
                                    "finalValue": null,
                                    "score": null,
                                    "status": "TO_ANALYSIS"
                                },
                                {
                                    "name": "payment_terms",
                                    "st

Consultar status [application/json]

Status#

Status do processo#

Status dos atributos#

Requisição

Códigos de solicitação

Respostas

Status

Status do processo

Status dos atributos