Get API Keys

Using the sandbox

Introduction

As part of onboarding, you need to submit data and documents for your business, your business stakeholders, and your applicants via the Onboard Corporate Customer API. After you receive a response with status='IN_PROGRESS', your customer needs to check for any additional required documents in the remarks field, such as a redirect URL for applicant KYC. After all required data and documents are submitted, Nium initiates verification, and the application status changes to ACTION_REQUIRED, COMPLETED, or REJECTED which is communicated via webhook, detailed in Onboard API response.

Nium’s sandbox allows you to simulate the below scenarios for onboarding a corporate customer by using the appropriate businessRegistrationNumber and Request examples.

Scenario 1: Auto Approval

All documents and information required for completing the verification process are provided in the Onboard Corporate Customer API. The application is approved in real-time (within a few minutes) and you should receive a webhook with status='COMPLETED'. This is applicable only for the eKYB flow.

Scenario 2: Action Required

All documents and information required are provided in the Onboard Corporate Customer API, but the application was not auto-approved and needs to be manually reviewed by Nium's compliance team. You should receive a webhook with status='ACTION_REQUIRED' . Once received, you should wait for the next webhook which will be received after the compliance agents complete the manual review.

Scenario 3: In Progress (with required documents)

All information required for completing the verification process is provided in the Onboard Corporate Customer API, however some of the required documents are not submitted. The customer is expected to submit all the required documents after which Nium will initiate the verification. In this case, you need to receive the documents required in the remarks field.

Scenario 4: In Progress (with redirection link)

All information required for completing the verification process is provided in the Onboard Corporate Customer API, however the applicant is required to complete the KYC using the redirect URL received using the Onboard Corporate Customer API. You can direct the applicant to the redirect URL so the applicant can complete KYC on the vendor's portal.

Generating mock scenarios

  • mock scenarios for AU
  • mock scenarios for EU
  • mock scenarios for SG
  • mock scenarios for UK
  • mock scenarios for US

Example responses for Exhaustive Corporate Details API

The Nium sandbox allows you to fetch multiple responses in the Exhaustive Corporate Details using Business ID API by providing different business registration numbers. For details, see your region's example response.

Updated 23 days ago