Resposta padronizada

Todos os métodos da API possuem um corpo de resposta padronizado:

{
  "result": {},
  "requestId": "",
  "elapsedMilliseconds": 0,
  "status": {
     "message": "Ok",
     "code": "200",
     "errors": null
    }
}

:::warning
A ordem dos elementos dentro do result não é garantida. É obrigatório utilizar o campo name como referência para encontrar os valores.
:::

Response

Status

Contabilização do consumo

As requisições bem-sucedidas serão contabilizadas para fins de faturamento, com diferenciações na forma de contabilização conforme o serviço consumido. Todos os itens faturáveis estão listados no Relatório de Consumo (Consumption Report), devidamente identificados pelo requestId, data e hora da requisição, bem como outros detalhes sobre o resultado do consumo.

Para os serviços que utilizam o recurso de imagem, conforme listados abaixo, haverá a contabilização pela quantidade de documentos processados:

• Content Classification
• Content Extraction
• Content Extraction Async
• Image Properties
• License Plate Recognition
• Multi Page Content Extraction

Documentos tipificados/classificados que retornam resultados de processamento são contabilizados. Além disso, mesmo páginas sem identificação de documentos (páginas em branco) são processadas e contabilizadas. Essas páginas aparecem no Relatório de Consumo com a indicação "utp" (untyped page) na coluna Details.

Sucesso de extração e faturamento na rota Content Extraction

O status 200 ("message": "Ok", "code": "200") indica sucesso na comunicação com a API e no processamento do arquivo, mas não garante que uma imagem foi identificada no arquivo processado. Caso nenhuma imagem seja reconhecida, o campo "result" retornará vazio, como mostrado no exemplo abaixo:

{
    "result": [],
    "requestId": "tK6fnYJrxk21T7Mt3OEEb",
    "elapsedMilliseconds": 1322,
    "status": {
        "message": "Ok",
        "code": "200",
        "errors": null
    }
}

O cálculo de consumo e, consequentemente, de cobrança seguem os seguintes critérios para a determinação do volume de imagens processadas:

• Imagem de um único documento: Uma requisição REST contendo uma imagem, seja ela tipificada ou não, resulta na contagem de uma imagem processada.

• Imagens de múltiplos documentos: Se a requisição REST contiver várias imagens, cada imagem será contabilizada, independentemente de ter sido tipificada ou não. Páginas sem identificação de imagens também são incluídas, pois foram processadas.

:::highlight yellow
⚠️ PONTO DE ATENÇÃO

Para documentos com frente e verso distintos, como RGs e CNHs (não abertas), duas imagens são contabilizadas: uma para a frente e outra para o verso.

• No caso do RG, a extração frente e verso sempre contabiliza duas imagens, mesmo que as imagens sejam capturadas separadamente ou em uma única captura (documento aberto).
• Para a CNH, a contabilização depende da forma de envio:

• CNH aberta: Apenas uma imagem é contabilizada.
• CNH fechada: Duas imagens são processadas, uma para a frente e outra para o verso, gerando a contagem de duas imagens.
  :::

Armazenamento de dados e LGPD

O mostQI não armazena as imagens enviadas pelos clientes e todo o processamento ocorre em memória volátil, nos deixando em conformidade com a LGPD.