Iniciando o plugin

A janela do plugin é aberta com open(options) método:

OzLiveness.open({
// omita session_token se a sua versão do SDK for anterior a 1.9.2 ou se você tiver definido api_use_session_token como api
  session_token, 
  lang: 'en',
  action: [
    'photo_id_front', // solicite a foto da frente do documento de identificação
    // você pode adicionar vários gestos aqui para o cenário de múltiplos gestos
    // 'video_selfie_smile',
    // 'video_selfie_eyes',
    'video_selfie_blank' // solicite o vídeo de Liveness passiva
  ],
  meta: { 
    // um ID do usuário submetido à verificação
    // adicione para facilitar o cálculo de conversão
    'end_user_id': '<user_or_lead_id>',
    // Seu identificador exclusivo que você pode usar depois para encontrar esta pasta em Oz API 
    // Opcional, mas recomendado
    'transaction_id': '<your_transaction_id>',
    // Você pode adicionar iin se planejar agrupar transações pelo identificador da pessoa 
    'iin': '<your_client_iin>',
    // Outros metadados
    'meta_key': 'meta_value',
  },
  on_error: function (result) {
  // detalhes do erro
  console.error('on_error', result);
  },
  on_complete: function (result) {
    // Este callback é invocado quando a análise é concluída
    // Recomenda-se iniciar a transação no seu backend, 
    // usando transaction_id para encontrar a pasta em Oz API e obter os resultados
    console.log('on_complete', result);
  },
  on_capture_complete: function (result) {
    // Trate os dados capturados aqui, se necessário
    console.log('on_capture_complete', result);
  }
});

Chame GET /api/folders/?meta_data=transaction_id==<your_transaction_id> para encontrar uma pasta em Oz API no seu backend usando seu identificador exclusivo.

Saiba mais sobre Oz API.

Parâmetros

Observação: a licença e o token devem ser adicionados no backend, exceto em casos específicos.

A lista completa de OzLiveness.open() parâmetros:

• options – um objeto com as seguintes configurações:

  • session_token – um token específico necessário para usar o contêiner de dados OzCapsula.

  • token – (opcional) o token de autenticação;

  • license – um objeto contendo os dados da licença;

  • licenseUrl – uma string contendo o caminho da licença; _{Aviso: Os license e licenseUrl parâmetros substituem a licença do lado do servidor, incluindo a data de expiração. Se você usar uma licença do lado do servidor, omita esses parâmetros de OzLiveness.open(), caso contrário, poderá ocorrer um erro de licença.}

  • lang – uma string contendo o identificador de um dos pacotes de idioma instalados;

  • meta – um objeto com nomes de campos de metadados nas chaves e seus valores de string nos valores. Os metadados são transferidos para Oz API e podem ser usados para obter resultados de análise ou para busca;

  • params – um objeto com identificadores e parâmetros adicionais:

    • extract_best_shot – true ou false: execute a escolha do melhor quadro na análise QUALITY;

  • action – uma matriz de strings com identificadores das ações a serem executadas. Ações disponíveis:

    • photo_id_front – foto da frente do documento de identificação;

    • photo_id_back – foto do verso do documento de identificação;

    • video_selfie_left – vire a cabeça para a esquerda;

    • video_selfie_right – vire a cabeça para a direita;

    • video_selfie_down – incline a cabeça para baixo;

    • video_selfie_high – levante a cabeça;

    • video_selfie_smile – sorria;

    • video_selfie_eyes – pisque;

    • video_selfie_scan – escaneamento;

    • video_selfie_blank – nenhuma ação, selfie simples;

    • video_selfie_best – ação especial para selecionar a melhor captura de um vídeo e realizar a análise nela em vez do vídeo completo. _{Em 1º de janeiro de 2027, o gesto One Shot ficará indisponível. Planeje sua migração.}

  • overlay_options – as opções de exibição do modelo do documento:

    • show_document_pattern: true/false – true por padrão, exibe uma imagem de modelo; se definido como false, a imagem é substituída por uma moldura retangular;

  • on_submit – uma função de callback (sem argumentos) que é chamada após o envio dos dados do cliente para o servidor (indisponível para o capture modo).

  • on_capture_complete – uma função de callback (com um argumento) que é chamada após o vídeo ser capturado e recupera as informações desse vídeo. O exemplo da resposta é descrito aqui.

  • on_result – uma função de callback (com um argumento) que é chamada periodicamente durante a análise e recupera um resultado intermediário (indisponível para o capture modo). O conteúdo do resultado depende do parâmetro de configuração do Web Adapter result_mode parâmetro de configuração e é descrito aqui.

  • on_complete – uma função de callback (com um argumento) que é chamada após a verificação ser concluída e recupera o resultado da análise (indisponível para o capture modo). O conteúdo do resultado depende do parâmetro de configuração do Web Adapter result_mode parâmetro de configuração e é descrito aqui.

  • on_error – uma função de callback (com um argumento) que é chamada em caso de qualquer erro ocorrido durante a captura de vídeo e recupera as informações do erro: um objeto com o código do erro, a mensagem de erro e o ID de telemetria para registro.

  • on_close – uma função de callback (sem argumentos) que é chamada após a janela do plugin ser fechada (seja manualmente pelo usuário ou automaticamente após a conclusão da verificação).

  • style – a seção de personalização.

  • device_id – (opcional) identificador da câmera que está sendo usada.

  • enable_3d_mask – ativa a máscara 3D como o comportamento padrão de captura facial. Este parâmetro funciona somente se load_3d_mask nas configurações do Web Adapter parâmetros de configuração estiver definido como true; o valor padrão é false. _{Em 1º de janeiro de 2027, a 3D Mask ficará indisponível.}

  • cameraFacingMode (desde 1.4.0) – o parâmetro que define qual câmera usar; valores possíveis: user (câmera frontal), environment (câmera traseira). Este parâmetro funciona somente se a opção use_for_liveness nas configurações do Web Adapter arquivo estiver indefinido. Se use_for_liveness estiver definido (com qualquer valor), cameraFacingMode é substituído e ignorado.

  • disable_adaptive_aspect_ratio (desde 1.5.0) – se True, desativa a proporção de aspecto adaptativa do vídeo, de modo que o seu vídeo não se ajuste automaticamente à proporção da janela. O valor padrão é False, e por padrão o vídeo se ajusta à proporção mais próxima de 4:3, 3:4, 16:9 ou 9:16. Observação: smartphones ainda exigem a orientação retrato para funcionar.

  • get_user_media_timeout (desde 1.5.0) – quando o Web SDK não consegue acessar a câmera do usuário, após esse tempo limite ele exibe uma dica sobre como resolver o problema. O valor padrão é 40000 (ms).

  • se getUserMedia() a função travar, você pode gerenciar o comportamento do SDK usando os seguintes parâmetros (desde 1.7.15):

    • get_user_media_promise_timeout_ms – define o tempo limite (em ms) após o qual o SDK lançará um erro ou exibirá uma instrução. Este parâmetro é um objeto com as seguintes chaves: "platform_browser", "browser", "platform", "default"(a prioridade corresponde à sequência).

    • get_user_media_promise_timeout_throw_error – define se, após o período de tempo definido no parâmetro acima, o SDK deve chamar um erro (se true) ou exibir uma instrução ao usuário (se false).