Skip to main content

Hosted Onboarding

NOAH Hosted Onboarding streamlines compliance for non-licensed payment providers operating in Standard Model KYC scenarios. Through this solution, NOAH establishes direct contractual relationships with your end customers, handling all KYB/KYC verification and Terms and Conditions acceptance on your behalf.

This approach allows you to leverage NOAH's comprehensive compliance and regulatory frameworks to facilitate secure payments without the complexity of managing regulatory requirements yourself, creating a seamless experience for both you and your customers.

1. Initiate a Hosted Onboarding Session

Submit a POST request to start a Hosted Onboarding session.

curl -L 'https://api.sandbox.noah.com/v1/customers/hosted-onboarding' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Api-Key: <X-Api-Key>' \
-d '{
  "CustomerID": "550e8400-e29b-41d4-a716-446655440000",
  "ReturnURL": "https://example.com"
}'

As can be seen above, in your request, include your API Key in the header along with a CustomerID and the URL to which the user is redirected at the end of the Hosted Onboarding session.

note

NOAH expects a full ReturnURL value, including the https://.

View the API Reference for Hosted Onboarding for detailed instructions on initiating a session.

The response will consist of a HostedURL, where the Hosted Onboarding session is ready for the customer to enter their details:

{"HostedURL":"https://checkout.sandbox.noah.com/kyc?session=xyz"}
2. Direct the Customer to Hosted Onboarding

Redirect your customer to the HostedURL to enter their details in the Hosted Onboarding session.

3. Customer Status Updates via Webhooks

Set up to receive notifications through webhooks about the status of the Hosted Onboarding session, which can be Pending, Approved, or Declined.

For more details, see Customer Webhooks.

4. Close the Hosted Onboarding Session

NOAH emits a postMessage once the onboarding process is complete. You can listen to this event in your application, as follows:

window.addEventListener('message', (event) => {
  if (event.data?.type === 'kycCompleted') {
    closeHostedSession(); // <-- Replace this with platform-specific close method
  }
});
tip
  • The message sent is: { type: 'kycCompleted' }
  • It is sent once a valid KYC review status is detected.