KYB (Web SDK)

Know Your Business (KYBKYB Know Your Business - the identity verification process for corporate identities. This process allows you to seamlessly and securely verify your business customer's identity. Weavr will ask users to submit the necessary information and documentation so that they can get approved by financial providers.) is the corporate equivalent of consumer KYCKYC Know Your Customer - the identity verification process for consumer identities. This process allows you to seamlessly and securely verify your user's identity. Weavr will ask users to submit the necessary information and documentation so that they can get approved by financial providers., and one of the steps required to onboard a corporate identity. 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 - the identity verification process for corporate identities. This process allows you to seamlessly and securely verify your business customer's identity. Weavr will ask users to submit the necessary information and documentation so that they can get approved by financial providers..

tip

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 user The individual who creates the identity. For corporate identities, the root user needs to be a legal representative of the corporate such as a director or a representative who has the power of attorney over the company. For consumer identities, the root user is the owner of the identity. Every identity must always have one root user. submits company documentation.

The KYBKYB Know Your Business - the identity verification process for corporate identities. This process allows you to seamlessly and securely verify your business customer's identity. Weavr will ask users to submit the necessary information and documentation so that they can get approved by financial providers. component runs the corporate verification flow inside your app, so the root userRoot user The individual who creates the identity. For corporate identities, the root user needs to be a legal representative of the corporate such as a director or a representative who has the power of attorney over the company. For consumer identities, the root user is the owner of the identity. Every identity 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 - the identity verification process for corporate identities. This process allows you to seamlessly and securely verify your business customer's identity. Weavr will ask users to submit the necessary information and documentation so that they can get approved by financial providers. status and use it to decide whether to render. Skip the component when KYBKYB Know Your Business - the identity verification process for corporate identities. This process allows you to seamlessly and securely verify your business customer's identity. Weavr will ask users to submit the necessary information and documentation so that they can get approved by financial providers. is already approved, awaiting review, or rejected - re-rendering the flow in those states confuses the user and can invite a duplicate submission.

GET/corporates/kybTry it

Response

{
  "kybStatus": "NOT_STARTED",
  "ongoingKybStatus": "NOT_STARTED"
}

Use kybStatus to decide whether to render the component:

kybStatus	Render the component?
NOT_STARTED	yes - start the flow.
INITIATED	yes - let the root userRoot user The individual who creates the identity. For corporate identities, the root user needs to be a legal representative of the corporate such as a director or a representative who has the power of attorney over the company. For consumer identities, the root user is the owner of the identity. Every identity must always have one root user. resume submission.
PENDING_REVIEW	no - submission is awaiting our review.
APPROVED	no - the corporate is already verified.
REJECTED	no - handle rejection in your own UI.

Get the KYB reference

Once you've confirmed the corporate still needs to submit, request a KYBKYB Know Your Business - the identity verification process for corporate identities. This process allows you to seamlessly and securely verify your business customer's identity. Weavr will ask users to submit the necessary information and documentation so that they can get approved by financial providers. reference for the session:

POST/corporates/kybTry it

Response

{
  "reference": "string"
}

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 - the identity verification process for corporate identities. This process allows you to seamlessly and securely verify your business customer's identity. Weavr will ask users to submit the necessary information and documentation so that they can get approved 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.

info

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>