Embedded KYC RFI component
In some cases, Airwallex may request additional information from end users if the information initially provided during KYC is deemed insufficient to approve the application. The Embedded KYC RFI component is a pre-built UI element that lets your clients provide this information with a single integration. Instead of building your own native flow, you can embed Airwallex’s information request flow directly in your own onboarding experience.
Airwallex's embedded RFI form will display our operation team’s additional questions and collect the answers. You can also customize the visual appearance of the form to reflect your brand.
To view the RFI experience offered by the Embedded KYC RFI component, go to the Airwallex demo site .
This page describes how to embed the KYC RFI component into your page to finish onboarding connected accounts.
How it works
The diagram below depicts the information flow in an Embedded KYC RFI component integration.
Before you begin
- Contact your Airwallex Account Manager to enable the required RFI using Embedded Components.
- Obtain your access token API 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-sdkJavaScript client library reference to familiarize yourself with the Embedded Component methods, parameters, and properties. - Install the package
- Using Yarn or NPM
yarn add @airwallex/components-sdknpm install @airwallex/components-sdk
- Using CDN
<script src="https://static.airwallex.com/components/sdk/v1/index.js"></script>
- Using Yarn or NPM
Step 1: Get notified of the information request (RFI)
You can receive RFI notification via the following two methods:
Option 1: RFI webhook notification
Subscribe to our RFI webhook to be notified when your account or one of your connected accounts receives a request for information.
Option 2: Query the RFI status via API
Call List all RFIs API to get a list of all open RFIs across your connected accounts. If open RFIs are available, initialize the KYC RFI component SDK.
Step 2: Initialize the components web SDK based on the RFI type
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 user begins the RFI process, you will need to get an authorization code to authorize them into the Embedded RFI 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 RFI page loads, on your server, call Authorize an account API by providing your 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 RFI regardless of the type, you must provider:awx_action:rfi_view,w:awx_action:rfi_editas the scope.code_challenge: Generate a challenge token together with thecode_verifierusing 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 generatecode_verifierandcode_challengeor use the following code example in 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 RFI component.
Step 3: Add the Embedded KYC RFI component to your page
To embed the KYC RFI flow into your page, you will need to create an empty container, create the KYC RFI component and then mount the element to the container.
Define the KYC RFI container
First, create an empty container div with a unique id in your KYC RFI page. Airwallex inserts an iframe into this div on mounting the element.
Create the Embedded KYC RFI component
To create the KYC RFI component, call createElement(type, options) and specify the type as kycRfi. 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 KYC RFI component props .
Mount the element
Call element.mount() with the id of the div container to mount the element to the DOM. This builds an embedded KYC RFI workflow. The element should only be mounted once in a single onboarding flow.
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 KYC RFI component is rendered. It's recommended that you show a loading state UI before receiving the ‘ready’ event.
Step 4: Handle the response
Add success and error event listeners to handle error and success events received from Airwallex.
If no error occurred, display a message that the RFI was successful. If the RFI component fails with an error, display the appropriate message to your end user so they can take action and try again. See RFI Element events .
See table below for the common error codes and recommended next steps.
| Error code | Error message | Next steps |
|---|---|---|
| INIT_ERROR | No <parameter> provided | Check the params table for required init options. |
| INIT_ERROR | Failed to authorize | Confirm that the clientId, env, codeVerifier and authCode passed in the init() function are valid. |
| INIT_ERROR | Auth timeout | Please check if your network connection is stable. If so, please contact Airwallex support. |
| UNAUTHORIZED | Failed to refresh token | The 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_ERROR | Please 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_ERROR | CreateElement with type <type> not supported | Check the supported types |
| MOUNT_ELEMENT_ERROR | Cannot 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. |
| SUBMIT_FAILED | Internal API error: Failed to submit form. | Please retry or contact Airwallex support. |
| UNKNOWN | Unknown error | Please retry or contact Airwallex support. |
| API_ERROR | <API_name> API error | Error occurred when calling internal API. Please retry or contact Airwallex support. |
| INVALID_KYC_STATUS | Invalid KYC status: <kycStatus> | Error occurred as account kycStatus is INIT or FAILURE, which is invalid for the user to enter the KYC RFI flow |
| INVALID_RFI_STATUS | Invalid RFI status: NO_ACTION_REQUIRED. No RFI session available | Error occurred when there’s no open KYC RFI. |
| - (Console message only) | Please initialize Airwallex platform SDK | Please 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 Code | How to trigger |
|---|---|
| INIT_ERROR | Call init() function with unsupported values for options, e.g., await init({env: 'other'}) where other is not supported |
| UNAUTHORIZED | Internal error, unable to trigger |
| AUTH_TIMEOUT | Block your network |
| CREATE_ELEMENT_ERROR | Call createElement() function with unsupported element type, e.g., createElement('wrong_type') |
| MOUNT_ELEMENT_ERROR | Call mount() method with a non-existent div id. e.g., element.mount('nonexistent-div-id') |
| SUBMIT_FAILED | Internal error, unable to trigger |
| UNKNOWN | Internal error, unable to trigger |
| INVALID_RFI_STATUS | Create RFI component for an account, which does not have any open RFI |
| INVALID_KYC_STATUS | Create KYC RFI component for a connected account with kycStatus of INIT or FAILURE |
Example integrations
Explore a full, working code sample of an integration built using React .
FAQ
How do I customize the Embedded RFI component?
We can configure the RFI component to reflect your brand’s color palette and logo. Contact your Airwallex Account Manager to enable customization in line with your business requirements.
How do I handle re-entry?
If a user exits the RFI component then tries to re-enter the details later, you can handle re-entry based on ready and error events.
readyevent: An open RFI is available and the user can enter the flow.errorevent: Some error scenarios include:INVALID_RFI_STATUS: There’s no open RFI for this account.INVALID_KYC_STATUS: The account'skycStatusisINITorFAILURE, which is invalid for the user to enter the KYC RFI flow.
You should render error/status pages according to the event result. If you do not handle it, we will show the default status page with "You have no outstanding actions required".