Embedded KYC/KYB Component

Before you begin

Before loading the component, make sure that you have set a new connected account on the following endpoint - Set New Connected Account, and make sure that:

You have received an accountId from Okoora Setup endpoint - this needs to be set as the clientId.
You know which environment should be used:
- demo for development and testing.
- production for live customer onboarding.
Your application can load external JavaScript resources from the Okoora static hosting domain.

We recommend completing and validating your integration in the demo environment before switching to production.

Add the component to your page

To load the component:

Add a container element to your page.
Define window.MyWidgetOptions.
Load the Okoora component script.
- Note - The configuration must be defined before the component script is loaded.

<div class="centered-container">
  <script>
    window.MyWidgetOptions = { 
      clientId: "2bb8d9b7-9d11-46e0-8973-4d89cf59d24f",		
      env: "demo"
    };
  </script>

  <script src="https://okoorastaticweb.z6.web.core.windows.net/js/KycComponent.js"></script>
</div>

Replace the example clientId with the client identifier provided by Okoora.

Configuration parameters

Parameter	Type	Required	Accepted Values	Description
clientId	String (UUID)	Yes	Valid UUID provided by Okoora Setup API endpoint (`accountId`)	Identifies the client whose KYC or KYB onboarding process should be displayed.
env	String	Yes	`demo`, `prod`	Determines which Okoora environment is used by the component.

Security considerations

Load the component only over HTTPS.
Do not place private API keys, secrets, or authentication credentials in window.MyWidgetOptions.
Pass only the parameters required by the component.
Do not rely only on client-side code for authorization.
Avoid exposing identifiers belonging to unrelated customers.
Use the production environment only for live onboarding.