Onboarding

In addition to the Nium API, you can also use our pre-built Onboarding Form to onboard customers onto Nium.

Onboarding Forms are secure, Nium-hosted, web forms that guide customers through submitting their data and the required KYB (Know your Business) and compliance steps.

This form is helpful for clients that:

• Want to go live fast
• Have limited engineering resources
• Want Nium to handle most of the onboarding experiences and compliance flows
• Plan to expand into multiple countries without rebuilding forms or flows

For more information about onboarding customers using Nium, see Onboarding.

Overview

To onboard customers on to Nium using Onboarding Forms, clients:

1. Invite the customer they plan to onboard by sending the customer a link to the relevant Onboarding Form.
2. The customer completes the Pre-built Onboarding Form.
3. Nium handles the verification of details and compliance requirements.
4. Clients track the progress and outcomes of forms using webhooks and the Nium API.

Key features

Onboarding Forms are built with regional regulatory requirements in mind, helping customers submit accurate information the first time.

Nium maintains and manages the experience of the form, requirement checks, and regulatory alignment, while you only need to track the progress of customers and outcomes.

You can also customize the form with your branding to maintain a consistent customer experience. Please note, color and font customization are not available at this time.

Other benefits of using pre-built Onboarding Forms include:

• Opportunities to include your branding in the onboarding experience
• Secure links to Onboarding Forms that can expire
• Email-based, one-time password verification
• Save-and-resume progress
• Review and confirm details before submission
• Integrated KYB and KYC flows
• End-to-end progress tracking

Responsibilities

Feature	Client	Nium
Invite Customers	X
Branding and Logo	X
Form experience & requirements		X
KYB/KYC execution		X
Compliance decisions		X
Application tracking	X

Creating Onboarding Forms

The following shows the steps clients follow to onboard customers using Nium's pre-built Onboarding Forms.

Step 1: Request access

Contact your Nium account manager or Nium Support to enable and customize Pre-built Forms for your account.

The logo you provide during this initial setup appears at the top left corner of the form.

Step 2: Setup Webhooks

Integrate with the Customer Status event to track status updates for the application. Use the externalID to listen for status changes. For more info on the status Webhook Check - xxx

Step 3: Create a Session

Use the Create a Session request to generate a sessionId. The sessionId securely binds the customer's session to Nium's hosted component.

Request example

curl --location --globoff 'https://gateway.nium.com/api/v1/client/{clientHashId}/sessions' \
--header 'Content-Type: application/json' \
--header 'x-api-key: {x-api-key}' \
--data '{
    "featureType": "string",  
    "clientHashId": "string",    
    "integrationType": "string",
    "expiry": "date-time",
    "externalId":"string",
    "rollingDurationMinutes": "long",    
    "onBehalf": "boolean",
    "email": "email"
}'

Field	Type	Description	Values
featureType	String	Type of form to generate.	customer_onboarding_form
clientHashId	String	The unique client identifier.
externalId	String	The unique identifier of the customer.
integrationType	String	Defines where the form opens. • Use embedded to display it in your portal or dashboard. • Use standalone to open it in a new browser tab.	embedded, standalone
expiry	String	The date and time the form will expire. If the form expires, create a new sessionId.	ISO-8601 date-time format: yyyy-MM-dd'T'HH:mm:ssXXX
rollingDurationMinutes	String	How much time can pass before the form expires due to inactivity.	• Minimum value: 1 • Whole number representing minutes
domain	String	Domain where the form is embedded when using the embedded integration type.	• Required for embedded forms • Must match the session domain
onBehalf	Boolean
email	email	Email ID of the applicant where OTP needs to be sent.

Successful response

{
    "sessionId": "e40e8072-7654-474b-ae31-c21a39c206ec",
    "externalId": "String",
    "featureType": "customer_onboarding_form",
    "metadata": {
        "integrationType": "standalone",
        "onBehalf": false,
        "email": "emailID",
        "clientHashId": "a8734b87-f6e6-4fe1-95ed-b41a00104f64"
    },
    "status": "active"
}

Pass the sessionId to the static Pre-built Onboarding Form URL:

• Production: https://nformify.nium.com/customers/initial-enquiry?sessionId=
• Sandbox URL: https://nformify-preprod.nium.com/customers/initial-enquiry?sessionId=

Embed or send this link to the customer to start onboarding.

Step 3: Verify the customer

Nium sends an OTP to the customer's email, which they click the above link to access the Onboarding Form.

Step 4: Submit the application

To complete and submit the Onboarding Form, the customer must provide key business and personal information within the form. The customer applicant must complete the following actions:

1. Confirm business information: Applicants review and confirm the corporate customer's business name and registration number, as provided by the client.
2. Verify business details: Nium auto-fills the form with business and stakeholder information. Applicants confirm these details and upload any necessary documents.
3. Enter stakeholder information: The applicant must complete the details for Ultimate Beneficial Owners (UBOs), shareholders, directors, and other key stakeholders (such as signatories), as listed in the business registration document. The applicant must also upload any required supporting documents.
4. Provide applicant information: If the applicant is not one of the previously mentioned stakeholders, they must add their personal information to the form.
5. Review and accept terms: The applicant reviews the entered details, accepts the terms and conditions, and submits the form.
6. Complete KYC verification: KYC needs to be completed for all the stakeholders, applicants etc.. In certain regions, verification is automatically performed via database verification, with no further action required from the applicant.

Step 4.2: Complete Requests for Information

Our compliance team will review the customer's submitted application. Progress is communicated via webhooks. Nium's compliance team may issue a Request for Information (RFI) if they need any additional data to approve the customer's application.

Check RFI hosted forms to see if any RFI is raised. Provide your customers the relevant hosted RFI Form to help them respond to the RFI.

The review process is complete once all RFIs are complete and the application status updates to Clear. After the update, the customer can start initiating transactions.

Next steps

To ensure a smooth onboarding process for your corporate customers, please reach out to your Nium account manager or contact Nium Support to confirm if any additional information or steps are required.

Once everything is confirmed, the Nium team will help you configure your payment experience and finalizing the setup to process transactions for your customers.