Content Compare [application/json]

POST

https://mostqiapi.com/process-image/content-compare

comparação de conteúdocomparação de textopesquisa de texto em documento

Last modified:2025-01-24 12:18:51

Rota destinada a buscar e comparar os termos enviados com o conteúdo extraído do documento fornecido.

Request

Header Params

Authorization

string

required

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

Example:

Bearer {{bearer_token}}

Body Params application/json

fileBase64

string <base64>

optional

🔸Requerido quando o parâmetro fileUrl não é informado. Binário do arquivo a ser processado, codificado em string de texto conforme o padrão RFC 4648, usando a codificação base64.

Match pattern:

RFC3548

fileUrl

string

optional

🔸Requerido quando o parâmetro fileBase64 não é informado. Url pública do arquivo a ser processado.

filePassword

string <base64>

optional

🔸Requerido caso o arquivo enviado seja um PDF criptografado por senha.
A senha deve ser codificada em uma string base64 (RFC 4648), pois PDFs permitem que as senhas sejam dados binários.

returnMetadata

boolean

optional

Se verdadeiro, retorna um objeto chamado metadata, que inclui a leitura dos QRCodes presentes no documento, organizados dentro do objeto barcodes.
A extração de QRCodes será realizada para:

Documentos conhecidos e tipificados pelo mostQI, que possuem suporte a Smart Docs;

Documentos não conhecidos ou não tipificados, garantindo uma cobertura ampla e flexível.

Para garantir a extração precisa do conteúdo dos QRCodes, é fundamental que eles estejam completos e legíveis no documento processado.

Default:

false

fields

array [object {3}]

field

required

Lista de Field serializada em JSON. Esses valores serão utilizados na comparação com o conteúdo.

name

string | null

required

Nome do campo que será comparado com o conteúdo.

value

string | null

required

Valor utilizado na comparação.

type

string

optional

Campo opcional que será utilizado para otimizar os resultados das comparações. Caso este parâmetro não seja informado, o tipo do campo será considerado como "text" por padrão.

Os tipos disponíveis são:

text: Texto normalizado, incluindo símbolos (configuração padrão).

normalized-text: Texto normalizado, sem símbolos (deve ser especificado explicitamente na requisição).

full-date: Datas completas no formato "m-d-y" ou "d-m-y".

date: Datas parciais nos formatos "m-d" ou "m-y".

numerical: Campos contendo apenas números e símbolos.

blood-type: Tipos sanguíneos, como A+, A-, B+, B-, AB+, AB-, O+, O-.

license-plate: Placas de veículos brasileiras, no formato antigo ou novo.

Example

{
  "fileBase64": "",
  "fileUrl": "https://...",
  "filePassword": "",
  "fields": [
    {
      "name": "nome",
      "value": "JUNIOR CARDOSO VILARINO"
    },
    {
      "name": "data_expedicao",
      "value": "09-20-2017",
      "type": "full-date"
    },
    {
      "name": "documento_origem",
      "value": "Cert Nasc LV 237 - FL 128 - Termo"
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://mostqiapi.com/process-image/content-compare' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fileBase64": "",
    "fileUrl": "https://...",
    "filePassword": "",
    "fields": [
        {
            "name": "nome",
            "value": "JUNIOR CARDOSO VILARINO"
        },
        {
            "name": "data_expedicao",
            "value": "09-20-2017",
            "type": "full-date"
        },
        {
            "name": "documento_origem",
            "value": "Cert Nasc LV 237 - FL 128 - Termo"
        }
    ]
}'

Responses

🟢200OK

application/json

Body

result

array [object {1}]

required

Lista contendo o resultado do método (consulte na documentação específica de cada um).

fields

array [object {4}]

field

required

Objeto que contém a lista contendo cada um dos campos enviados na requisição.

requestId

string

required

Código único de identificação da solicitação ao servidor, que será registrado no histórico de consumo dos serviços.

elapsedMilliseconds

integer

required

Tempo de duração do processamento em milissegundos.

status

object

required

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

code

string

required

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

message

string | null

required

Mensagem de retorno de status. 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

{
  "result": [
    {
      "fields": [
        {
          "name": "cpf",
          "value": "83644116083",
          "score": 1
        },
        {
          "name": "nome",
          "value": "CRISTINA DE OLIVEIRA",
          "score": 0.5
        }
      ]
    }
  ],
  "requestId": "6ERWpivDfUmhEoqnXeDHi",
  "elapsedMilliseconds": 1089,
  "status": {
    "message": "Ok",
    "code": "200",
    "errors": null
  }
}

🟠400R101 A specified parameter is wrong

🔴500E100 The request could not be processed

Modified at 2025-01-24 12:18:51

Content Compare [multipart/form-data]

Content Extraction