Available methods

Available methods in Landing SDK Client.

The different methods offered by Landing SDK for the different available configurations are detailed below, with implementation examples.

callLanding

To launch the Landing, use the method callLanding. With this method, the Landing SDK associated with the provided ApiKey will be loaded.

Example:

const landingSDK = new LandingSDKClient('YOUR_APIKEY');

landingSDK.callLanding();

The client's callback server receives notifica

This method can receive an object with one or more parameters to configure each execution.

Example:

lansingSDK.callLanding(options);

The available configuration parameters are as follows:

---

customerId

This identifier will allow you to associate the biometric operation generated in our processes with your client. It can be their email address or an identifier you have for your users.

Example:

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

---

documentNumber

This parameter is optional; you can send your customer's ID number if you have it so that we can compare it with the biometric data obtained by our process.

Example:

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

---

callbackPath

Defines the parameters that will be added to the Callback URL call that we will execute to send the data captured by the biometric process.

Example:

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

---

onFinish (iframe)

This event is only available in the iFrame implementation.

When the Flow ends, the Landing SDK will emit the event onFinish to add any additional logic to continue the Flow.

Example:

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

---