Skip to main content

Onboarding

Use the Onboarding module to embed Nium's customer onboarding form in your platform, under your brand. The form collects the customer data and the Know Your Customer and Know Your Business (KYC/KYB) data that Nium needs.

Onboarding is the entry point of the hub-and-spoke architecture. It creates the customer that every other Nium Embed component (Payouts, Multicurrency account, Cards) uses. The module has one component. It uses the @nium/nium-sdk package, Proof Key for Code Exchange (PKCE) authorization, and an iFrame.

Components​

ComponentElement typeDescription
Onboard customerscustomerOnboardingFormShows Nium's customer initial-enquiry and onboarding form for a business or an individual. Resumes sessions through externalId. Reflects your latest Nium API version automatically.

The component creates and progresses an onboarding session only. It doesn't create beneficiaries, wallets, or transactions. Downstream modules become available once the customer is onboarded.

How the module works​

The integration has two parts:

  1. Your server: authorization code endpoint. Call POST /client/{clientHashId}/oauth/authcode with a PKCE codeChallenge and the scope customer-onboarding-form. The endpoint returns a short-lived authorizationCode.
  2. Your client: SDK initialization and mount. Pass the authorization code and the codeVerifier to init(). Call createElement('customerOnboardingForm', properties). Mount the returned element to any container div in your page.
Call the authorization code endpoint from your server only

Never make this call from the client.

Events and sizing

After the auth code is exchanged, the iFrame hands off to Nium's hosted onboarding app on a separate origin. Your page receives ready and setup error events only. There is no submit or cancel event, so track onboarding progress on your server. The iFrame can't auto-resize after the handoff, so set customizations.minHeight to the height you want.

Next steps​

  • Onboard customers: Mount the form, set options, and handle events.
  • Theme customization: Style Nium Embed components. On the onboarding form, the theme styles only the initial loading screen.
LLM-ready documentation:: llms.txt and llms-full.txt
Was this page helpful?