MOST Docs
mostQI APImostValid API
DEMO
  • Generative Content Extraction
  • Content Extraction
  • Multipage Content Extraction
  • Vio Extraction
  • Liveness
  • Facematch
  • Invoice Extraction
  • Address Parsing
  • License Plate
mostQI APImostValid API
DEMO
  • Generative Content Extraction
  • Content Extraction
  • Multipage Content Extraction
  • Vio Extraction
  • Liveness
  • Facematch
  • Invoice Extraction
  • Address Parsing
  • License Plate
Help Desk
MOST Linkedin
MOSTQI Instagram
MOST Youtube
pt-BRen-US
pt-BRen-US
  1. mostValid
  • Introduction
  • Consuming the API
  • API Characteristics
  • Error messages
  • Support Material
  • mostValid
    • Authenticate (Get JWT)
      POST
    • Content Extraction
      POST
    • Process Status
      POST
  1. mostValid

Process Status

POST
https://mostvalid.com.br/process-image/content-extraction/status
statussituacao
Última modificação:2024-07-26 18:00:04

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.
StatusDescription
MOSTQIIOCRThe 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.
MODIFIEDThe 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.
UNREADABLEThe 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.
REVIEWEDThe 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.
DEPRECATEDIt 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.

Requisição

Parâmetros Header
Authorization
string 
requerido
Authorization token obtained from the user/authenticate method.
Exemplo:
Bearer {{bearer_token}}
Parâmetros Bodyapplication/json
processId
string 
requerido
Process identifier code returned when sending a file to the extraction route, used to check the processing status
returnMostQiResponse
string 
requerido
Indicates the return of the mostQI along with the status data regardless of the completion of the manual task.
Exemplo
{
    "processId":"{{processID}}",
    "returnMostQiResponse":"false"
}

Exemplos de Requisição

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://mostvalid.com.br/process-image/content-extraction/status' \
--header 'Authorization: Bearer {{bearer_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "processId":"{{processID}}",
    "returnMostQiResponse":"false"
}'

Respostas

🟢200OK
application/json
Body
mostQIRequestId
string 
requerido
Request ID related to the mostQI extraction process.
operationId
string  | null 
opcional
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 
opcional
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 
opcional
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}] 
requerido
fields
array [object {6}]  | null 
opcional
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>
opcional
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 
opcional
Type of identified content (personal-document, certificate, etc).
stdType
string 
opcional
Standardized type of identified content in english (personal-document, certificate, etc).
pageNumber
integer 
opcional
Page number where the content was found.
tags
array[string]
opcional
List of tags related to the image. Tags are a set of identifiers that characterize the image and its elements.
score
number <float>
opcional
Degree of confidence that the value found is correct.
>= 0<= 1
tables
array [object {6}] 
opcional
List of tables found in the content.
crops
array [object {3}]  | null 
opcional
processType
string 
opcional
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 
opcional
Document analysis status for mostValid.
requestId
string 
requerido
Request ID related to the mostValid process.
elapsedMilliseconds
integer 
requerido
status
object 
requerido
Object containing the status code and the response message.
message
string  | null 
opcional
Status return message. See the possible values in mostQI error messages.
code
string 
requerido
Internal status code. See possible values in mostQI error messages.
errors
array [object {2}] 
requerido
List of objects of type Error, the format is variable.
Exemplo
{
    "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
Modificado em 2024-07-26 18:00:04
Página anterior
Content Extraction
Built with