> ## Documentation Index
> Fetch the complete documentation index at: https://docs.jelou.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Configuração da Biometria Webview

> Configure as saídas e personalize as regras, a marca e as mensagens da Biometria Webview.

## Saídas

### Sucesso

<AccordionGroup>
  <Accordion title="Biometria aprovada" icon="circle-check">
    Confirma que a verificação biométrica foi bem-sucedida.

    **Variável:** `approved`

    **Descrição:** Biometria aprovada

    **Estrutura da resposta (JSON):**

    ```json theme={null}
    {
      "document_response": {
        "document_check": {
          "result": "",
          "verified_fields": { "...": "Dados principais do documento" },
          "secondary_fields": { "...": "Dados secundários do documento" },
          "details": { "...": "Detalhes do tipo de documento" },
          "status_fields": { "...": "Status da validação" },
          "image_quality_details": { "...": "Detalhes de qualidade da imagem" },
          "images_extracted": { "...": "Imagens extraídas do documento" },
          "gov_entity_fields": { "document_number": "Número do documento de identidade" }
        },
        "document_image_front_url": "URL da imagem frontal do documento",
        "document_image_back_url": "URL da imagem do verso do documento",
        "document_face_image_url": "URL da imagem do rosto extraída do documento"
      },
      "liveness_response": {
        "result": "true",
        "url_selfie_image": "URL da foto usada para vivacidade"
      },
      "facematch_response": {
        "facematch_result": "approved",
        "facematch_confidence": "Percentual de correspondência (0-100)"
      },
      "reporte_de_biometria": {
        "report": "URL do relatório biométrico (web)",
        "report_pdf": "URL do relatório biométrico (PDF)"
      },
      "device_info": {
        "userAgent": "String user agent",
        "browser": "Navegador",
        "operatingSystem": "Sistema operacional",
        "platform": "Plataforma do dispositivo",
        "language": "Idioma",
        "timezone": "Fuso horário",
        "screenResolution": "Resolução da tela",
        "colorDepth": "Profundidade de cor em bits",
        "timestamp": "Timestamp do dispositivo",
        "ipAddress": "Endereço IP",
        "location": {
          "latitude": "Latitude (se o usuário conceder permissão)",
          "longitude": "Longitude (se o usuário conceder permissão)"
        },
        "deviceId": "ID único do dispositivo",
        "deviceName": "Nome do dispositivo"
      },
      "gov_entity_data": {
        "...": "Dados da entidade governamental do país (varia por país)"
      }
    }
    ```

    **Campos importantes:**

    * `document_response`: informações do documento de identidade
    * `liveness_response`: foto enviada para validar a prova de vida
    * `facematch_response`: resultado da comparação facial
    * `reporte_de_biometria`: URLs do relatório (web e PDF)
    * `device_info`: dados do dispositivo e localização (auditoria e rastreabilidade)
    * `gov_entity_data`: dados da entidade governamental (se aplicável)

    **Definições das variáveis JSON:**

    * **document\_response:** `document_check` (result, verified\_fields, secondary\_fields, details, status\_fields, image\_quality\_details, images\_extracted, gov\_entity\_fields), `document_image_front_url`, `document_image_back_url`, `document_face_image_url`
    * **liveness\_response:** `result`, `url_selfie_image`
    * **facematch\_response:** `facematch_result` (approved/decline), `facematch_confidence`
    * **reporte\_de\_biometria:** `report`, `report_pdf`
    * **device\_info:** `userAgent`, `browser`, `operatingSystem`, `platform`, `language`, `timezone`, `screenResolution`, `colorDepth`, `timestamp`, `ipAddress`, `location` (latitude, longitude; somente com permissão de localização), `deviceId`, `deviceName`
    * **gov\_entity\_data:** dados da entidade governamental do país (campos variam por país)
  </Accordion>
</AccordionGroup>

### Erros

<AccordionGroup>
  <Accordion title="Processo abandonado" icon="door-open">
    O usuário saiu do processo antes de concluí-lo.

    **Variável:** `incomplete`

    **Descrição:** Processo abandonado
  </Accordion>

  <Accordion title="Biometria rejeitada" icon="ban">
    A verificação biométrica falhou ou foi rejeitada.

    **Variável:** `reject`

    **Descrição:** Biometria rejeitada
  </Accordion>

  <Accordion title="Erro no processo" icon="triangle-exclamation">
    Erro durante a execução do processo biométrico.

    **Variável:** `error`

    **Descrição:** Erro no processo
  </Accordion>
</AccordionGroup>

## Como personalizar a experiência?

<Steps>
  <Step title="Abra o painel de Biometria">
    Clique no botão **Configurar Webviews** do nó Biometria ou vá ao painel lateral esquerdo da plataforma, na seção **Biometria**.
  </Step>

  <Step title="Conheça as seções de Biometria">
    Na seção **Biometria** você verá:

    * **Atividade:** mostra em detalhe todas as biometrias realizadas, com o status por etapa e o acesso ao relatório biométrico.
    * **Configuração Webviews:** permite criar agentes de biometria com diferentes configurações, cores e estilos, mensagens e telas, que você poderá usar dentro de uma mesma empresa ou workflow.
  </Step>

  <Step title="Configure o seu Webview">
    Em **Configuração Webviews** você verá as abas de configuração do agente. Cada aba é explicada a seguir.
  </Step>
</Steps>

<Info>
  Enquanto você configura, a plataforma mostra uma pré-visualização do celular. Você pode personalizar a aparência e o que o Webview diz, mas não como a captura funciona nem seus controles de segurança. É uma restrição intencional para manter o padrão de verificação.
</Info>

<AccordionGroup>
  <Accordion title="Geral" icon="sliders">
    Configura as regras básicas de desempenho do agente. Aqui devem estar refletidas as principais regras de negócio do seu cliente.

    **País da validação**

    Define os documentos que devem ser aceitos e contra qual registro oficial a validação é feita.

    **O que a biometria inclui?**

    * **Prova de vida, verificação de documento e comparação facial:** são a base do processo e não podem ser desativadas.
    * **Habilitar revisão governamental:** valida os dados do documento contra uma fonte oficial.
    * **Facematch com entidade governamental:** compara a selfie com a foto oficial da fonte governamental. **Só está disponível no Equador.**

    Conheça os detalhes em [Validação governamental](/pt/guias/integracoes/identidade/validacao-governamental).

    <Warning>
      Se você precisar desativar a validação governamental, envie um e-mail ao suporte ou abra um ticket de client request para a equipe de Produto Biometria.
    </Warning>

    **Quais documentos permite?**

    * **Documento nacional de identidade.**
    * **Passaporte do país de validação.** O passaporte só pode ser capturado com a pré-visualização, então ativá-lo fixa essa experiência em **Verificação de documento**.

    Com mais de um tipo permitido, o usuário escolhe qual apresentar antes da captura.

    **Tempo de expiração**

    Define por quanto tempo o link do Webview permanece ativo antes de expirar. Por padrão, são **60 minutos**.

    **Idioma**

    É o idioma com o qual a experiência abre.
  </Accordion>

  <Accordion title="Branding" icon="palette">
    Adapte as cores e o estilo da experiência à sua marca. Ela é organizada em três seções: **Marca**, **Logo** e **Interface**. As cores são configuradas separadamente no **modo claro** e no **modo escuro**.

    **Marca**

    * Cores da marca: pontos do indicador de etapas concluídas.
    * Cor dos botões principais, do link de termos e condições, dos spinners e das etapas não concluídas.
    * Cor de fundo e cor do texto.
    * Cor dos spinners na tela final de verificação.
    * Estilo do stepper no cabeçalho de todas as telas. Por padrão, é circular.
    * Seletor de idioma, para que o usuário possa mudar o idioma da experiência.

    **Logo**

    * **Logo da empresa:** insira a URL da imagem do seu logo. Você pode vê-lo em uma pré-visualização antes de salvar.

    **Interface**

    * **Mostrar seta nos botões principais:** ativa ou desativa uma seta nos botões principais da experiência.
  </Accordion>

  <Accordion title="Tela Início" icon="house">
    É a primeira tela do processo. Aqui o usuário aceita os termos e inicia a verificação.

    | Campo | Descrição |
    | - | - |
    | HTML da tela | HTML próprio da tela. Se ficar vazio, o Webview usa o da aba **Padrão**. |
    | Texto do link legal | Por exemplo, "Termos e condições". |
    | URL de termos e condições | URL pública que deve mencionar o uso, o armazenamento e o tratamento de dados pessoais e biométricos. |
  </Accordion>

  <Accordion title="Tela prova de vida" icon="face-smile">
    Define as instruções para a selfie e o limite de tentativas.

    **Máximo de tentativas da selfie**

    * Escolha **1, 2 ou 3** tentativas. Por padrão, são 2.
    * É independente do limite de tentativas do documento.
    * Mais tentativas ajudam o usuário legítimo. Menos tentativas limitam que alguém tente várias vezes.

    **Layout da tela de instruções**

    * **Imagem e texto:** o Webview mostra a sua ilustração e, abaixo dela, o texto que você definir.
    * **Tela cheia:** o seu HTML substitui a ilustração e o texto. O cabeçalho com as etapas e o botão de continuar são mantidos.
  </Accordion>

  <Accordion title="Verificação de documento" icon="id-card">
    Define as instruções, a captura, os resultados e as regras de segurança do documento.

    | Configuração | O que faz |
    | - | - |
    | Máximo de tentativas | 1, 2 ou 3 tentativas. Por padrão, são 2. |
    | Nível de análise do documento | Padrão, Avançado ou Personalizado. Revise [Nível de análise do documento](/pt/guias/integracoes/identidade/nivel-de-analise-do-documento) antes de escolhê-lo. |
    | Habilitar revisão humana | Ativa o [HIL](/pt/guias/integracoes/identidade/hil). Somente para contas Enterprise e com custo adicional. |
    | Habilitar validação de recaptura | Rejeita documentos fotografados a partir de telas ou impressões. Para ativá-la, abra um client request para a equipe de Produto Biometria. |
    | Limite de comparação facial | Percentual mínimo de correspondência entre a selfie e a foto do documento. Por padrão, é **70%**. É ajustado na seção **Segurança**. |

    <Warning>
      **Revise o nível de análise antes de publicar.** É a configuração que mais influencia a taxa de aprovação. Conheça cada nível e a configuração recomendada por país em [Nível de análise do documento](/pt/guias/integracoes/identidade/nivel-de-analise-do-documento). Se você precisa de ajuda para definir a melhor configuração para o seu documento, use o [Onboarding com a Jelou CLI](/pt/guias/integracoes/identidade/onboarding-biometria).
    </Warning>

    <AccordionGroup>
      <Accordion title="Personalização de tela" icon="mobile-screen">
        Define as instruções, a captura e as telas de verificação do documento.

        **Tela de instruções do documento**

        * **Layout da tela:** escolha **Imagem e texto** (o Webview mostra a ilustração da tela e, abaixo dela, o seu bloco de texto) ou **Tela cheia** (o seu HTML substitui a ilustração e o texto; o cabeçalho com as etapas e o botão de continuar são mantidos).
        * **HTML próprio da tela:** escolha **Da empresa** para usar o seu HTML ou **Padrão** para usar o do Webview. Se você não definir um HTML próprio, o Webview usa o da aba **Padrão**.

        **Imagem da tela de documento**

        Insira a URL da imagem exibida na tela de documento. Você pode vê-la em uma pré-visualização.

        **Captura do documento**

        Define a experiência que o usuário final vive ao capturar a frente e o verso do documento. Escolha uma destas opções:

        | Opção | O que o usuário vê |
        | - | - |
        | **Contagem regressiva** | Depois de capturar a frente, vê um contador de 5 segundos que o orienta a virar o documento e tirar a foto do verso. |
        | **Pré-visualização** | Depois de cada captura, vê a foto tirada e decide se quer repeti-la ou continuar. Ao confirmar a frente, é ativado um contador de 5 segundos que avisa que ele deve virar o documento. Ao capturar o verso, também vê a foto para confirmá-la. Vale para a frente e para o verso. |

        <Note>
          O passaporte só pode ser capturado com a opção **Pré-visualização**. Ao permitir o passaporte na aba **Geral**, essa opção fica fixa.
        </Note>

        **Tela de verificação de informações**

        Lista de etapas que o usuário vê enquanto o documento é analisado. Você pode editar cada texto; se deixá-lo vazio, o texto padrão é usado.

        | Processo | Descrição do processo | O que o usuário vê por padrão |
        | - | - | - |
        | Título da tela | Cabeçalho enquanto a análise é executada. | Analisando seu documento |
        | Etapa: leitura de dados | Extração OCR dos dados do documento. | Obtendo os dados do seu documento |
        | Etapa: autenticidade | Detecção de recaptura (foto de tela ou impressão). Só aparece com a detecção de recaptura ativa. | Verificando a autenticidade do documento |
        | Etapa: integridade | Análise de manipulação da imagem. | Verificando a integridade do documento |
        | Etapa: entidade governamental | Confronto com o registro civil. Só aparece com a validação governamental ativa. | Validando com a entidade governamental |
        | Etapa: correspondência facial | Comparação entre a selfie e a foto do documento. | Verificando a correspondência facial |

        **Tela de sucesso**

        É o que o usuário vê quando o documento foi validado. O texto padrão de cada campo é o que o Webview usa se você deixá-lo vazio. Você também pode usar **HTML próprio da tela** (**Da empresa** ou **Padrão**).
      </Accordion>

      <Accordion title="Validação de recaptura" icon="camera-rotate">
        Uma **recaptura** ocorre quando o usuário fotografa uma tela ou uma impressão do documento, em vez do documento físico. Esta validação é uma camada extra de segurança que protege a sua operação contra tentativas de falsificação com fotos de telas.

        Lembre-se de que a ferramenta analisa fotos de telas, mas também pode sinalizar fotos com muitos brilhos ou reflexos, por exemplo por luz direta ou documentos plastificados. Esses casos podem ser considerados falsos positivos e afetar a taxa de aprovação.

        <Tip>
          Antes de ativá-la, avalie as condições em que os seus usuários costumam tirar a foto. Se você já tem revisão humana (HIL), esses casos podem ser revisados em vez de rejeitados. Para ativar a validação de recaptura, abra um client request para a equipe de Produto Biometria.
        </Tip>

        <Warning>
          Ao ativá-la, a análise é mais rigorosa: pode aumentar o tempo total do processo e diminuir a taxa de aprovação quando os documentos apresentarem reflexos ou brilhos causados por luz interna.
        </Warning>
      </Accordion>

      <Accordion title="Limite de comparação facial" icon="face-viewfinder">
        Um limite alto prioriza a segurança e rejeita mais. Um limite baixo prioriza a aprovação e deixa passar mais. É uma decisão de risco da sua empresa; ajuste-o conforme o nível de risco que a sua operação pode aceitar.
      </Accordion>

      <Accordion title="Textos padrão: resultado aprovado e erros" icon="message-lines">
        Se você deixar um campo vazio, o texto padrão é usado. O mesmo texto é reaproveitado na tela de limite de tentativas.

        | Tela | Quando aparece | Texto padrão |
        | - | - | - |
        | Resultado aprovado | O documento foi verificado. | **Documento validado.** Seu documento de identidade foi verificado com sucesso. |
        | Falha na leitura de dados | O OCR não conseguiu ler o documento. | Não conseguimos ler as informações do seu documento. Evite reflexos ou excesso de luz. |
        | Recaptura detectada | O documento parece uma foto de uma tela ou de uma impressão. | Não conseguimos ler as informações do seu documento. Evite brilhos, excesso de luz ou fotografias de telas. |
        | Integridade comprometida | Foi detectada manipulação na imagem. | Não conseguimos verificar a integridade do seu documento. Certifique-se de que é um documento original e não foi modificado, e tente novamente. |
        | Entidade governamental | O registro civil não confirmou os dados. | Não conseguimos validar seu documento com a entidade governamental. Verifique se os dados do seu documento estão legíveis e tente novamente. |
        | Frente e verso diferentes | Os dois lados são de documentos diferentes. | Detectamos uma inconsistência ao validar seu documento. Por favor, tente novamente. |
        | Falha na comparação facial | O rosto da selfie não corresponde ao do documento. | Não foi possível comparar seu rosto com a foto do documento. Evite reflexos, sombras ou luzes fortes ao tirar a foto. |
        | Erro genérico | Reserva de todos os anteriores e limite de tentativas. | Não conseguimos validar seu documento após várias tentativas. Por favor, entre em contato com o suporte. |
      </Accordion>
    </AccordionGroup>
  </Accordion>

  <Accordion title="Mensagens no WhatsApp" icon="comments">
    Define o que o agente escreve durante a validação.

    * As mensagens do agente durante a validação, por momento da conversa.
    * O idioma de cada mensagem.
    * O convite para validar: título, mensagem, rodapé e texto do botão.
    * A mensagem de espera.

    Os campos vazios usam o texto padrão:

    | Mensagem | Texto padrão |
    | - | - |
    | Título | Vou validar a sua identidade |
    | Mensagem | Será rápido e seguro. Seus dados estão protegidos e serão usados para confirmar que é você. Eu vou te guiar passo a passo. |
    | Rodapé | Toque no botão para começar |
    | Texto do botão | Iniciar validação |
    | Mensagem de espera | Caso não queira continuar, escreva SAIR. |
  </Accordion>

  <Accordion title="Modo QA" icon="flask">
    É uma opção somente para **versões de teste internas**. Mostra ao usuário final (QA) um painel de desempenho ao capturar a imagem do documento e, ao finalizar, o detalhe da falha.

    <Warning>
      Não o habilite em versões que serão usadas pelos seus clientes finais.
    </Warning>
  </Accordion>
</AccordionGroup>

<Info>
  Esta configuração é salva por Webview. Você pode criar várias versões e escolher qual delas cada nó Biometria dos seus fluxos usa.
</Info>

## Perguntas frequentes

<AccordionGroup>
  <Accordion title="Quais documentos são necessários durante o processo biométrico?">
    São necessárias fotos do **documento de identidade pelos dois lados**: frente e verso.
  </Accordion>

  <Accordion title="Preciso de uma conta de WhatsApp verificada?">
    Não. Se a sua conta não estiver verificada, a página abre no navegador do celular em vez de abrir dentro do WhatsApp.
  </Accordion>

  <Accordion title="Posso personalizar as cores e o idioma da experiência?">
    Sim. Você pode ajustar as cores e o estilo do stepper na aba **Branding**, e o idioma das mensagens do WhatsApp. Os widgets de captura facial e de documento não são editáveis.
  </Accordion>

  <Accordion title="Quantos outputs este agente tem?">
    Tem **1 output de sucesso** (Biometria aprovada) e **3 outputs de erro** (Processo abandonado, Biometria rejeitada, Erro no processo). Cada um pode direcionar para mensagem personalizada ou Connect.
  </Accordion>

  <Accordion title="O que acontece se eu estiver tendo muitos documentos rejeitados?">
    Na maioria dos casos, a causa é um nível de análise documental muito rigoroso para o país. Revise a aba **Verificação de documento** e ajuste o nível conforme a configuração recomendada por país em [Nível de análise do documento](/pt/guias/integracoes/identidade/nivel-de-analise-do-documento).
  </Accordion>

  <Accordion title="Se eu cobrir parte do documento que contém informação relevante, a verificação de documento ainda assim aprova?">
    Na etapa de verificação de documento, o sistema identifica o tipo de documento (país, ano de emissão) e o compara com um modelo. Se o documento corresponder e não apresentar sinais de manipulação, ele é aprovado, extraindo os dados por meio de OCR. Se o elemento que cobre o documento não ocultar informação relevante, ele pode ser aprovado; mas se a validação governamental estiver ativa e os dados estiverem incorretos, a biometria será rejeitada.
  </Accordion>
</AccordionGroup>

<Card title="Próximo: Relatórios" icon="arrow-right" href="/pt/guias/integracoes/identidade/relatorios-biometria">
  Consulte a atividade e o relatório biométrico de cada processo.
</Card>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.