KYB (Web SDK)

Know Your Business (KYBKYB (Know Your Business). Know Your Business - the identity verification process for corporate customers. This process allows you to securely verify your business customer's identity. Weavr asks users to submit the information and documentation they need for approval by financial providers.) is the corporate equivalent of consumer KYCKYC (Know Your Customer). Know Your Customer - the identity verification process for consumer customers. This process allows you to securely verify your user's identity. Weavr asks users to submit the information and documentation they need for approval by financial providers., and one of the steps required to onboard a corporate. Our Web SDK provides two related components for the corporate verification flow:

• KYB - captures the documentation needed to verify the corporate itself.
• Stakeholder due diligence - runs personal due diligence on each director, ultimate beneficial owner (UBO), or other stakeholder named during KYBKYB (Know Your Business). Know Your Business - the identity verification process for corporate customers. This process allows you to securely verify your business customer's identity. Weavr asks users to submit the information and documentation they need for approval by financial providers..

Set up the SDK first

To use our UI components, you must first set up the SDK in your app.

Looking for consumer verification?

For consumer due diligence, see KYC.

---

KYB

Use it for: the business-verification step of corporate onboarding, mounted on the page where the root userRoot userThe individual who creates the customer. For corporates, the root user needs to be a legal representative of the company, such as a director or someone with power of attorney. For consumers, the root user is the customer. Every customer must always have one root user. submits company documentation.

The KYBKYB (Know Your Business). Know Your Business - the identity verification process for corporate customers. This process allows you to securely verify your business customer's identity. Weavr asks users to submit the information and documentation they need for approval by financial providers. component runs the corporate verification flow inside your app, so the root userRoot userThe individual who creates the customer. For corporates, the root user needs to be a legal representative of the company, such as a director or someone with power of attorney. For consumers, the root user is the customer. Every customer must always have one root user. can complete due diligence without leaving your experience.

Check the KYB status

Before mounting the component, fetch the corporate's KYBKYB (Know Your Business). Know Your Business - the identity verification process for corporate customers. This process allows you to securely verify your business customer's identity. Weavr asks users to submit the information and documentation they need for approval by financial providers. status and use it to decide whether to render. Use corporateKybStatus for the corporate's access to financial services, and the latest relevant entry in kybRuns[] for the progress of the current KYBKYB (Know Your Business). Know Your Business - the identity verification process for corporate customers. This process allows you to securely verify your business customer's identity. Weavr asks users to submit the information and documentation they need for approval by financial providers. process.

GET/corporates/kybOpen API reference →

/corporates/kyb

Use corporateKybStatus and the latest run status to decide whether to render the component:

corporateKybStatus	Latest run status	Render the component?
NEW	No run	For self-service onboarding, call Start KYBKYB (Know Your Business). Know Your Business - the identity verification process for corporate customers. This process allows you to securely verify your business customer's identity. Weavr asks users to submit the information and documentation they need for approval by financial providers.. For managed onboarding, wait for the KYBKYB (Know Your Business). Know Your Business - the identity verification process for corporate customers. This process allows you to securely verify your business customer's identity. Weavr asks users to submit the information and documentation they need for approval by financial providers. status webhook with COLLECTION.READY_TO_START.
PENDING	COLLECTION.NOT_STARTED or COLLECTION.IN_PROGRESS	yes - let the root userRoot userThe individual who creates the customer. For corporates, the root user needs to be a legal representative of the company, such as a director or someone with power of attorney. For consumers, the root user is the customer. Every customer must always have one root user. start or resume submission.
PENDING	COLLECTION.READY_TO_START	Call Start KYBKYB (Know Your Business). Know Your Business - the identity verification process for corporate customers. This process allows you to securely verify your business customer's identity. Weavr asks users to submit the information and documentation they need for approval by financial providers., then render the component. This occurs only in managed onboarding.
PENDING	RESUBMISSION.IN_PROGRESS	yes - let the root userRoot userThe individual who creates the customer. For corporates, the root user needs to be a legal representative of the company, such as a director or someone with power of attorney. For consumers, the root user is the customer. Every customer must always have one root user. provide the requested information.
PENDING	REVIEW.IN_PROGRESS	no - the submission is awaiting review.
APPROVED, REJECTED, or CLOSED	Any	no - handle the outcome in your own UI.

kybStatus and ongoingKybStatus are deprecated, but remain available while you migrate to the new fields.

Get the KYB reference

Once the latest run is ready for collection, request a KYBKYB (Know Your Business). Know Your Business - the identity verification process for corporate customers. This process allows you to securely verify your business customer's identity. Weavr asks users to submit the information and documentation they need for approval by financial providers. reference for the session. In managed onboarding, wait for COLLECTION.READY_TO_START before making this call:

POST/corporates/kybOpen API reference →

/corporates/kyb

Display the KYB flow

<div id="kyb-container"></div>

<script type="text/javascript">
  window.OpcUxSecureClient.init("YOUR_UI_KEY");

  window.OpcUxSecureClient.associate(
    "Bearer YOUR_USER_AUTHENTICATION_TOKEN",
    function () {
      window.OpcUxSecureClient.kyb().init(
        // Selector for the container where the component renders
        "#kyb-container",

        // The KYB reference returned by the API call
        { reference: "YOUR_KYB_REFERENCE" },

        // The callback receives messageType values such as kybSubmitted,
        // kybApproved, kybRejected, or error, with any payload
        function (messageType, payload) {
          console.log({ messageType, payload });
        },

        {
          // ISO 639-1 language code for the flow. Falls back to English when no
          // translation is available for the requested language.
          lang: "YOUR_LANGUAGE",

          // Plain-text CSS string used to brand the embedded UI
          customCss: "YOUR_CUSTOM_CSS",
        }
      );
    }
  );
</script>

---

Stakeholder due diligence

Use it for: the page each director, UBO, or other stakeholder opens via the email link we send them, where they submit personal due diligence as part of corporate onboarding.

During KYBKYB (Know Your Business). Know Your Business - the identity verification process for corporate customers. This process allows you to securely verify your business customer's identity. Weavr asks users to submit the information and documentation they need for approval by financial providers., your customer enters details for the corporate's directors, UBOs, and any other stakeholders that need to be verified. We email those individuals directly so they can submit personal due diligence. The link in the email opens a page in your app where you mount the Stakeholder due diligence component, with the reference from the URL query string.

No authentication required

The Stakeholder due diligence component doesn't require the stakeholder to be authenticated.

Display the stakeholder due diligence flow

<div id="director-kyc-container"></div>

<script type="text/javascript">
  window.OpcUxSecureClient.init("YOUR_UI_KEY");

  window.OpcUxSecureClient.kyc().init(
    // Selector for the container where the component renders
    "#director-kyc-container",

    // The reference passed as a query parameter in the email URL
    { reference: "YOUR_REFERENCE" },

    // The callback receives messageType values such as kycSubmitted,
    // kycApproved, kycRejected, or error, with any payload
    function (messageType, payload) {
      console.log({ messageType, payload });
    },

    {
      // Plain-text CSS string used to brand the embedded UI
      customCss: "YOUR_CUSTOM_CSS",

      // ISO 639-1 language code for the flow. Falls back to English when no
      // translation is available for the requested language.
      lang: "YOUR_LANGUAGE",
    }
  );
</script>