Search...
Log inGet started
Airwallex logo
Home
Core API
Payments
Transactional FX
Payouts
Issuing
Back to home
OverviewUnderstanding Payments for PlatformsChoose your Payments for Platforms solution
Airwallex gateway
Hold & convert funds
Connected accounts
Connected accounts overviewOnboard connected accounts
KYC and onboarding
Handle KYC RFI
KYB and onboarding
Embedded KYB component
Onboard multiple connected accountsMove funds between accounts
Compliance and Outsourcing requirements
Error codes

Embedded KYB component

The Embedded KYB component is a pre-built UI element that lets your connected accounts to complete the KYB (Know Your Business) onboarding process to start receiving funds using the Airwallex payment gateway. Instead of building your own native onboarding flow, you can now deliver a conversion-optimized, frictionless onboarding experience that leverages the following features:

  • Dynamically take care of KYB and compliance via Airwallex’s UI
  • Leverage Airwallex’s conversion-optimized flow, including STP (Straight Through Processing) after submission
  • Customize the visual appearance to match the look and feel of your platform website
  • Tailor user interactions against the component's lifecycle

To view the onboarding experience offered by the Embedded KYB component, go to the Airwallex demo site .

This page describes how to embed the KYB component into your page to start onboarding connected accounts for payments acceptance.

KYB is only required if your connected accounts will be onboarded as Merchant-Of-Record, which depends on your payments gateway model of choice.

How it works

The diagram below depicts the information flow in an Embedded KYB component integration.

Embedded KYB component

Before you begin

  • Ensure your connected accounts have already applied for general onboarding (KYC) else you will receive errors when trying to access the KYB component.
  • Contact your Airwallex Account Manager to enable KYB onboarding using Embedded Components.
  • Depending on your Airwallex payment gateway model, provide your Account Manager with a list of payment methods you want to make available to your connected accounts.
  • Obtain your access token by authenticating to Airwallex using your unique Client ID and API key. You will need the access token to make API calls.
  • Explore the @airwallex/components-sdk JavaScript client library reference to familiarize yourself with the Embedded KYB component methods, parameters, and properties.
  • Install the package
    • Using Yarn or NPM
      • yarn add @airwallex/components-sdk
      • npm install @airwallex/components-sdk
    • Using CDN
      • <script src="https://static.airwallex.com/components/sdk/v1/index.js"></script>

Step 1: Create a connected account for KYB

Shell
Example request

Handle response and error logic. Make sure to save the account_id returned in the response.

Optionally, you can update the account by calling Update a connected account API to pre-fill the information.

Step 2: Initialize the components web SDK

First, you will need to import the components-sdk and then initialize the environment. For details, see Initialize components SDK .

Set up the server for authentication

When the end user, i.e., the connnected account holder, begins the onboarding process, you will need to get an authorization code to authorize them into the Embedded KYB workflow. Always get authorization code on the server side, a trusted environment. This prevents malicious users from being able to alter the scope.

When the onboarding page loads, on your server, call Authorize a connected account API by providing your Airwallex connected account id on the URL, and the following required fields in the request:

  • scope: Indicates the resources your application is allowed to access. For Embedded KYB payments onboarding, you must provide w:awx_action:kyb as the scope.

  • code_challenge: Generate a challenge token together with the code_verifier using the S256 generation method as described in RFC 7636 Section 4. code_challenge = BASE64URL-ENCODE(SHA256(ASCII(code_verifier))). Use a third-party package to generate code_verifier and code_challenge or use the following code example in Javascript.

JavaScript
JavaScript

The authorization_code is returned in the response, which you should then return to the client side as authCode in order to initialize the Embedded KYB component.

Step 3: Add the Embedded KYB component to your page

To embed the onboarding flow into your page, you will need to create an empty container, create the onboarding component and then mount the element to the container.

Define the KYB onboarding container

First, create an empty container div with a unique id in your payments KYB page. Airwallex inserts an iframe into this div on mounting the element.

Create the Embedded KYB component

To create the onboarding component, call createElement(type, options) and specify the type as kyc. This method creates an instance of an individual component. Components are rendered as iframes.

You can also pass options in createElement() to overwrite styles and other functions. All properties are optional. For details, see Onboarding component props .

JavaScript

To create the onboarding component, call createElement(type, options) and specify the type as paymentsKyb. This method creates an instance of an individual component. Components are rendered as iframes.

You can also pass options in createElement() to overwrite styles and other functions. All properties are optional. For details, see Create an Element .

JavaScript

Mount the element

Call element.mount() with the id of the div container to mount the element to the DOM. This builds an embedded onboarding workflow. The element should only be mounted once in a single onboarding flow.

JavaScript

For all the other methods supported on this component, see Element object methods .

Handle the ready event

Add the ‘ready’ event listener to ensure the KYB onboarding component is rendered. It's recommended that you show a loading state UI before receiving the ‘ready’ event. You can also use the user’s kybStatus result, which represents the account’s KYB onboarding status, and render different status pages accordingly.

JavaScript

Step 4: Handle the response

Add success and error event listeners to handle error and success events received from Airwallex.

JavaScript

If no error occurred, display a message that the onboarding was successful. If onboarding fails with an error, display the appropriate message to your end user so they can take action and try again. See KYB Element events .

See table below for the common error codes and recommended next steps.

Error codeError messageNext steps
INIT_ERRORNo <parameter> providedCheck the params table for required init options.
INIT_ERRORFailed to authorizeConfirm that the clientId, env, codeVerifier and authCode passed in the init() function are valid.
INIT_ERRORAuth timeoutPlease check if your network connection is stable. If so, please contact Airwallex support.
UNAUTHORIZEDFailed to refresh tokenThe refreshToken might be expired (currently 1 hour). Please redo the entire flow to get a new authCode and initialize the SDK, and then create the element again.
CREATE_ELEMENT_ERRORPlease init() before createElement()Please confirm you have correctly loaded the SDK script using the init() function from our package or the CDN link.
CREATE_ELEMENT_ERRORCreateElement with type <type> not supportedCheck the supported types .
MOUNT_ELEMENT_ERRORCannot find element with dom element id: <id>Please check if the container dom id or the dom element passed in the mount() function is valid.
PERMISSION_DENIEDUser does not have access permission.Account is not eligible to access Airwallex Online Payments. Please check that the account has applied for general onboarding (KYC). For further inquiries, please contact Airwallex support.
SUBMIT_FAILEDInternal API error: Failed to submit form.Please retry or contact Airwallex support.
UNKNOWNUnknown errorPlease retry or contact Airwallex support.
API_ERROR<API_name> API errorError occurred when calling internal API. Please retry or contact Airwallex support.
- (Console message only)Please initialize Airwallex platform onboarding SDKPlease confirm if you have correctly loaded the SDK script using the init() function from our package or the CDN link.

Test your integration

You may test your integration for various success and error scenarios in the demo environment and then go live in the production environment. Contact your Airwallex Account Manager for test account details.

To trigger SDK errors during testing, use these instructions.

Error CodeHow to trigger
INIT_ERRORCall init() function with unsupported values for options, e.g., await init({env: 'other'}) where other is not supported
UNAUTHORIZEDInternal error, unable to trigger
AUTH_TIMEOUTBlock your network
CREATE_ELEMENT_ERRORCall createElement() function with unsupported element type, e.g., createElement('wrong_type')
MOUNT_ELEMENT_ERRORCall mount() method with a non-existent div id. e.g., element.mount('nonexistent-div-id')
SUBMIT_FAILEDInternal error, unable to trigger
UNKNOWNInternal error, unable to trigger
API_ERRORBlock your network

FAQ

How do I customize the embedded component?

Contact your Airwallex Account Manager to enable customization of the look and feel in line with your brand. Your Account Manager will assist you in generating a theme schema, which can be passed into the component upon initialization.

The theme schema includes:

  • Colors: You can recolor the component by specifying a set of 10 colors which makes up a color gradient. The colors can be in one or multiple tones.
  • Component-level configuration
  • Typography
JavaScript

How do I handle re-tries?

If a user exits the onboarding component then tries to re-enter the details later, you can handle re-entry based on the user’s onboarding status. Use kybStatus from the ‘ready’ event fired when the component is rendered (see Handle the ready event).

  • INIT status: The user will re-enter the onboarding workflow again, and automatically be taken to where they last left off.
  • PENDING_REVIEW/IN_REVIEW/ACCEPTED/REJECTED status: The account has already completed the onboarding workflow. You should render different status pages according to the kybStatus result. If you do not handle it, we will show default submitted/success/failure pages accordingly.
JavaScript
On this page