Content Extraction Async [application/json]
POST
/process-image/content-extractionRota assíncrona para extração do conteúdo textual de arquivos.
:::info
O resultado enviado ao servidor de callback segue o mesmo padrão do resultado é o mesmo da rota Content Extraction [multipart/form-data], com a adição do processId.
:::
Request
Token de autorização obtido no método user/authenticate.
É a URL em que será feita a chamada quando o processo assíncrono finalizar.
Parâmetro que permite especificar outra URL caso haja falha de comunicação na chamada da URL especificada no parâmetro webhookUrl ou webhook.fallbackUrl.
🔸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.
🔸Requerido quando o parâmetro file não é informado.
Url pública do arquivo a ser processado.
🔸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.
Se verdadeiro, retorna o recorte dos binários das imagens tipificadas com a perspectiva corrigida
Não obrigatorio. 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.
Se verdadeiro, retorna os recortes dos binários das imagens contidas dentro de um documento tipificado com a perspectiva corrigida, como recortes de foto, assinatura, código de barras e impressão digital. Consulte a lista de documentos lidos para visualizar todos os crops disponíveis.
Parâmetro opcional que auxilia na identificação do documento, reduzindo o tempo de processamento e aprimorando a precisão da detecção, funcionando como um filtro. 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.
{
"webhook": {
"url": "",
"fallbackUrl": "",
"authorization": {
"headers": [
{
"name": "nomeCabecalho1",
"value": "valorCabecalho1"
},
{
"name": "nomeCabecalho2",
"value": "valorCabecalho2"
}
],
"queryStrings": [
{
"name": "nomeQs1",
"value": "valorQs1"
},
{
"name": "nomeQs2",
"value": "valorQs2"
}
],
"mtls": false
}
},
"fileBase64": "",
"fileUrl": "",
"filePassword": "",
"returnImage": false,
"returnedImageQuality": "",
"returnCrops": false,
"tags": [
""
]
}
Request samples
Responses
Lista contendo o resultado do método (consulte na documentação específica de cada um).
ID referente ao processo assíncrono de extração iniciado a partir desta requisição. Este ID é uma referência, e será enviado nas requisições assíncronas que serão feitas pelo servidor do mostQI ao endpoint especificado no corpo da requisição através dos parâmetros webhookUrl ou webhookFallbackUrl.
Código único de identificação da solicitação ao servidor, que será registrado no histórico de consumo dos serviços.
Tempo de duração do processamento em milissegundos.
Objeto contendo o código de status e a mensagem de resposta.
Código de status interno. Veja os valores possíveis nas mensagens de erro do mostQI.
Mensagem de retorno de status. Veja os valores possíveis nas mensagens de erro do mostQI.
Lista de objetos do tipo Error, o formato é variável.
{
"result": {
"processId": "67a7ae91-4d7f-48e2-ad03-94ff19e1b32d"
},
"requestId": "kyamMSMguEe19elsr6SFB",
"elapsedMilliseconds": 17,
"status": {
"message": "Ok",
"code": "201",
"errors": null
}
}