Testing onboarding

Testing onboarding is how you create a sandbox customer with Customer Onboarding v5 and confirm the result. You can approve the customer for another test, or walk through a request for information (RFI).

Use the approved customer for payout, payin, and other scenarios. Use the RFI flow to confirm your app can read an RFI, submit the answer, and handle the decision.

The same requests cover an individual customer and a corporate customer. Take the request body from the regional page. See Customer Onboarding.

Call Get Customer v5 after each step. Read status and subStatus, then take the next step. In production, your app uses the customer status webhook for the same changes.

For simulation actions, see Simulate v5 onboarding status. For the RFI contract, see RFI v5 flow.

important

The onboarding simulation API works in the sandbox only.

Prerequisites

Before you test, confirm the following:

• You can authenticate. See Key concepts and Authentication.
• You have a clientHashId and an x-api-key from client configuration.

Approve customer

Use this flow when you need a customer with status clear for another test.

Create customer and complete KYC

Step	Request	What you do
1	Create Customer v5	Open the regional page under Customer Onboarding. Send the request for an individual or a corporate customer. Use your own test name, email address, and phone number.
2	Get Customer v5	Confirm subStatus is awaiting_kyc.
3	Submit KYC	Submit Know Your Customer (KYC) for the customer. For a corporate customer, submit it for the applicant and for each individual stakeholder. See Submit KYC.
4	Get Customer v5	Confirm subStatus is under_review.

These steps use Submit KYC. Use the pre-built KYC form for step 3 when you want to test the form.

Set status to clear

Set nextAction to clear only when subStatus is under_review. The customer needs the KYC result on file before you use them in a payout or payin test.

Step	Request	What you do
5	Simulate v5 onboarding status	Set nextAction to clear.
6	Get Customer v5	Confirm status is clear.

After status is clear, use this customer for payout, payin, and other scenarios. In this flow, step 5 stands in for the compliance team's approval.

Request information

Use this flow when you need to rehearse onboarding, including an RFI.

Follow Create customer and complete KYC. Stop when subStatus is under_review.

Raise RFI

Step	Request	What you do
1	Simulate v5 onboarding status	Set nextAction to raise_rfi. Set requestInfoFor when you need a specific document. See Simulate v5 onboarding status.
2	Get Customer v5	Confirm subStatus is rfi_requested.
3	Fetch RFI Details	Set rfiEntity to ONBOARDING. Read the information Nium is requesting.
4	Respond to RFI	Submit the answer.
5	Get Customer v5	Confirm subStatus is under_review.

These steps use Respond to RFI. Use the RFI form for step 4 when you want to test the form.

Apply decision

under_review means the next action belongs to Nium. In the sandbox, you take that action with the simulation API.

Step	Request	What you do
6	Simulate v5 onboarding status	Set nextAction to clear. Use reject when you want status rejected.
7	Get Customer v5	Confirm status is clear, or rejected when you chose reject.

In this flow, raise_rfi and the final clear or reject stand in for the compliance team. You still complete KYC and answer the RFI yourself.