Using the Sandbox
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 | Description |
|---|---|
| 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 then you receive a webhook with status='COMPLETED'. This is applicable only for the eKYB flow. |
| 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 receive a webhook with status='ACTION_REQUIRED' . Once received, wait for the next webhook which will be sent after the compliance agent completes the manual review. |
| In Progress with documents required | 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 initiates the verification. In this case, you need to receive the documents required in the remarks field. |
| 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. |
Simulate various scenarios
- Example requests - AU
- Example requests - CA
- Example requests - EU
- Example requests - HK
- Example requests - SG
- Example requests - UK
- Example requests - US
Response examples 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.