UK onboarding

Overview

This page contains details about the United Kingdom Know Your Business (KYB) flows and links to the following sub-pages for a quick reference:

Nium offers eKYB and Manual KYB flows for customers in the United Kingdom.

The eKYB flow is fully automated, allowing corporate customers to be approved within a few minutes of submitting their application, making it the preferred mode for all customers. Reach out to Nium's sales team to configure the eKYB flow for your account.

eKYB flow

The following steps are required to complete the eKYB application.

Step 1. Get Public Corporate Details Using Business ID API

To start the eKYB process, collect the basic details about the corporate customer from the applicant through an onboarding form, including the businessRegistrationNumber and countryCode. For a list of valid country codes, see Currency and country codes. Then, call Nium's Public Corporate Details Using Business ID API.

This API returns publicly available information about the corporate customer, which you then display to the customer so they can select and confirm the businessName and businessRegistrationNumber along with any other optional details.

You need to store the searchReferenceId that's returned in this response since it's required in subsequent steps.

This API may return multiple results for a given businessRegistrationNumber. When there's more than one, display the results to let the customer select the correct one.

When no results are returned, call the Onboard Corporate Customer API with a full request body. Such applications go through manual review, making the eKYB process not applicable in this case.

Step 2. Get Exhaustive Corporate Details Using Business ID API

Call the Exhaustive Corporate Details Using Business ID API using the searchReferenceId stored in Step 1 as the parameter.

This returns the public and non-public information about the corporate customer.

You need to store the searchId that's returned in this response since it's required in the subsequent steps.

⚠️

CAUTION

This is a chargeable API. Work with your Nium representative before using it. It's best to use this API only once per customer.

Step 3. Display the information to the applicant

You need to display the above-received information to the applicant for their confirmation, edits, or additions. Then, submit the form. All the fields required to call the Onboard Corporate Customer API are collected in this step. Any additional fields that are required, and not returned in the above step, are to be added by the applicant.

Step 4. Post Onboard Corporate Customer API

You then call the Onboard Corporate Customer API with the full request body, including the searchId you stored in Step 2.

If the searchId parameter isn't passed, the application is treated as MANUAL_KYB and goes through a manual review.

Applicant KYC

As a response to the Onboard Corporate Customer API, Nium returns a redirect URL. You need to save this URL and redirect the applicant to the redirectURL. The applicant then lands on the KYC vendor's page, where he can complete the KYC verification by uploading his proof of identity and proof of address documents with a live selfie. After that, applicants are redirected back to your client KYC redirect URL that was configured with Nium. You need to show the success or failure message to the applicant once redirected back. You need to pass E_DOC_VERIFY as businessDetails.applicantDetails.kycMode for all applications.

Redirection can result in the following scenarios, based on the below parameters.

• errorCode
• errorMessage
• isSuccess – This field indicates if the applicant completed the required steps in the vendor’s UI. It doesn't mean KYC is successful.

Based on the scenario, you can implement the next steps as provided in the table above.

Example of a redirect to the client in a successful case

https://www.clientRedirectURL.com/?clientId=NIM1681898211881&caseId=4ff53849-3d30-45c8-af11-

f95c315ce83c&isSucces=true&errorCode=&errorMessage=

Example of a redirect to the client in a failed case

https://www.clientRedirectURL.com/?clientId=NIM1681898211881&caseId=4ff53849-3d30-45c8-af11-

f95c315ce83c&errorCode=R408&errorMessage=redirectURLExpired&isSucces=false

For applicants where the businessDetails.applicantDetails.address.country is US, the applicant's address' state needs to be a valid 2 letter state code. Use Fetch corporate constants API for acceptable values.

⚠️

CAUTION

There's an expiration time for the redirectURL and the applicant needs to complete the process shortly after submitting the application.

If the URL expires, the applicant is redirected to your configured client KYC redirect URL with an error message. Use the Regenerate KYC URL API to get a new URL with a new expiration time.

Stakeholder KYC

For the eKYB flow, E_KYC and MANUAL_KYC modes are offered for KYC of individual stakeholders. You're required to pass E_KYC for UK residents or MANUAL_KYC for non-UK residents in businessDetails.applicantDetails.kycMode. The kycMode is required only when the position of the individual stakeholder is UBO, DIRECTOR, TRUSTEE, PARTNER, or MEMBER and can be ignored for other positions.

Applications with MANUAL_KYC go through manual review and cannot be verified in real-time.

Uploading of documents is mandatory for MANUAL_KYC, which needs to be sent in businessDetails.applicantDetails.documentDetails. For details, see UK required documents.

Upload documents, if required

If searchId isn't passed, a document upload is required. Even if searchId is passed, some documents might be required in certain scenarios. Nium doesn't initiate verification until all required documents are submitted.

All required documents can be submitted in two ways:

• Upload Document API.
• Onboard Corporate Customer API

The Upload Document API is preferred since it uploads one document at a time, which reduces the loading time. This API can be called only while the application is in the IN_PROGRESS state.

You can use the remarks field to list which documents Nium is expects in the response of both APIs.

⚠️

CAUTION

The API gateway has a limit of 10 MB for any API request. This makes Upload Document API the preferred way to upload documents since you can upload one document at a time.

For the entire list of required documents for manual and eKYB flows, see UK required documents.

Terms and Conditions

You must show customers the Nium terms and conditions configured for your client resource. You can fetch these specific terms and conditions using our Terms And Conditions API.

Customers can only submit the onboarding form once they accept the terms and conditions.

To fetch the Terms And Conditions API:

1. Wait for the Onboarding API to return a customerHashId.
2. Once returned, call our Accept Terms and Conditions API and include the customerHashId.
3. Show the customer the returned terms and conditions and record their acceptance before allowing them to transact.

For more details, see Terms and Conditions.

Step 5. Wait for webhook response

After submission, the status in the Onboard Corporate Customer response is IN_PROGRESS. The applicant needs to complete both the Applicant KYC and Upload documents steps to proceed further. Once done, Nium initiates real-time verification and sends the response via a webhook.

The application might be approved at this stage; and if it isn't approved, the application goes through a manual review. Any changes in the status is again communicated via a webhook. For the next steps based on the response of the webhook, see Webhooks.

Manual KYB flow

For manual KYB, you need to call the Onboard Corporate Customer API directly. In this flow, the entire request body needs to be passed in the Onboard Corporate Customer API.

Important points to keep in mind:

• Nium doesn't initiate verification until all required documents are submitted.
• You need to pass E_DOC_VERIFY as businessDetails.applicantDetails.kycMode for all applications. For details on implementing E_DOC_VERIFY, see Applicant KYC.
• The applicant is required to complete the KYC process using the redirect link via Nium's vendor Onfido.
• You need to pass only MANUAL_KYC as businessDetails.stakeholders.stakeholderDetails.kycMode for KYC of individual stakeholders. kycMode is required only when the position of the individual stakeholder is UBO/ DIRECTOR/ TRUSTEE/ PARTNER/ MEMBER. Uploading of documents is required for manual KYC, which needs to be sent in businessDetails.stakeholder.stakeholderDetails.documentDetails. For details, see Stakeholder documents
• Terms and Conditions flow is same mentioned in the eKYB flow.

After the submission, the status in the response of the Onboard Corporate Customer API is IN_PROGRESS. Once documents are uploaded and the KYC process completes, Nium initiates manual verification and sends the response via a webhook. For the next steps based on the response of the webhook, see Webhooks.