Token Share Onboarding

Overview

Token share onboarding enables you to share pre-existing KYC data for a customer's onboarding session using Sumsub token sharing, requiring the CustomerID and customer verification information from authorized partner organizations to avoid duplicate verification processes.

Use the POST onboarding/:CustomerID/prefill endpoint to prefill customer data. The endpoint leverages Noah's integration with the Sumsub identity verification service through triparty agreements, enabling transfer of verified applicant data via cryptographically secured tokens.

Complete the onboarding process using the POST onboarding/:CustomerID endpoint to collect:

• Missing compliance data through dynamic forms or hosted sessions
• Terms and Conditions acceptance for regulatory compliance
• Fiat currency selection configured during hosted onboarding

Note: Noah automatically identifies gaps in compliance data and collects only what's missing. If email is prefilled, it won't be requested again during onboarding.

For more details on this process, see the Hosted Onboarding recipe.

Example Scenario

Consider a customer who has already completed KYC verification with one of Noah's partners and now wants to use your platform:

Setup:

• CustomerID: Existing verified customer from partner organization
• Input: Sumsub token with verified applicant data
• Verification Status: Identity and document checks already completed
• Missing Data: Platform-specific information and T&C acceptance

Key Implementation Features:

• Cryptographically secured token transfer of verification data
• Automatic gap identification for missing compliance requirements
• Reduced onboarding time by avoiding duplicate verification
• Dynamic form generation for platform-specific data collection

Recipe

Implement a scenario as described above by following the steps below.

1. Provide a Sumsub Token

Provide a Sumsub token via the POST onboarding/:CustomerID/prefill endpoint, as described in KYC Platform. In this step, you query the POST onboarding/:CustomerID/prefill endpoint, selecting the SumSubToken type:

curl -L 'https://api.sandbox.noah.com/v1/onboarding/:CustomerID/prefill' \
-H 'Content-Type: application/json' \
-H 'X-Api-Key: <X-Api-Key>' \
-d '{
  "Type": "SumSubToken",
  "Token": "string"
}'

As can be seen above, in your request, include your API Key in the header, along with a CustomerID.

Once compliance profiles are added to Sumsub, any missing information can be requested via Dynamic Forms and/or a dynamic Hosted Onboarding session, as defined in the next step. For details, see KYC Platform.

2. Initiate a Hosted Onboarding Session

Submit a call to the POST onboarding/:CustomerID endpoint, to collect the prerequisite Terms and Conditions acceptance from your customer (and any missing data as per the token share):

curl -L 'https://api.sandbox.noah.com/v1/onboarding/:CustomerID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Api-Key: <X-Api-Key>' \
-d '{
  "Metadata": {},
  "ReturnURL": "https://example.com",
  "FiatOptions": [
    {
      "FiatCurrencyCode": "USD"
    }
  ]
}'

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

note

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

View the POST onboarding/:CustomerID endpoint 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"}

3. Direct the Customer to Hosted Onboarding

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

4. 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.

5. 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.