Content Extraction Async [application/json]

Descrição do corpo da requisição

Nome	Tipo	Obrigatório	Descrição
webhook.url	String	Não	É a URL em que será feita a chamada quando o processo assíncrono finalizar.
webhook.fallbackUrl	String	Não	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`.
webhook.authorization.headers	String	Não	Parâmetro que permite especificar quais cabeçalhos o mostQI repassará ao servidor especificado na configuração de `webhook.url` ou `webhook.fallbackUrl`.
webhook.authorization.queryStrings	String	Não	Parâmetro que permite especificar quais queryStrings o mostQI repassará ao servidor especificado na configuração de `webhook.url` ou `webhook.fallbackUrl`.
webhook.authorization.mtls	String	Não	Parâmetro que permite habilitar a rotina interna de mtls para a requisição (autenticação por certificado). Sua configuração requer uma implementação customizada, a ser alinhada com o nosso suporte, e está associada à ClientKey.
fileBase64	String	Sim, quando o parâmetro fileUrl não é informado	Binário do arquivo a ser processado, codificado em string de texto conforme o padrão RFC3548 usando a codificação base64.
fileUrl	String	Sim, quando o parâmetro fileBase64 não é informado	URL pública do arquivo a ser processado.
filePassword	String	Sim, caso o arquivo enviado seja um PDF criptografado por senha	Senha codificada em uma string base64, pois PDFs permitem que as senhas sejam dados binários.
returnImage	Boolean	Não	Se verdadeiro, retorna o recorte dos binários das imagens tipificadas com a perspectiva corrigida.
returnedImageQuality	String	Não	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.
returnCrops	Boolean	Não	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.
tags	String	Não	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.

Request

Header Params

Authorization

string

required

Token de autorização obtido no método Authentication/Authenticate

Example:

Bearer {{bearer_token}}

Body Params application/json

webhook

object

required

url

string

required

fallbackUrl

string

required

authorization

object

required

fileBase64

string

required

fileUrl

string

required

filePassword

string

required

returnImage

boolean

required

returnedImageQuality

string

required

returnCrops

boolean

required

tags

string

required

Example

{
  "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

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200200 Ok Async Response

application/json

Body

webhook

object

required

url

string

required

fileBase64

string

required

returnImage

string

required

Content Extraction Async [application/json]

Descrição do corpo da requisição#

Request

Request samples

Responses

Descrição do corpo da requisição