Quickstart: Corporate Customer
To onboard your businesses, referred to as the program client, follow the steps below summarized in this diagram.
The term corporate customers includes:
- Small and medium enterprises (SMEs)
Onboarding process flow
To understand the onboarding process end to end, refer to the following diagram:
Ask all your corporate customers to go through the Nium One platform know-your-business (KYB) process. Nium supports the following countries:
- Hong Kong
- United Kingdom
- United States
Nium offers a set of APIs to facilitate the KYB process and supports the following two KYB flows:
To start the eKYB process, the Nium program client first calls the Public Corporate Details Using Business ID API using the business registration number and the country code as parameters.
This returns publicly available information about the business that needs to be onboarded under the Nium client program. It shows the business information to the person trying to onboard the business or corporation for verification.
2. Exhaustive corp details API
The Nium client calls the Exhaustive Corporate Details Using Business ID API using the business registration number in step 1 as the parameter.
When this API is called with the business registration number, it returns all the public and non-public information about the business entity along with an important parameter called
3. Display information to the applicant
The client now displays this information to the person trying to onboard the business in an editable form.
You then call the Onboard Corporate Customer API and pass all the parameters exactly as received in the Exhaustive Corporate Details using Business ID API, including the
For EU and UK, it's mandatory to call the Onboard Corporate Customer API with the
For AU, you may choose to either:
- Directly call the Onboard Corporate Customer API and fill in all the details.
- Call the Public Corporate Details using Business ID API and fetch details before calling the Onboard Corporate Customer API.
Once you call the Onboard Corporate CustomerAPI, the system first checks if the corporate customer already exists.
- If it does, the system throws an error and the client needs to restart the process with the correct details.
- If not, a new
CORPORATEtype customer is created with the
caseIdparameters. Compliance is then initiated for the new customer.
In this case, the
customerHashIdparameter refers to the corporate customer which has been onboarded.
In response to the Onboard Corporate Customer API, Nium provides the
clientId parameter of the newly created corporate customer along with the
caseId parameter. This
caseId may be used to further track the corporate customer's KYB process.
For EU, you need to also receive the redirect URL for Onfido. With the EU scenario, after receiving the redirect URL in the response, you need to redirect the person trying to onboard the business entity to the given URL. That person needs to visit the provided Onfido redirect URL and complete the process by uploading the required documents. This step is required to verify the identity of the person attempting to onboard the business. Nium redirects the corporate customer to the pre-configured client redirect URL after receiving a response from Onfido.
In cases when there's no redirect URL, you need to show an acknowledgment to the corporate customer.
If the provided information is sufficient and the KYB is initiated, the card client KYB status webhook has the compliance status as
If more information is needed, you can raise a request-for-information (RFI) and the status becomes
If you receive
RFI_REQUESTED as the compliance status in the card client KYB status webhook:
- Use the Fetch Corporate Customer RFI Details API and fetch the RFI details, including the
- Use the response to the Respond to RFI for Corporate Customer API with all the required fields for which RFI is raised.
After the completion of the KYB process, the compliance status is updated to
COMPLETED. All changes in the KYB status are communicated through the card client KYB status webhook.
5. KYB initiated
Based on the above information, the eKYB flow is initiated at Nium. If there's any missing information, the KYB isn't cleared automatically, and the manual review flow is triggered when the review is done by Nium's compliance team.
Manual KYB flow
When the eKYB flow has some missing information, it may need review by Nium's compliance team. The Compliance team may choose any of the following:
- Clear the KYB.
- Reject it. This is rare.
- Raise an RFI to collect any additional information needed.
Regulatory region notes
In SG, EU, and UK
If the Onboard Corporate Customer API is called without the
searchId parameter, which you get by calling the Exhaustive Corporate Details using Business ID API, Nium processes the customer onboarding manually.
If the eKYB process requires manual intervention and approval, then the onboarding goes through manual review and approval.
For AU-based corporate customer onboarding, Nium doesn't support the option to retrieve exhaustive customer details and therefore it's not possible to have the
searchId parameter. So, Nium clients have only one option: to call the Onboard Corporate Customer API to trigger the corporate customer onboarding, without sending the
f this eKYB flow fails, then the onboarding goes through the manual review and approval.
For US, Nium clients have only one option: to call the Onboard Corporate Customer API to trigger the corporate customer onboarding without sending the
For manual KYB, the clients need to submit the necessary documents for manual verification purposes by the Nium compliance team. These documents can be submitted using the Upload Document API as many times as needed, so clients don't need to pass all required documents together in one API call.
Clients should pass the
referenceId parameter for the business, stakeholder, or applicant in the API for correlating the documents with the onboarding application submitted earlier. Clients can refer to the Customer Details API to know about the
referenceId of Business, stakeholder, or applicant.
Nium only initiates the manual KYB verification process after all the required documents are submitted.
Acknowledgement from Nium
Once the onboarding application is submitted by the Onboard Corporate Customer API, the client is informed about the new
CORPORATE type customer creation with
caseId. Thes information is shared in the API response. The clients can show an acknowledgment to the corporate customer accordingly. The
clientId fields are required for further tracking the corporate customer KYB.
If the customer already exists or if there's any validation error due to incorrect input, then an error message is returned as part of the Onboard Corporate Customer API. The client needs to resubmit the process with the correct details.
Note that during the corporate customer onboarding process, the
customerHashIdrefers to the corporate customer onboarded to Nium.
Once the KYB process is completed, the compliance status is updated to COMPLETED and the client is notified by the webhook from Nium.
EU applicant identity verification
For EU, a redirect URL from Onfido is returned as part of the Onboard Corporate Customer API response. Clients need to redirect the applicant to the given redirect URL so that they can complete their identity verification in the same flow.
Nium provides an option to resubmit the onboarding application in case the application is rejected on its first attempt. The client can use the same Onboard Corporate Customer API to resubmit the onboarding application. Clients need to pass the unique customer identifier, for example,
customerHashId. The unique customer identifier is returned as part of the Onboard Corporate Customer API response. The ID comes from the previous onboarding attempt in the new API request. The request reinitiates the corporate customer onboarding process.
Request for information
When the eKYB or manual KYB flow has some missing information, it may need a review by the Nium compliance team. The compliance team may either clear the KYB or reject it, which is rare. It may also raise an RFI to collect additional information needed.
The RFI flow comprises of the clients receiving
RFI_REQUESTED as the compliance status in the card client KYB status webhook. The client needs to call the Fetch Corporate Customer RFI Details API and fetch the details of the request from the compliance team.
The Respond to RFI for Corporate Customer API should be used to respond to all required fields for which the RFI is raised.
Notification by webhooks
Clients are notified whenever there's any change in the compliance status in the compliance life cycle of the corporate customer's information. The Card Client KYB Status webhook is used to notify the clients for that purpose.
The following are some examples of business events that this webhook notifies the clients of:
- The onboarding application is automatically approved or reviewed and approved by the Nium compliance team and the compliance status is
- The onboarding application is reviewed and rejected by the NIUM compliance team and the compliance status is
- An RFI request is raised by the Nium compliance team and the compliance status is
Refer to the Overview of Webhooks to know more about the webhook feature that Nium offers.
Other implementation notes
- As part of this flow, Nium needs to ask the person attempting to onboard the business for a business registration number and call the [Public Corporate Details Using Business ID] API (ref:publiccorporatedetailsusingbusinessid) to fetch the data available in the public domain.
- This API is free.
- This API supports AU, EU, and UK.
- To initiate the eKYB process, using the business ID as fetched above, the Nium client needs to call the Exhaustive Corporate Details Using Business ID API and pre-populate a form for the corporation to verify its identify.
- This API is a chargeable API.
- This API supports EU and UK.
AU-based clients have two choices:
- Use the Public Corporate Details Using Business ID API and fill in any other details as required before calling the Onboard Corporate Customer API.
- Directly call the Onboard Corporate Customer API with the required data.
For EU, a
redirectUrlis expected and the client needs to redirect the applicant to the provided link. Nium can redirect the customer back to the client page based on the redirect URL configured for the client.
To understand the Exhaustive Corporate Details Using Business ID API process end to end, refer to the following diagram:
Updated 11 days ago