Opções

host

O host é o endereço da API Legitimuz.

• Tipo: String
• Padrão: https://api.legitimuz.com

token

O token é o seu token de integração. Você pode gerar um token de integração na página integrações (opens in a new tab) na aba de instalação do Dashboard Legitimuz.

• Tipo: String

lang(opcional)

A opção lang é o idioma que será utilizado no fluxo de validação OCR + Face Match.

• Tipo: pt | en | es
• Padrão: pt

enableRedirect(opcional)

A opção enableRedirect é um booleano que define se após o fluxo de validação OCR + Face Match o usuário será redirecionado para o link cadastrado no Dashboard Legitimuz.

• Tipo: Boolean
• Padrão: false

autoOpenValidation(opcional)

A opção autoOpenValidation é um booleano que define se o popup de de validação OCR + Face Match será aberto automaticamente após a entrada de valor no input (opens in a new tab) de cpf.

• Tipo: Boolean
• Padrão: false

onSuccess(opcional)

O callback de sucesso é chamado quando ocorre sucesso em alguma etapa do fluxo de validação OCR + Face Match. Como parâmetro, é passado uma string (opens in a new tab) com a etapa que ocorreu sucesso.

• Tipo: Function
• Tipo do parâmetro: ocr | facematch

const legitimuz = Legitimuz({
  /* opções */
  onSuccess(eventName) {
    console.log(eventName); // ocr | facematch
  },
});
 
legitimuz.mount();

onError(opcional)

O callback de erro é chamado quando ocorre erro em alguma etapa do fluxo de validação OCR + Face Match. Como parâmetro, é passado uma string (opens in a new tab) com a etapa que ocorreu erro.

• Tipo: Function
• Tipo do parâmetro: ocr | facematch

const legitimuz = Legitimuz({
  /* opções */
  onError(eventName) {
    console.log(eventName); // ocr | facematch
  },
});