Incode WebSDK reference

// 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" });

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

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

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

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

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();
}

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

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

// Define the configuration options for the consent dialog
const consentOptions = {
  session: session,
  onSuccess: handleConsentGiven,
  title: "Privacy and Cookies Consent",
  text: "We use cookies to ensure you get the best experience on our website. By continuing, you agree to our privacy policy.",
  // Optionally, provide a custom JSX component for additional consent options
  customCheck: null, // Assuming no custom JSX element is provided
};

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

// 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);

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

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

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

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

renderDocumentSelector(element, {
  onSuccess,
  onError,
  // ...other options
});

import {renderIdCapture} 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.');
}

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

renderDocumentSelector(element, {
  onSuccess,
  onError,
  // ...other options
});

function myCaptureFn(){
	incode.renderCamera("front", container, {
    onSuccess: myCaptureFnBackSide,
    onError: console.log,
    numberOfTries:3,
    token:session.token
  });
}

function myCaptureFnBackSide(){
	incode.renderCamera("back", container, {
    onSuccess: console.log,
    onError: console.log,
    numberOfTries:3,
    token:session.token
  });
}

//Notice no back side capture is required

function myPassportCapture(){
	incode.renderCamera("passport", container, {
    onSuccess: myCaptureFnBackSide,
    onError: console.log,
    numberOfTries:3,
    token:session.token
  });
}

// IMPORTANT: Notice the nativeCamera option. It enables the rear camera and allows PDF/image upload from the device gallery.

function myPassportCapture(){
	incode.renderCamera("document", container, {
    onSuccess: myCaptureFnBackSide,
    onError: console.log,
    numberOfTries:3,
    token:session.token,
    nativeCamera: true 
  });
}

function myCaptureFn(){
	incode.renderCamera("selfie", container, {
    onSuccess: myCallback,
    onError: console.log,
    numberOfTries:3,
    token:session.token
  });
}

const { close } = incode.renderCamera("front", container, {
    onSuccess: myCaptureFnBackSide,
    onError: console.log,
    numberOfTries:3,
    token:session.token
});

document.querySelector("#close-button").addEventListener("click", () => {
  close(); // closes and destroys the capture module prematurely.
});

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

onBoarding.renderVideoSelfie(
  container,
  {
    token: session,
    showTutorial: true,
    modules: ["front", "back", "speech", "selfie"], // you can add 'poa' and 'questions'
    speechToTextCheck: true,
    hatCheckEnabled: true,
    lensesCheckEnabled: true,
    maskCheckEnabled: true,
    eyesClosedCheckEnabled: true, 
  },
  {
    onSuccess: () => alert("speech detected"),
    onError: () => alert("speech not detected"),
    numberOfTries: 3,
  }
);

onBoarding.renderConference(
  container,
  {
    token: token,
    showOTP: false,
  },
  {
    onSuccess: (status) => {
      log(status);

      switch (status) {
        case "close":
          console.log("The conference was close");
          goToStep("closeCase");
          break;
        case "deny":
          console.log("The conference was denied");
          goToStep("denyCase");
          break;
        case "close":
          console.log("The conference was approved");
          goToStep("approveCase");
          break;
      }
    },
  }
);

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

incode.renderEnterCurp(document.getElementById('app'), {
  token: session.token,
  onSuccess: console.log,
  onError: console.log,,
})

onBoarding.renderSignature(document.getElementById("app"), {
  token: session.token,
  onSuccess: console.log,
  onError: console.log,
});

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

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

incode.renderBiometricConsent(document.getElementById("app"), {
  token: session,
  onSuccess: console.log,
  onCancel: console.log,
  regulationType: "US_Illinois",
});

onBoarding.renderMlConsent(document.getElementById("app"), {
  token: session,
  onSuccess() {
    console.log("ML accepted");
  },
});

const flowId = "someflowid";

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

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

onBoarding.renderQrScanner(document.getElementById("app"), {
  session: session,
  onSuccess() {
    console.log("QR scanned");
  },
});