Content Compare [multipart/form-data]

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

Last modified: 2 months ago

Rota para buscar e comparar termos enviados com o conteúdo extraído de documento fornecido.

Request

Header Params

Authorization

string

required

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

Example:

Bearer XXXXXXXXXXXXX

Body Params multipart/form-data

file

optional

🔸Requerido quando o parâmetro fileUrl não é informado.
Binário do arquivo a ser processado.

fileUrl

string

optional

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

filePassword

string

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.

json

string

required

Contém uma lista de Field serializada em JSON. Esses valores serão utilizados na comparação com o conteúdo.

Example:

{ "fields":[ { "name": "", "value": "" }, { "name": "", "value": "" } ] }

Request samples

Responses

OK(200)

HTTP Code: 200

Content Type : JSONapplication/json

result

array [object {9}]

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.

image

string <base64> | null

optional

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

Match pattern:

RFC3548

score

number <float> | null

optional

Parâmetro que atribui uma nota de avaliação global ao documento, considerando a qualidade da correção de imagem e leitura dos campos. Seu valor varia entre 0 e 1.

>= 0<= 1

type

string | null

optional

Atributo que retorna o tipo de conteúdo identificado. Ex: documento pessoal, certidão, etc.

stdType

string | null

optional

Atributo que retorna o tipo de conteúdo identificado padronizado. Ex: personal document, certificate, etc.

pageNumber

integer | null

optional

Atributo que retorna o número da página na qual o conteúdo foi encontrado.

tags

array[string] | null

optional

Atributo que retorna uma lista de tags encontradas na imagem. As tags são um conjunto de identificadores que caracterizam a classe ou tipo daquela imagem.

tables

array[string] | null

table

optional

Atributo que retorna uma lista de tabelas encontradas no conteúdo.

processType

string | null

optional

O atributo indica a origem do processo a partir do qual o retorno é apresentado. Por exemplo, extraction para o processo de extração de dados do mostQI.

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.

{
  "result": [
    {
      "fields": [
        {
          "name": "cpf",
          "stdName": null,
          "value": "83644116083",
          "score": 1
        },
        {
          "name": "nome",
          "stdName": null,
          "value": "CRISTINA DE OLIVEIRA",
          "score": 0.5
        }
      ],
      "image": null,
      "score": null,
      "type": null,
      "stdType": null,
      "pageNumber": 0,
      "tags": null,
      "tables": null,
      "processType": null
    }
  ],
  "requestId": "6ERWpivDfUmhEoqnXeDHi",
  "elapsedMilliseconds": 1089,
  "status": {
    "message": "Ok",
    "code": "200",
    "errors": null
  }
}

Last modified: 2 months ago