For the complete documentation index, see llms.txt. This page is also available as Markdown.

Configurações do arquivo de configuração

Esta parte aborda o conteúdo de /core/app_config.json arquivo.

  • use_for_liveness – a opção é usada quando gerentes bancários estão gravando vídeos dos clientes. Se a opção estiver definida como true, os dispositivos móveis usam a câmera traseira por padrão e, no desktop, flip e oval circling estão desativados.

  • preinit – este parâmetro opcional ativa o carregamento preliminar de scripts e a inicialização da detecção de rosto. Isso é necessário para reduzir o plugin tempo de carregamento. O valor padrão é off o que significa que todos os scripts são carregados após a chamada de OzLiveness.open(). O script significa que os scripts serão carregados antes da inicialização do plugin. O full valor habilita o carregamento preliminar de scripts e a inicialização da detecção de rosto.

  • architecture – este parâmetro opcional é usado para escolher a arquitetura do Web SDK. O valor padrão é normal.

    • normal é usado para a versão completa do Oz API;

    • lite é usado para Instant API;

    • capture é usado para o mode que tem como objetivo trabalhar diretamente com o backend do CLIENT. Neste modo, o Oz Liveness Web Plugin pode ser distribuído somente por meio de arquivos estáticos (sem a parte do adapter; implementado em 0.7.4);

  • api_url – endereço do servidor Oz API, um parâmetro de texto;

  • api_token – token de acesso do Oz API, um parâmetro de texto;

  • api_use_token – um parâmetro para especificar a origem do token de acesso do Oz API para o sistema. Valores possíveis = config, client.

    • Se o valor do parâmetro for client, então espera-se que um token de acesso do Oz API seja derivado do JS plug-in;

    • Se for especificado config neste parâmetro, um token será recuperado do parâmetro api_token do arquivo de configuração do Oz Liveness Web Adapter.

  • video_actions_list – bloco de tags de arquivo de vídeo usadas no sistema, um array de texto. Lista atual de tags.

  • photo_actions_list – bloco de tags de arquivo de foto usadas no sistema, um array de texto. Lista atual de tags.

  • actions_default_importance – este parâmetro especifica se a substituição por um array de ações de um Web Plugin é permitida no lançamento de uma análise. Valores possíveis = true, false;

    • Se true, o Adapter usará um array de ações do arquivo de configuração.

    • Se false, o Adapter usará um array de ações encaminhado pelo navegador com o uso do open(options) método.

  • actions_default – o array de ações. As opções incluem:

    • video_count – o número de arquivos de vídeo transmitidos, um parâmetro numérico;

    • photo_front – indica se há uma página frontal no documento. Valores possíveis = true, false;

    • photo_back – indica se há uma página traseira no documento. Valores possíveis = true, false.

  • análises – um bloco para configurar o lançamento de análises. As opções incluem:

    • quality – lançamento da análise Oz Liveness. Valores possíveis = true, false;

    • biometry – lançamento da análise Oz Biometry. Valores possíveis = true, false;

    • documents – lançamento da análise Oz Text. Valores possíveis = true, false;

    • collection_ids (desde 1.4.0) – um array dos identificadores de coleções para a análise Black List.

  • extract_best_shot – um parâmetro que especifica se um link direto para a melhor captura (bestshot) extraída do vídeo deve ser anexado ao resultado da análise. Valores possíveis = true, false. Se true, a resposta conterá um link para a imagem extraída emoutput_images (results_media);

  • result_mode – um parâmetro que especifica o conteúdo da resposta do servidor com os resultados da verificação. Valores possíveis:

    • safe – apenas o estado das análises é retornado (concluídas ou ainda não);

    • status – os resultados das análises concluídas são retornados;

    • folder – igual a status, mas com o identificador da pasta adicionado.

  • result_codes– um bloco de códigos de resposta com anotações.

  • delete_old_sessions: true, false– se você deseja excluir sessões antigas

  • delete_old_sessions_offset_minutes: ***– deslocamento de tempo para exclusão de sessões antigas (em minutos)

  • video_required_actions_list– o array de ações obrigatórias

  • debug (desde 1.1.0) – se true, habilita o acesso à página /debug.php, que contém informações sobre a configuração atual e a licença atual.

  • tm_url (desde 1.2.0) – uma URL para Echo.

  • tm_token (desde 1.2.0) – um token para Echo.

  • load_3d_mask (desde 1.2.1) – se true, carrega o modelo para processar o vídeo gravado com a funcionalidade de máscara 3D. O valor padrão é false o que significa que o modelo não é usado e a máscara 3D fica indisponível (o enable_3d_mask parâmetro está sendo ignorado). Em 1º de janeiro de 2027, 3D Mask ficará indisponível.

  • enable_3d_mask (desde 1.2.1) – habilita a máscara 3D como o comportamento padrão de captura de rosto. Este parâmetro funciona somente se load_3d_mask está definido como true; o valor padrão é false. Em 1º de janeiro de 2027, 3D Mask ficará indisponível.

  • master_license_signature (desde 1.3.1) – o parâmetro para a assinatura da licença mestra; o valor padrão é null.

  • results_polling_interval (desde 1.4.0) – o intervalo para consulta dos resultados das análises em ms; o valor padrão é 1000.

  • get_user_media_timeout (desde 1.5.0) – define o tempo limite de acesso à câmera em segundos; após esse tempo limite, exibe uma dica sobre como resolver o problema; default_default para todos os navegadores e android_facebook para Facebook

  • disable_adapter_errors_on_screen (desde 1.5.0) – se true, desativa a exibição de erros em janelas modais, permitindo visualizá-los somente usando o on_error callback. O valor padrão é False.

  • auth (desde 1.7.14) – define se e qual autorização é usada:

    • true (padrão) – a autorização é necessária e se baseia na chave gerada;

    • user:pass – a autorização é necessária e se baseia no login e na senha do usuário;

    • false – nenhuma autorização necessária.

  • use_wasm_container (desde 1.9.2) – se true, habilita a funcionalidade de OzCapsula Data Container. O valor padrão é False.

  • api_use_session_token (desde 1.9.2) – define como o token de sessão é obtido e transmitido.

    • client (padrão) – você obtém o token por meio da chamada de API, conforme descrito aqui.

    • api – o token de sessão é obtido automaticamente.

  • logo (desde 1.9.7) – uma URL para o seu logotipo personalizado, somente se permitido pela licença (cobrado separadamente). Formatos: SVG (recomendado), PNG, JPG.

  • feature_stateless_adapter (desde 2.0.0) – um modo para implantações multiinstância. Neste modo, não salvamos o estado da sessão em disco, retornando-o com cada resposta como um objeto blob criptografado. O valor padrão é False.

Atualizado

Isto foi útil?