Process Status

Status

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.
WAITING_OPERATION_FINISH	Representa que há uma operação (operation) em andamento e é necessário o envio de outro arquivo para que o processo continue ou seja finalizado.
CANCELED	Representa que o processo foi cancelado, em um fluxo de múltiplas requisições (operation), devido o processamento de algum outro arquivo em que não foi necessário gerar tarefa OU que houve a abertura de tarefa para outro processo da mesma operation.
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

Lista de status retornados pelo campo status dos atributos e seus significados, onde contexto pode se referir ao campo, célula da tabela, cabeçalho da tabela ou o documento.

Status	Descrição
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 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 foi modificado pelo revisor.
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. Confira a listagem atualizada de documentos e respectivos campos aqui.

Request

Header Params

Authorization

string

required

Token de autorização obtido no método user/authenticate.

Example:

Bearer {{bearer_token}}

Body Params application/json

processId

string

required

Código identificador do processo retornado ao enviar um arquivo na rota de extração, utilizado para consultar o status do processamento.

returnMostQiResponse

string

required

Indica o retorno do mostQI junto aos dados de status independentemente da finalização da tarefa manual.

Default:

false

Examples:

truefalse

Example

{
  "processId": "{{processID}}",
  "returnMostQiResponse": "false"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

mostQIRequestId

string

required

ID da requisição referente ao processo de extração do mostQI, que será registrado no histórico de consumo dos serviços.

operationId

string | null

optional

Identificador único da operação, fornecido pelo cliente na requisição do método process-image/content-extraction, devendo ser um GUID (globally unique identifier).

processId

string | null

optional

ID do processo assíncrono de extração iniciado a partir da requisição. Este ID é uma referência, e será utilizado nas requisições assíncronas feitas pelo servidor do mostValid ao endpoint especificado no cabeçalho webhook.

processStatus

string | null

optional

Status do processo, podendo assumir os valores: IN_PROCESS, WAITING_OPERATION_FINISH, CANCELED, TO_ANALYSIS, IN_ANALYSIS, TO_ANALYSIS, FINISHED ou ERROR. Veja detalhes no manual do mostValid.

result

array [object {11}]

required

fields

array [object {6}] | null

optional

Lista contendo todos os campos localizados no conteúdo. Há a possibilidade de não serem retornados campos (lista vazia), quando um documento é apenas tipificado. IMPORTANTE: a ordem dos elementos não é garantida, é obrigatório utilizar o campo name como referência para encontrar os valores.

image

string <base64> | null

optional

Arquivo binário da imagem tipificada e com correção de perspectiva. A imagem é codificada em string de texto de acordo com o padrão RFC3548 usando a codificação base64.

type

string

optional

Tipo de conteúdo identificado (documento-pessoal, certidao, etc).

stdType

string

optional

Tipo de conteúdo identificado padronizado em inglês (personal-document, certificate, etc).

pageNumber

integer

optional

Número da página na qual o conteúdo foi encontrado.

tags

array[string]

optional

Lista de tags relacionadas a imagem. As tags são um conjunto de identificadores que caracterizam a imagem e seus elementos.

score

number <float>

optional

Grau de confiabilidade de que o valor encontrado é o correto.

>= 0<= 1

tables

array [object {6}]

optional

Lista de tabelas encontradas no conteúdo.

crops

array [object {3}] | null

optional

processType

string

optional

Indica de qual processo o retorno apresentado se origina, podendo ser "extraction" (a partir da extração do mostQI) ou "human" (a partir de um processo humano para páginas não tipificadas)

status

string

optional

Status de análise do documento para o mostValid.

requestId

string

required

ID da requisição referente ao processo do mostValid.

elapsedMilliseconds

integer

required

status

object

required

Objeto contendo o código de status e a mensagem de resposta.

message

string | null

required

Mensagem de retorno de status. Veja os valores possíveis nas mensagens de erro do mostQI.

code

string

required

Código de status interno. Veja os valores possíveis nas mensagens de erro do mostQI.

errors

array [object {2}] | null

required

Lista de objetos do tipo Error, o formato é variável.

Example

{
  "mostQIRequestId": "aQT9nidO0Uu8dprwWHMsY",
  "operationId": "4c024a8c-c7e8-4bb4-9fa6-08304r278388",
  "processId": "818de69e-79c8-4re0-8d1b-f5b3c08459a9",
  "processStatus": "FINISHED",
  "result": [
    {
      "fields": [
        {
          "name": "orgao_emissor",
          "stdName": null,
          "value": "Órgão de Trânsito",
          "finalValue": null,
          "score": 0.99,
          "status": "MOSTQIIOCR"
        },
        {
          "name": "nome",
          "stdName": null,
          "value": "LORENA ROCHA",
          "finalValue": null,
          "score": 0.99,
          "status": "MOSTQIIOCR"
        },
        {
          "name": "data_primeira_habilitacao",
          "stdName": null,
          "value": "2021-06-02",
          "finalValue": null,
          "score": 1,
          "status": "MOSTQIIOCR"
        },
        {
          "name": "data_nascimento",
          "stdName": null,
          "value": "2001-03-08",
          "finalValue": null,
          "score": 1,
          "status": "MOSTQIIOCR"
        },
        {
          "name": "local_nascimento",
          "stdName": null,
          "value": "BELO HORIZONTE/MG",
          "finalValue": null,
          "score": 0.99,
          "status": "MOSTQIIOCR"
        },
        {
          "name": "data_emissao",
          "stdName": null,
          "value": "2022-06-07",
          "finalValue": null,
          "score": 1,
          "status": "MOSTQIIOCR"
        },
        {
          "name": "data_validade",
          "stdName": null,
          "value": "2024-12-14",
          "score": 1,
          "status": "MOSTQIIOCR"
        },
        {
          "name": "tipo_habilitacao",
          "stdName": null,
          "value": "D",
          "finalValue": null,
          "score": 0.99,
          "status": "MOSTQIIOCR"
        },
        {
          "name": "numero_espelho_frente",
          "stdName": null,
          "value": "603418220",
          "finalValue": null,
          "score": 1,
          "status": "MOSTQIIOCR"
        },
        {
          "name": "rg",
          "stdName": null,
          "value": "MG11915200",
          "finalValue": null,
          "score": 1,
          "status": "MOSTQIIOCR"
        },
        {
          "name": "doc",
          "stdName": null,
          "value": "MG11915200 SSP MG",
          "finalValue": null,
          "score": 0.99,
          "status": "MOSTQIIOCR"
        },
        {
          "name": "cpf",
          "stdName": null,
          "value": "51643176480",
          "finalValue": null,
          "score": 1,
          "status": "MOSTQIIOCR"
        },
        {
          "name": "registro",
          "stdName": null,
          "value": "67619610302",
          "finalValue": null,
          "score": 1,
          "status": "MOSTQIIOCR"
        },
        {
          "name": "cat_hab",
          "stdName": null,
          "value": "B",
          "finalValue": null,
          "score": 0.99,
          "status": "MOSTQIIOCR"
        },
        {
          "name": "nacionalidade",
          "stdName": null,
          "value": "BRASILEIRO",
          "finalValue": null,
          "score": 0.99,
          "status": "MOSTQIIOCR"
        },
        {
          "name": "filiacao_2",
          "stdName": null,
          "value": "FELIPE SILVA ROCHA",
          "finalValue": null,
          "score": 0.99,
          "status": "MOSTQIIOCR"
        },
        {
          "name": "filiacao_1",
          "stdName": null,
          "value": "LENA ROCHA",
          "finalValue": null,
          "score": 0.77,
          "status": "MOSTQIIOCR"
        },
        {
          "name": "numero_espelho_verso",
          "stdName": null,
          "value": "1103412290",
          "finalValue": null,
          "score": 1,
          "status": "MOSTQIIOCR"
        },
        {
          "name": "observacoes",
          "stdName": null,
          "value": null,
          "finalValue": "CNH",
          "score": 0,
          "status": "MODIFIED"
        },
        {
          "name": "codigo_seguranca",
          "stdName": null,
          "value": null,
          "finalValue": null,
          "score": 0,
          "status": "UNREADABLE"
        },
        {
          "name": "local_uf",
          "stdName": null,
          "value": null,
          "finalValue": "MG",
          "score": 0,
          "status": "REVIEWED"
        },
        {
          "name": "local_cidade",
          "stdName": null,
          "value": null,
          "finalValue": "Belo Horizonte",
          "score": 0,
          "status": "REVIEWED"
        },
        {
          "name": "renach",
          "stdName": null,
          "value": null,
          "finalValue": null,
          "score": 0,
          "status": "UNREADABLE"
        },
        {
          "name": "estado_emissor",
          "stdName": null,
          "value": null,
          "finalValue": "MG",
          "score": 0,
          "status": "REVIEWED"
        }
      ],
      "image": null,
      "type": "documento-pessoal",
      "stdType": "personal-document",
      "pageNumber": 1,
      "tags": [
        "id=bra-cnh-3",
        "country=bra",
        "person=natural",
        "subtype=cnh",
        "subtype=driving-license",
        "has=photo",
        "has=signature",
        "language=pt-BR",
        "process-type=extraction",
        "region=front",
        "region=top",
        "std-type=personal-document",
        "type=documento-pessoal"
      ],
      "score": 0.99,
      "tables": [],
      "processType": "taskspreader",
      "status": "MODIFIED"
    }
  ],
  "requestId": "tIPt5hzOok2RzakK87eli",
  "elapsedMilliseconds": 39,
  "status": {
    "message": "Ok",
    "code": "S100",
    "errors": null
  }
}

🟠400R300 Client isn't registered yet or has a invalid token

🟠401R321 Invalid Process Id

🔴500E100 The request could not be processed

Status#

Status do processo#

Status dos atributos#

Request

Request samples

Responses

Status

Status do processo

Status dos atributos