web sdk reference

create

Description:

Initializes the SDK by creating an instance of the incode object. This object holds all the SDK methods.

Parameters:

Returns

• Object:

The SDK instance

Example:

// Get onBoarding instance
const onBoarding = OnBoarding.create({
  apiURL: "myApiURL",
  lang: "en",
});
// You can save it on a global variable
var onBoarding = OnBoarding.create({ apiURL: "myApiURL" });

initialize

Description:

This function ensures proper loading of the webSDK.

Example:

import { en } from "./en.js";

const Onboarding = await create({
  apiURL: apiURL,
  translations: en,
});

//Allows proper translation loading order
await Onboarding.initialize();

isDesktop

Description:

This function informs you if the user is using a desktop or laptop computer (as opposed to a mobile device)

Example:

if (onBoarding.isDesktop()) {
  onBoarding.renderRedirectToMobile(containerRef.current, {
    onSuccess: () => {
      renderFinishScreen();
    },
    session: session,
    flowId: flowId,
  });
} else {
  // show mobile normal flow
  renderFrontId();
}

renderRedirectToMobile

Description:

This method renders the Redirect Component.

Parameters:

Options:

Example:

const flowId = "someflowid";

const session = await onBoarding.createSession("ALL", null, {
  configurationId: flowId,
});

if (onBoarding.isDesktop()) {
  onBoarding.renderRedirectToMobile(containerRef.current, {
    onSuccess: () => {
      renderFinishScreen();
    },
    session: session,
    flowId: flowId,
  });
} else {
  // show mobile normal flow
  renderFrontId();
}

renderCombinedConsent

Description:

Renders a combined consent interface within a specified DOM element. This function allows for displaying a consent form that is predefined in the dashboard.

Parameters:

Example:

// Locate the DOM element where the consent screen should be rendered
const consentElement = document.getElementById("consent-root");

// Define the onSuccess callback function
const handleConsentGiven = () => {
  console.log("Combined consent given.");
};

// Define the configuration options for the consent screen
const consentOptions = {
  token: session,
  onSuccess: handleConsentGiven,
  consentId: "someConsentId", // id of a consent created in dashboard
};

// Call the renderCombinedConsent function with the defined parameters
renderCombinedConsent(consentElement, consentOptions);

sendGeolocation

Description:

This is almost the same as addGeolocation with the difference being that this will automatically ask the user for the coordinates.

Parameters:

Returns:

• Object:
• JSON example:

{
    "location": "Belgrade, Serbia"
}

Example:

onBoarding.sendGeolocation(token).then((res) => res);

sendFingerprint

Description:

Sends relevant information about the user's device and Incode's Web SDK:

• Browser version
• Device model
• Application type (Web application)
• OS and OS version
• Incode's Web SDK version
• User's IP address

Parameters:

Returns:

• Object:

{
    "success": boolean,
    "sessionStatus": string
}

Example:

onBoarding.sendFingerprint({ token: session.token }).then((response) => {
  console.log(response.success);
});

addPhone

Description:

Add phone number to an interview. If a customer with that phone number already exists, an error will be thrown.

Parameters:

Returns:

• Object:

{
    "success": true
}

Example:

onBoarding.addPhone({ token, phone }).then((res) => res);

addCustomFields

Description:

This endpoint is used for adding custom fields to the current onboarding session.

Parameters:

Returns:

• Object:
• Parameters:

• JSON example:

{
    "success": true
}

Example:

incode.addCustomFields({
  token: session.token,
  fields: { watchlistName: name },
});

renderCaptureId

Description:

The renderCaptureId method is responsible for initializing and displaying the ID verification module within a designated HTML Element. This module will present the document type selector, capture tutorials, and capture UI for double-sided ID documents, such as Driver's licenses, and single-sided ID documents, such as Passports.

Parameters:

Props:

Returns

The function returns an object with a single property:

• close: A function (function(): void) that, when called, will unmount and clean up the rendered CaptureId component from the DOM.

Errors:

The IdError will return a message, a code and optionally a generic error object.

Example:

import {renderCaptureId} from '@incodetech/welcome';

const myElement = document.getElementById('id-capture-container');
const mySession = { token: 'your_auth_token_here' }; // Example LooseSession

if (myElement) {
  const { close } = renderCaptureId(myElement, {
    session: mySession, // Pass the entire session object
    onSuccess: () => {
      console.log('ID capture successful!');
      // Perform actions after success
    },
    onError: (error) => {
      console.error('ID capture failed:', error);
      // Handle error
    },
  });

// To remove the component later:
  // close();
} else {
  console.error('Could not find the element to render into.');
}

renderCaptureFace

Description:

The renderCaptureFace function initializes and displays the Face Capture experience within a designated DOM element.

Parameters:

Props

Returns

The function returns an object with a single method:

• close: A function (() => void) that, when called, will manually unmount and clean up the rendered CaptureFace component from the DOM.

Example

import { renderCaptureFace } from "@incodetech/welcome";

const container = document.getElementById("face-capture-container");
const session = { token: "your_session_token_here" };

if (container) {
  try {
    const { close } = renderCaptureFace(container, {
      session: session,
      onSuccess: response => {
        console.log("Face capture successful!", response);
      },
      onError: error => {
        console.error("Face capture failed:", error.message);
      },
    });
  } catch (validationError) {
    console.error("Failed to render component:", validationError.message);
  }
} else {
  console.error("Could not find the container element for face capture.");
}

renderDocumentSelector

Description:

This method renders a Document Selector in a given container. It provides various customization options and callbacks for different stages of the document selection process.

Parameters:

Options:

Example:

const element = document.getElementById("your-container-id");
const onSuccess = () => {
  /* success handler code */
};
const onError = () => {
  /* error handler code */
};

renderDocumentSelector(element, {
  onSuccess,
  onError,
});

processId

Description:

This method should be called once the uploads of the front and back sides of the ID are over.

Parameters:

Returns:

• Object:

{
    "success": true
}

Example:

const response = await onBoarding.processId({
  token,
});

processFace

Description:

This method should be called after both the selfie and the front of the ID are uploaded.

Parameters:

Returns:

• Object:

{
    "confidence": 0.794,
    "existingUser": false
}

Example:

const response = await onBoarding.processFace({
  token,
});

renderVideoSelfie

Description:

This method renders the VideoSelfie Component.

Parameters:

Options:

Example:

onBoarding.renderVideoSelfie(
  container,
  {
    token: session,
    showTutorial: true,
    modules: ["front", "back", "speech", "selfie"],
  },
  {
    onSuccess: () => alert("speech detected"),
    onError: () => alert("speech not detected"),
  }
);

renderLogin

Description:

Renders the UI for the Face authentication module. The authentication can be run in two modes: 1:1 and 1:N.

Parameters:

Example:

incode.renderLogin(container, {
  onSuccess: onSuccess,
  onError: onError,
});