Native KYC RFI API
Learn how to use Airwallex's RFI API endpoints to build your own tailored experience for users to handle additional requests for information (RFI).
Before you begin
- Contact your Airwallex Account Manager to enable connected account KYC RFI using Native API.
- 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.
- You must be integrated to use Airwallex native API for all other funds flow and payments control.
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.
JSON
Payload
Option 2: Query the RFI status via API
Call List all RFIs API to get a list of all open RFIs across your accounts.
Shell
Example request
JSON
Example response
Step 2: Retrieve the RFI details
Call Retrieve an RFI API to retrieve the details of an RFI using the given RFI ID.
Shell
Example request
JSON
Example response
Step 3: Respond to the RFI
Call Respond to an RFI API to provide the additional information requested by Airwallex.
Shell
Example request
Step 4: Handle response
Listen for status changes to the connected account and RFI via webhooks. See connected account events and RFI events.
Error handling
| Error code | Message | Next steps |
|---|---|---|
invalid_state_for_operation | - | Make sure the RFI status is ACTION_REQUIRED |
account_not_authorised_for_operation | - | Make sure the RFI is linked to the correct account |
resource_not_found | - | Make sure you are using the correct RFI ID when querying |
invalid_argument | Please answer all questions in the request/ Please provide your answers in the right format (TEXT vs ATTACHMENT) | Make sure all the RFI questions are answered / and in the right format |