Métodos disponíveis

Métodos disponíveis no Landing SDK Client.

A seguir são detalhados os diferentes métodos oferecidos por Landing SDK para as diferentes configurações disponíveis, com exemplos de implementação.

callLanding

Para iniciar a Landing, será utilizado o método callLanding. Com este método, será carregada a Landing SDK associada à ApiKey fornecida.

Exemplo:

const landingSDK = new LandingSDKClient('YOUR_APIKEY');

landingSDK.callLanding();

O servidor do cliente no callback recebe notifica

Este método pode receber um objeto com um ou vários parâmetros para configurar cada execução.

Exemplo:

lansingSDK.callLanding(options);

Os parâmetros de configuração disponíveis são os seguintes:

---

customerId

Este identificador permitirá associar a operação biométrica gerada em nossos processos ao seu cliente. Pode ser o e-mail dele ou um identificador que você tenha dos seus usuários.

Exemplo:

landingSDK.callLanding({
  customerId: '[email protected]'
})

---

documentNumber

Este parâmetro é opcional; você pode enviar o número de identificação do seu cliente, se o tiver, para que possamos compará-lo com os dados biométricos obtidos pelo nosso processo.

Exemplo:

landingSDK.callLanding({
  documentNumber: '1234567A'
})

---

callbackPath

Define os parâmetros que serão adicionados à chamada da URL de Callback que executaremos para enviar os dados capturados pelo processo biométrico.

Exemplo:

landingSDK.callLanding({
  callbackPath: 'https://url-callback-example.com/api/onboarding'
})

---

onFinish (iframe)

Este evento está disponível apenas na implementação com iFrame.

Ao finalizar o Fluxo, a Landing SDK emitirá o evento onFinish para adicionar qualquer lógica adicional para continuar o fluxo.

Exemplo:

landingSDK.callLanding({
  onFinish: () => {
    // Continue process once the onboarding is finished.
    finishOnboarding();
  }
})

---