Content Classification [application/json]

Rota síncrona para classificação de documentos.

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

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.

fileUrl

string

optional

🔸Requerido quando o parâmetro fileBase64 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.

returnImage

boolean

optional

Se verdadeiro, retorna o recorte dos binários das imagens tipificadas com a perspectiva corrigida.

Default:

false

returnedImageQuality

string

optional

Não obrigatório. Permite definir a qualidade da imagem de deskew retornada na rota de extração. O atributo é opcional, e seu valor padrão (quando não informando) é 75.

>= 0 characters<= 100 characters

Default:

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

tags

array[string]

optional

Parâmetro opcional que atua como um filtro para os resultados esperados, ajudando a reduzir o tempo de processamento. Por exemplo, ao passar as tags country=bra e type=documento-pessoal, a resposta incluirá apenas a classificação de documentos que correspondam a essas duas tags, mesmo que o arquivo enviado contenha documentos de outras nacionalidades ou tipos. Os valores inseridos no vetor de tags devem ser strings que seguem o padrão Regex. Consulte a lista de documentos lidos para visualizar todas as tags disponíveis.

Example

{
  "fileBase64": "",
  "fileUrl": "",
  "filePassword": "",
  "returnImage": false,
  "returnedImageQuality": "",
  "tags": [
    ""
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

result

array [object {3}]

required

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

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.

classifications

array [object {5}]

required

Lista contendo atributos relacionados à classificação do documento presente no arquivo enviado.

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 e mensagem de status da resposta.

message

string | null

required

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

code

string

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": [
    {
      "type": "extrato",
      "stdType": "extract",
      "classifications": [
        {
          "source": "iocr",
          "score": 1,
          "tags": [
            "country=bra",
            "id=bra-fgts-2",
            "language=pt-BR",
            "of=fund",
            "process-type=classification",
            "std-type=extract",
            "subtype=fgts",
            "type=extrato"
          ],
          "pages": [
            {
              "number": 1
            }
          ],
          "image": null
        }
      ]
    },
    {
      "type": "documento-pessoal",
      "stdType": "personal-document",
      "classifications": [
        {
          "source": "iocr",
          "score": 0.93,
          "tags": [
            "country=bra",
            "id=bra-rg-marinha-2",
            "language=pt-BR",
            "of=armed-forces",
            "of=military",
            "of=navy",
            "person=natural",
            "process-type=classification",
            "region=back",
            "region=verso",
            "std-type=personal-document",
            "subtype=carteira-funcional",
            "subtype=functional-card",
            "subtype=identity",
            "subtype=rg",
            "type=documento-pessoal"
          ],
          "pages": [
            {
              "number": 2
            }
          ],
          "image": null
        }
      ]
    },
    {
      "type": "documento-pessoal",
      "stdType": "personal-document",
      "classifications": [
        {
          "source": "iocr",
          "score": 1,
          "tags": [
            "country=bra",
            "has=fingerprint",
            "has=photo",
            "has=signature",
            "id=bra-rg-marinha-2",
            "language=pt-BR",
            "of=armed-forces",
            "of=military",
            "of=navy",
            "person=natural",
            "process-type=classification",
            "region=frente",
            "region=front",
            "std-type=personal-document",
            "subtype=carteira-funcional",
            "subtype=functional-card",
            "subtype=identity",
            "subtype=rg",
            "type=documento-pessoal"
          ],
          "pages": [
            {
              "number": 2
            }
          ],
          "image": null
        }
      ]
    }
  ],
  "requestId": "lXP7v8LZL925kRIA3WYOw",
  "elapsedMilliseconds": 3186,
  "status": {
    "message": "Ok",
    "code": "200",
    "errors": null
  }
}

🟠400R101 A specified parameter is wrong

🟠400R130 Unsupported file format

🟠401R117 Invalid authorization data

🔴500E100 The request could not be processed