Process Status

Status

List of statuses returned in the status field and their description. It can refer to the field, table cell, table header, or the document.

Status	Description
MOSTQIIOCR	The item was not sent for review because its score did not match any of the client's defined rules, thus the data extraction performed is considered valid.
MODIFIED	The item was sent for review as it was determined that it required validation according to the rules defined by the client, and its original value was modified by the reviewer.
UNREADABLE	The item was sent for review because it was determined that it required validation according to the rules defined by the client, and its value was marked as illegible by the reviewer.
REVIEWED	The item was sent for review as it was determined that it required validation according to the rules defined by the client, and its value was not modified by the reviewer.
DEPRECATED	It is an item with a deprecated field name and will not be displayed in the mostValid Portal for analysis during the review task. It is recommended to consider the updated corresponding field names. Check the updated list of documents and their respective fields here.

Request

Header Params

Authorization

string

required

Authorization token obtained from the user/authenticate method.

Example:

Bearer {{bearer_token}}

Body Params application/json

processId

string

required

Process identifier code returned when sending a file to the extraction route, used to check the processing status

returnMostQiResponse

string

required

Indicates the return of the mostQI along with the status data regardless of the completion of the manual task.

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

Request ID related to the mostQI extraction process.

operationId

string | null

optional

Unique identifier for the operation provided by the client in the request for the method process-image/content-extraction, expected to be a GUID (Globally Unique Identifier).

processId

string | null

optional

ID related to the asynchronous extraction process initiated from this request. This ID is a reference and will be sent in the asynchronous requests that will be made by the mostValid server to the endpoint specified in the webhook header.

processStatus

string | null

optional

Status of the process, which can be IN_PROCESS, WAITING_OPERATION_FINISH, CANCELED, TO_ANALYSIS, IN_ANALYSIS, TO_ANALYSIS, FINISHED, or ERROR. Please refer to the mostValid Manual for more details.

result

array [object {11}]

required

fields

array [object {6}] | null

optional

List containing each of the fields located in the content. There is a possibility that no fields are returned (an empty list) in the case where a document is merely categorized. IMPORTANT: The order of the elements is not guaranteed; it is necessary to use the "name" field as a reference to find the values.

image

string <base64>

optional

Binary file of the categorized image with corrected perspective. The image is encoded as a text string following the RFC3548 standard using base64 encoding.

type

string

optional

Type of identified content (personal-document, certificate, etc).

stdType

string

optional

Standardized type of identified content in english (personal-document, certificate, etc).

pageNumber

integer

optional

Page number where the content was found.

tags

array[string]

optional

List of tags related to the image. Tags are a set of identifiers that characterize the image and its elements.

score

number <float>

optional

Degree of confidence that the value found is correct.

>= 0<= 1

tables

array [object {6}]

optional

List of tables found in the content.

crops

array [object {3}] | null

optional

processType

string

optional

Indicates which process the displayed return originated from, which can be "extraction" (from mostQI inheritance) or "human" (from a human process for non-typed pages).

status

string

optional

Document analysis status for mostValid.

requestId

string

required

Request ID related to the mostValid process.

elapsedMilliseconds

integer

required

status

object

required

Object containing the status code and the response message.

message

string | null

optional

Status return message. See the possible values in mostQI error messages.

code

string

required

Internal status code. See possible values in mostQI error messages.

errors

array [object {2}]

required

List of objects of type Error, the format is variable.

Example

{
  "mostQIRequestId": "Fe9tFAPTssKztvMolpMJm",
  "processStatus": "FINISHED",
  "result": [
    {
      "fields": [
        {
          "name": "num_registro",
          "stdName": null,
          "value": "XXXXXXXXXXX",
          "finalvalue": "XXXXXXXXXXXXX",
          "score": 1,
          "status": "MODIFIED"
        },
        {
          "name": "data_emissao",
          "stdName": null,
          "value": "XXXX-XX-XX",
          "finalvalue": "XX/XX/XXXX",
          "score": 1,
          "status": "MODIFIED"
        },
        {
          "name": "data_validade",
          "stdName": null,
          "value": "XXXX-XX-XX",
          "finalvalue": "XX/XX/XXXX",
          "score": 1,
          "status": "MODIFIED"
        },
        {
          "name": "nome",
          "stdName": null,
          "value": "XXXXX XXXXXXX XXXXXXXX",
          "finalvalue": "XXXXX XXXXXXX XXXXXXX",
          "score": 0.99,
          "status": "UNREADABLE"
        },
        {
          "name": "filiacao_2",
          "stdName": null,
          "value": "XXXX XXXXXXXXXXXXX",
          "finalvalue": "XXXX XXXXXXXXXXXXX",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "filiacao_1",
          "stdName": null,
          "value": "XXXXXX XXXXXXXX XXXXXXXX",
          "finalvalue": "XXXXXX XXXXXXXX XXXXXXXX",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "naturalidade",
          "stdName": null,
          "value": "MG",
          "finalvalue": "MG",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "nacionalidade",
          "stdName": null,
          "value": "BR",
          "finalvalue": "BR",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "data_nascimento",
          "stdName": null,
          "value": "XXXX-XX-XX",
          "finalvalue": "XXXX-XX-XX",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "pis_pasep",
          "stdName": null,
          "value": "XXXXXXXXXXX",
          "finalvalue": "XXXXXXXXXXX",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "cpf",
          "stdName": null,
          "value": "XXXXXXXXXXX",
          "finalvalue": "XXXXXXXXXXX",
          "score": 1,
          "status": "REVIEWED"
        },
        {
          "name": "tipo_sanguineo",
          "stdName": null,
          "value": "O+",
          "finalvalue": "O+",
          "score": 0.95,
          "status": "REVIEWED"
        },
        {
          "name": "data_validade_amh",
          "stdName": null,
          "value": "Indeterminada",
          "finalvalue": "Indeterminada",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "categoria",
          "stdName": null,
          "value": "TERCEIRO SARGENTO",
          "finalvalue": "TERCEIRO SARGENTO",
          "score": 0.99,
          "status": "REVIEWED"
        },
        {
          "name": "documento_origem",
          "stdName": null,
          "value": "XXXXX XXXXXX XXXX XXXXX SÃO LUIS - MA",
          "finalvalue": "XXXXX XXXXXX XXXX XXXXX SÃO LUIS - MA",
          "score": 0.99,
          "status": "REVIEWED"
        }
      ],
      "image": null,
      "type": "documento-pessoal",
      "stdType": "personal-document",
      "pageNumber": 1,
      "tags": [
        "id=bra-rg-marinha-2",
        "country=bra",
        "of=military",
        "person=natural",
        "subtype=identity",
        "subtype=rg",
        "language=pt-BR",
        "process-type=extraction",
        "region=verso",
        "std-type=personal-document",
        "type=documento-pessoal"
      ],
      "score": 1,
      "tables": [],
      "processType": "extraction",
      "status": "MODIFIED"
    }
  ],
  "requestId": "b8Zmn3M1AEOgSbssLO3as",
  "elapsedMilliseconds": 15,
  "status": {
    "message": "Ok",
    "code": "S100",
    "errors": null
  }
}

🟠400R321 Invalid Process Id

🔴500E100 The request could not be processed

Status#

Request

Request samples

Responses

Status