Skip to main content
POST
Extração de Dados - FlexExtractor

Visão Geral

A API FlexOCR Extract permite extrair informações de documentos de forma automática utilizando OCR (Reconhecimento Ótico de Caracteres) com inteligência artificial. Envie a imagem do documento em Base64 e receba os dados estruturados em JSON.

OCR Inteligente

Reconhecimento automático com IA

Múltiplos Documentos

Suporte para RG, CNH, CPF e mais

Classificação Automática

Identifica o tipo do documento automaticamente

Dados Estruturados

Retorna campos com coordenadas e confiança

Fluxo de Extração

1

Autenticação

Obtenha um access_token válido via /api/v2/Security/GetToken
2

Preparar Imagem

Converta o documento para Base64 (PDF, JPG, PNG)
3

Enviar Requisição

POST com imagem Base64 e tipo de documento (opcional)
4

Receber Dados Extraídos

API retorna campos identificados com nome, valor e confiança

Authentication

string
required
Bearer token obtido via /api/v2/Security/GetTokenFormato: Bearer {access_token}Exemplo: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...

Request Body

Use o playground “Try It” à direita para testar a API diretamente! →
string
required
Imagem do documento codificada em Base64Formatos aceitos: PDF, JPG, JPEG, PNGTamanho máximo recomendado: 10MBExemplo:
Para melhor precisão, use imagens com:
  • Resolução mínima de 300 DPI
  • Boa iluminação
  • Documento completo e legível
  • Sem cortes ou reflexos
string
Tipo do documento a ser processado. Se não informado, o sistema identifica automaticamente.Valores aceitos:Exemplo: "RG"
Informar o tipo correto melhora a precisão e velocidade da extração
string
CPF relacionado ao documento (opcional). Usado para validação cruzada.Formato: Apenas números (11 dígitos)Exemplo: "12345678901"
O CPF informado pode ser usado para validar dados extraídos do documento

Response

object
required
Objeto contendo os resultados da extração OCR
boolean
required
Indica se a extração foi bem-sucedida
  • true: Dados extraídos com sucesso
  • false: Erro na extração (verifique campo error)
integer
required
Código HTTP de status da operaçãoValores comuns:
  • 200: Sucesso
  • 400: Requisição inválida
  • 401: Token inválido ou expirado
  • 500: Erro interno no servidor
string
required
Data e hora da extração (formato ISO 8601)Exemplo: "2025-01-09T11:01:39.6009905-03:00"
string
URI da requisição (quando disponível)
string
Mensagem de erro (presente apenas quando isSuccesful: false)Exemplos:
  • "Invalid image format"
  • "Image too large"
  • "Unable to recognize document type"

Campos Extraídos por Tipo de Documento

Campos Comuns Extraídos:

Os campos extraídos podem variar conforme o modelo do RG (antigo ou novo)

Campos Comuns Extraídos:

CNH digital possui campo digitalDocument: true

Campos Comuns Extraídos:

Campos Comuns Extraídos:

Use typealias: "CE_CEMIG" para contas da CEMIG

Exemplos de Código


Boas Práticas

Recomendações:
  • Resolução: Mínimo 300 DPI, ideal 600 DPI
  • Formato: PDF para documentos digitalizados, JPG/PNG para fotos
  • Iluminação: Uniforme, sem sombras ou reflexos
  • Foco: Imagem nítida, sem desfoque
  • Enquadramento: Documento completo, sem cortes
  • Tamanho: Máximo 10MB por imagem
Evite:
  • Imagens desfocadas ou tremidas
  • Flash direto (causa reflexos)
  • Documentos dobrados ou amassados
  • Baixa resolução (< 150 DPI)
  • Imagens muito comprimidas (qualidade baixa)
Otimização de Requisições:
  • Reutilize o access_token enquanto válido
  • Implemente cache de resultados quando aplicável
  • Processe em lote quando possível
  • Use compressão de imagem antes de Base64
Monitoramento:
  • Registre tempos de resposta (campo statistics)
  • Monitore taxa de sucesso (isSuccesful)
  • Acompanhe níveis de confiança médios
  • Configure alertas para falhas recorrentes
Exemplo de estatísticas:
Interpretando Confidence:Validação de Dados:
Erros Comuns:Implementação de Retry:
Proteção de Dados:
  1. Imagens:
    • Criptografe imagens em trânsito (HTTPS)
    • Não armazene Base64 em logs
    • Delete imagens após processamento
    • Implemente controle de acesso
  2. Dados Extraídos:
    • Dados pessoais são sensíveis (LGPD)
    • Criptografe armazenamento
    • Implemente auditoria de acesso
    • Defina política de retenção
  3. Tokens:
    • Use HTTPS obrigatoriamente
    • Nunca logue tokens completos
    • Renove periodicamente
    • Implemente timeout de sessão
Exemplo de sanitização: