A rota Content Extraction é uma solução de Processamento Inteligente de Documentos (IDP — Intelligent Document Processing) que extrai informações de documentos estruturados e semiestruturados a partir de imagens e arquivos PDF.Ela pode ser consumida de duas formas: assíncrona, recomendada para a maioria das integrações, e síncrona. As funcionalidades e o formato do resultado são os mesmos nos dois modos.Funcionalidades#
🔹 Análise da qualidade#
Avalia a nitidez do arquivo enviado e a confiabilidade da leitura. O retorno inclui um score de 0 a 1 para o documento e para cada campo: quanto maior o valor, mais confiável a leitura. Veja como usar o score em Score de confiança.🔹 Tipificação do documento#
Identifica e classifica cada documento presente no arquivo enviado, por meio de três atributos do JSON de retorno:type: categoria do documento no idioma original (ex.: documento-pessoal, certidao, fatura).
stdType: natureza do documento em um padrão internacional, sempre em inglês e em letras minúsculas.
tags: lista de strings no formato [categoria]=[valor] que identificam características e subtipos do documento.
Entrega as informações extraídas de forma indexada, organizadas em campos (fields) e tabelas (tables), prontas para integração com sistemas de cadastro.🔹 Correção de perspectiva (deskew)#
Corrige o alinhamento e a perspectiva das imagens dos documentos identificados no arquivo.Ativação: envie o parâmetro returnImage = true.
Retorno: a imagem tratada vem no campo image do JSON de resposta, codificada em Base64. O armazenamento dessa imagem é de responsabilidade do cliente.
Imagem original enviada na requisição.
Imagem da frente do documento com perspectiva corrigida.
Imagem do verso do documento com perspectiva corrigida.
🔹 Recorte de elementos (crops)#
Recorta elementos específicos dos documentos, como foto, assinatura, código de barras e impressão digital, já com a perspectiva corrigida. Ative com o parâmetro returnCrops = true.Recorte da imagem da digital (tag has=fingerprint).
Recorte da foto (tag has=photo).
Recorte da assinatura (tag has=signature).
Retorna os metadados do documento, incluindo a leitura de QR Codes. Ative com o parâmetro returnMetadata = true.Modos de consumo#
| Assíncrono (recomendado) | Síncrono |
|---|
| Como funciona | Você envia o documento e recebe na hora um processId e resultKey . O resultado é enviado ao seu servidor por webhook e também fica disponível na rota de status. | A resposta com o resultado chega na mesma requisição. |
| Indicado para | Integrações em produção, grandes volumes e arquivos extensos | Testes rápidos e arquivos pequenos, com até 5 páginas |
| Conexão | Não fica presa enquanto o documento é processado | Fica aberta até o processamento terminar |
| Arquivos com mais de 5 páginas | ✅ Suportado | ❌ Use o assíncrono para evitar timeout |
| Resultado disponível depois | Por até 1 dia, na rota de status | Não fica armazenado |
Prefira o modo assíncrono. Ele não depende de manter a conexão aberta, aguenta picos de volume e permite recuperar o resultado pela rota de status se o seu servidor estiver fora do ar no momento do envio.
Como funciona o modo assíncrono#
1.
Envie o documento com o objeto webhook, informando a URL do seu servidor (servidor de callback).
2.
Guarde o processId e a resultKey retornados na hora.
3.
Ao fim do processamento, o mostQI faz um POST para a sua URL com o mesmo resultado da rota síncrona, acrescido do processId.
4.
Verifique o status.code do corpo recebido: "200" indica sucesso; outro código indica falha, com result igual a null e o motivo em status.message.
5.
Se precisar, consulte a rota de status com o processId por até 1 dia.
Detalhes de configuração, segurança e acompanhamento da entrega estão em Webhook.Endpoints#
Limites#
Arquivos de até 50 MB para PDF e 20 MB para imagens.
PDFs com até 50 páginas. Para arquivos com mais de 5 páginas, use o modo assíncrono.
Documentos suportados#
Acesse aqui o catálogo interativo dos documentos reconhecidos pelo Content Extraction. Material de apoio#