> ## Documentation Index
> Fetch the complete documentation index at: https://docs-platform.services-valid.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Apresentação

<img className="block dark:hidden" alt="FlexExtractor Hero Light" src="https://mintlify.s3.us-west-1.amazonaws.com/valid-platform-id/images/flexextractor-hero-light.png" />

<img className="hidden dark:block" alt="FlexExtractor Hero Light" src="https://mintlify.s3.us-west-1.amazonaws.com/valid-platform-id/images/flexextractor-hero-dark.png" />

## O que é o FlexExtractor?

O **FlexExtractor** é uma API de OCR (Reconhecimento Ótico de Caracteres) alimentada por **Inteligência Artificial** que permite extrair informações estruturadas de documentos brasileiros de forma rápida, precisa e automatizada.

Envie a imagem de um documento (RG, CNH, CPF, contas de luz, etc.) e receba instantaneamente todos os dados estruturados em JSON, prontos para integração em seu sistema.

<CardGroup cols={2}>
  <Card title="OCR com IA" color="#0285c7" icon="brain">
    Reconhecimento inteligente com precisão superior a 95%
  </Card>

  <Card title="Múltiplos Documentos" color="#16a34a" icon="id-card">
    Suporte para RG, CNH, CPF, contas de energia e mais
  </Card>

  <Card title="Classificação Automática" color="#dc2626" icon="robot">
    Identifica o tipo do documento automaticamente
  </Card>

  <Card title="Integração Simples" color="#9333ea" icon="code">
    API REST com resposta JSON em tempo real
  </Card>
</CardGroup>

***

## Como Funciona?

<Steps>
  <Step title="Autenticação">
    Obtenha um token de acesso informando suas credenciais (username e password)
  </Step>

  <Step title="Envio do Documento">
    Converta a imagem do documento para Base64 e envie via API
  </Step>

  <Step title="Processamento Inteligente">
    Nossa IA identifica o tipo de documento e extrai todos os campos relevantes
  </Step>

  <Step title="Receba os Dados">
    Retorno instantâneo em JSON com campos, valores, coordenadas e nível de confiança
  </Step>
</Steps>

<CodeGroup>
  ```json Exemplo de Entrada theme={"theme":"catppuccin-latte"}
  {
    "typealias": "RG",
    "imageBase64": "JVBERi0xLjMNCiXi48/TDQoyIDAgb2J..."
  }
  ```

  ```json Exemplo de Saída theme={"theme":"catppuccin-latte"}
  {
    "ocrResult": {
      "typeRecognized": "RG",
      "fields": [
        {
          "name": "NOME",
          "value": "JOÃO DA SILVA",
          "confidence": 98
        },
        {
          "name": "RG",
          "value": "12.345.678-9",
          "confidence": 95
        },
        {
          "name": "CPF",
          "value": "123.456.789-01",
          "confidence": 92
        }
      ]
    },
    "isSuccesful": true
  }
  ```
</CodeGroup>

***

## Casos de Uso

<AccordionGroup>
  <Accordion title="Onboarding Digital" icon="user-plus">
    **Problema:** Cadastro manual de clientes é lento e propenso a erros.

    **Solução com FlexExtractor:**

    * Cliente tira foto do RG ou CNH pelo celular
    * Sistema extrai automaticamente nome, CPF, data de nascimento, etc.
    * Dados preenchem formulário automaticamente
    * Reduz tempo de cadastro de 5 minutos para 30 segundos

    **Benefícios:**

    * Redução de 90% no tempo de cadastro
    * Eliminação de erros de digitação
    * Melhor experiência do usuário
    * Conformidade com regulamentações (LGPD)
  </Accordion>

  <Accordion title="Verificação de Identidade (KYC)" icon="shield-check">
    **Problema:** Validação manual de documentos é cara e demorada.

    **Solução com FlexExtractor:**

    * Extração automática de dados do documento
    * Validação cruzada com bases oficiais (Receita Federal, Detran)
    * Detecção de documentos digitais vs físicos
    * Análise de autenticidade

    **Benefícios:**

    * Conformidade com normas KYC/AML
    * Redução de fraudes
    * Aprovação instantânea de clientes legítimos
    * Economia com equipe de análise manual
  </Accordion>

  <Accordion title="Automação de Processos" icon="gears">
    **Problema:** Processos que exigem cópia de documentos são lentos.

    **Solução com FlexExtractor:**

    * Abertura de contas bancárias
    * Contratação de seguros
    * Matrícula em instituições de ensino
    * Cadastro de fornecedores (B2B)

    **Benefícios:**

    * Digitalização completa do processo
    * Redução de 80% no tempo de processamento
    * Eliminação de papel
    * Rastreabilidade completa
  </Accordion>
</AccordionGroup>

***

## Documentos Suportados

O FlexExtractor processa **mais de 30 tipos de documentos brasileiros**, organizados nas categorias abaixo:

<AccordionGroup>
  <Accordion title="Documentos de Identidade" defaultOpen icon="id-card">
    <CardGroup cols={3}>
      <Card title="RG" icon="id-card">
        Registro Geral - Extrai nome, número, CPF, filiação, data nascimento, órgão expedidor
      </Card>

      <Card title="CNH" icon="car">
        Carteira Nacional de Habilitação - Extrai nome, CPF, registro, categoria, validade
      </Card>

      <Card title="CIP" icon="fingerprint">
        Cédula de Identidade de Profissional - Extrai dados profissionais e pessoais
      </Card>

      <Card title="Passaporte" icon="passport">
        Passaporte Brasileiro - Extrai nome, número, nacionalidade, validade
      </Card>

      <Card title="CTPS" icon="briefcase">
        Carteira de Trabalho - Extrai nome, número, série, data emissão
      </Card>

      <Card title="Identidade Militar" icon="shield">
        Documento de Identificação Militar - Extrai dados do militar
      </Card>
    </CardGroup>
  </Accordion>

  <Accordion title="Documentos de Estrangeiros" icon="globe">
    <CardGroup cols={3}>
      <Card title="CRNM" icon="id-card-clip">
        Carteira de Registro Nacional Migratório - Documento oficial de estrangeiros
      </Card>

      <Card title="CNE" icon="passport">
        Carteira Nacional de Estrangeiros - Extrai dados de identificação
      </Card>

      <Card title="RNM Provisório" icon="file-lines">
        Documento Provisório Registro Nacional Migratório
      </Card>

      <Card title="Protocolo RNE" icon="file-signature">
        Protocolo de Solicitação de Carteira de Identidade Estrangeira
      </Card>

      <Card title="Protocolo Refúgio" icon="hand-holding-heart">
        Protocolo do Pedido de Refúgio
      </Card>
    </CardGroup>
  </Accordion>

  <Accordion title="Certidões e Documentos Civis" icon="certificate">
    <CardGroup cols={3}>
      <Card title="Certidão Nascimento" icon="baby">
        Certidão de Nascimento - Extrai dados completos do registro civil
      </Card>

      <Card title="Certidão Casamento" icon="rings-wedding">
        Certidão de Casamento - Extrai dados dos cônjuges e do casamento
      </Card>

      <Card title="Certidão Imóvel" icon="house">
        Certidão de Matrícula do Imóvel - Extrai dados do registro imobiliário
      </Card>

      <Card title="Ofício" icon="file-contract">
        Ofício - Extrai conteúdo e dados oficiais
      </Card>
    </CardGroup>
  </Accordion>

  <Accordion title="Comprovantes de Residência" icon="house-circle-check">
    <CardGroup cols={3}>
      <Card title="Conta de Energia" icon="bolt">
        Contas de Luz (CEMIG e outras) - Extrai nome, endereço, CPF/CNPJ, valor, vencimento
      </Card>

      <Card title="Conta de Água" icon="droplet">
        Contas de Água - Extrai dados do titular e endereço completo
      </Card>

      <Card title="Conta de Telefone" icon="phone">
        Contas Telefônicas - Extrai dados cadastrais e endereço
      </Card>
    </CardGroup>
  </Accordion>

  <Accordion title="Documentos Empresariais" icon="building">
    <CardGroup cols={3}>
      <Card title="CCMEI" icon="store">
        Certificado da Condição de Microempreendedor Individual
      </Card>

      <Card title="DASN-SIMEI" icon="file-invoice">
        Declaração Anual do Simples Nacional - MEI
      </Card>

      <Card title="PGDAS" icon="calculator">
        Extrato do Simples Nacional - Programa Gerador
      </Card>

      <Card title="Requerimento" icon="file-pen">
        Requerimento do Empresário e Atos de Alteração de Dados
      </Card>
    </CardGroup>
  </Accordion>

  <Accordion title="Documentos Imobiliários e Financeiros" icon="building-columns">
    <CardGroup cols={3}>
      <Card title="Contrato Imóvel" icon="file-signature">
        Contrato de Compra/Locação de Imóvel
      </Card>

      <Card title="Anexo Habitacional" icon="house-laptop">
        Anexo I - Contrato Habitacional (Financiamento)
      </Card>

      <Card title="Seguro Imóvel" icon="shield-halved">
        Apólice de Seguro Residencial
      </Card>

      <Card title="Holerite" icon="money-bill">
        Contracheque/Holerite - Extrai dados do trabalhador e valores
      </Card>

      <Card title="Extrato INSS" icon="file-invoice-dollar">
        Extrato de Benefício Previdenciário
      </Card>
    </CardGroup>
  </Accordion>
</AccordionGroup>

<Info>
  **Total: 30+ tipos de documentos** processados com alta precisão. A lista é atualizada constantemente com novos tipos de documentos.
</Info>

<Note>
  **Classificação Automática**: Não sabe o tipo do documento? Não tem problema! Nossa IA identifica automaticamente o tipo e extrai os campos correspondentes. Basta omitir o campo `typealias` na requisição.
</Note>

***

## Diferenciais Tecnológicos

<Tabs>
  <Tab title="IA Avançada">
    ### Modelos de Deep Learning

    Nossa tecnologia utiliza modelos de aprendizado profundo treinados com milhões de documentos brasileiros:

    * **Classificação de Documentos**: Identifica automaticamente RG, CNH, CPF, etc.
    * **OCR Adaptativo**: Reconhece diferentes layouts e formatos
    * **Detecção de Campos**: Localiza campos mesmo em documentos de baixa qualidade
    * **Validação Cruzada**: Compara dados extraídos com padrões conhecidos

    **Precisão Média:**

    * Documentos de alta qualidade: **98-99%**
    * Documentos de média qualidade: **92-95%**
    * Documentos de baixa qualidade: **85-90%**
  </Tab>

  <Tab title="Performance">
    ### Velocidade e Escala

    Arquitetura otimizada para alto volume e baixa latência:

    | Métrica                     | Valor                           |
    | --------------------------- | ------------------------------- |
    | **Tempo médio de resposta** | 2-5 segundos                    |
    | **Throughput**              | 1000+ docs/minuto               |
    | **Disponibilidade (SLA)**   | 99.9%                           |
    | **Concorrência**            | Até 100 requisições simultâneas |

    **Infraestrutura:**

    * Servidores dedicados com GPUs
    * CDN global para baixa latência
    * Balanceamento automático de carga
    * Monitoramento 24/7
  </Tab>

  <Tab title="Segurança">
    ### Proteção de Dados

    Segurança e privacidade em primeiro lugar:

    <Steps>
      <Step title="Criptografia em Trânsito">
        Todas as comunicações via **HTTPS/TLS 1.3**
      </Step>

      <Step title="Criptografia em Repouso">
        Dados armazenados com **AES-256**
      </Step>

      <Step title="Conformidade LGPD">
        Processamento conforme Lei Geral de Proteção de Dados
      </Step>

      <Step title="Auditoria Completa">
        Logs de todas as operações para rastreabilidade
      </Step>

      <Step title="Retenção Limitada">
        Imagens processadas não são armazenadas permanentemente
      </Step>
    </Steps>

    <Warning>
      **Privacidade**: As imagens enviadas são processadas e descartadas. Não armazenamos documentos originais após a extração.
    </Warning>
  </Tab>

  <Tab title="Confiabilidade">
    ### Níveis de Confiança

    Cada campo extraído vem com um **score de confiança (0-100%)**:

    | Nível     | Range   | Ação Recomendada             |
    | --------- | ------- | ---------------------------- |
    | Excelente | 95-100% | Aceitar automaticamente      |
    | Bom       | 85-94%  | Aceitar com revisão opcional |
    | Regular   | 70-84%  | Revisar manualmente          |
    | Baixo     | \< 70%  | Solicitar nova imagem        |
  </Tab>
</Tabs>

***

## Comparação: Manual vs FlexExtractor

<div style={{overflowX: 'auto'}}>
  | Critério                | Processo Manual    | Com FlexExtractor | Economia      |
  | ----------------------- | ------------------ | ----------------- | ------------- |
  | **Tempo por documento** | 2-5 minutos        | 3-5 segundos      | **98%**       |
  | **Taxa de erro**        | 5-10%              | \< 2%             | **80%**       |
  | **Custo por documento** | R\$ 2,50           | R\$ 0,15          | **94%**       |
  | **Disponibilidade**     | Horário comercial  | 24/7              | **24h/dia**   |
  | **Escalabilidade**      | Linear (+ pessoas) | Horizontal        | **Ilimitada** |
  | **Auditoria**           | Papel, difícil     | Digital, completa | **100%**      |
</div>

***

## Início Rápido

<CardGroup cols={2}>
  <Card title="1. Obter Credenciais" icon="key" href="mailto:integracao@flexdoc.com.br">
    Entre em contato para receber username e password
  </Card>

  <Card title="2. Autenticação" icon="unlock" href="/flexextractor-auth">
    Gere seu access\_token via API
  </Card>

  <Card title="3. Extrair Dados" icon="file-code" href="/flexextractor-extract">
    Envie documentos e receba dados estruturados
  </Card>

  <Card title="4. Integrar Sistema" icon="puzzle-piece" href="/flexextractor-exemplos">
    Use nossos exemplos de código prontos
  </Card>
</CardGroup>

***

## Perguntas Frequentes

<AccordionGroup>
  <Accordion title="Quais formatos de imagem são aceitos?" icon="image">
    O FlexExtractor aceita os seguintes formatos:

    * **PDF** (recomendado para documentos digitalizados)
    * **JPG/JPEG** (recomendado para fotos)
    * **PNG** (recomendado para screenshots)

    **Tamanho máximo:** 10MB por imagem

    **Resolução recomendada:** Mínimo 300 DPI para melhor precisão
  </Accordion>

  <Accordion title="Como funciona a classificação automática?" icon="robot">
    Quando você **não informa** o campo `typealias`, nossa IA:

    1. Analisa a estrutura visual do documento
    2. Identifica elementos característicos (logos, layouts, campos)
    3. Compara com modelos treinados de cada tipo de documento
    4. Retorna o tipo mais provável no campo `typeRecognized`

    **Precisão da classificação:** > 98% para documentos brasileiros comuns

    <Tip>
      Para melhor performance, informe o `typealias` quando souber o tipo do documento
    </Tip>
  </Accordion>

  <Accordion title="Os dados são armazenados após a extração?" icon="database">
    **Não.** Por questões de segurança e privacidade:

    * Imagens são processadas em tempo real
    * Dados extraídos são retornados via API
    * Imagens são descartadas após processamento
    * Logs de acesso são mantidos apenas para auditoria (sem conteúdo)

    **Conformidade LGPD**: Processamos dados apenas como operadores, você é o controlador.
  </Accordion>

  <Accordion title="Qual a diferença entre FlexExtractor e FlexImage?" icon="circle-question">
    | Característica | FlexExtractor            | FlexImage (Import-Doc)          |
    | -------------- | ------------------------ | ------------------------------- |
    | **Função**     | Extração de dados (OCR)  | Análise documental completa     |
    | **Input**      | Imagem Base64            | Arquivo multipart               |
    | **Output**     | Campos extraídos         | Análise + Validação + Biometria |
    | **Velocidade** | Síncrono (2-5s)          | Assíncrono (webhook)            |
    | **Validação**  | Não                      | Sim (RF, Detran, etc)           |
    | **Uso típico** | Preenchimento automático | KYC/Onboarding                  |

    <Info>
      As APIs são complementares! Use FlexExtractor para extração rápida e FlexImage para validação completa.
    </Info>
  </Accordion>

  <Accordion title="O que fazer quando a confiança é baixa?" icon="triangle-exclamation">
    Quando um campo tem `confidence < 70%`:

    **1. Verifique a qualidade da imagem:**

    * Imagem está focada?
    * Iluminação está adequada?
    * Documento está completo (sem cortes)?

    **2. Melhore a imagem:**

    * Aumente a resolução (use 600 DPI)
    * Melhore a iluminação
    * Evite reflexos e sombras

    **3. Solicite nova foto ao usuário**

    **4. Revisão manual:**

    * Para processos críticos, implemente revisão humana
    * Use os valores extraídos como sugestão
  </Accordion>
</AccordionGroup>

***