KYC Token Sharing (Sumsub)

Overview

We offer an enhanced KYC service through our KYC Token Sharing Endpoint where you can send your customer's KYC information to Banxa before they create an order. This removes the need for customers to re-submit personal details and upload KYC documentation again during the Banxa checkout flow.

Please note that you should only send through customer details of already KYC verified customers, and ideally at the point of verification. You may also choose to use this API as part of your partner onboarding process, where you can transfer all your customer's details by calling the endpoint in sequence.

Additionally, there may still be a need for customers to submit additional details where the information is needed in order to fulfil Banxa regulatory requirements. This endpoint allows the sharing of customer KYC information to reduce the need for customer to re-submit data, however Banxa is still required to conduct KYC due diligence.

Before you begin

• Have an existing KYC process where you collect customer information
• Completed the Banxa questionnaire to confirm solution fit
• Banxa approval (we will enable KYC Sharing upon approval)
• If using Sumsub, completed token sharing agreement

Authentication

This endpoint requires HMAC authentication.

Although most v2 endpoints use x-api-key, identity token sharing must be signed using:

Authorization: Bearer API_KEY:SIGNATURE:NONCE

Customer awareness

When using Identities endpoint we recommend that customers are advised that their personal details and KYC documents will be shared with Banxa. This reduces customer confusion if Banxa is required to contact the Customer to collect additional documents.

Sumsub

If you use Sumsub as your KYC provider, you may customer's Sumsub KYC token through this endpoint. This will allow Banxa to verify and retrieve the customer's KYC data in order as well as ensure that the customer will not need to go through KYC again during the Banxa checkout flow. Implementation using Sumsub will reduce the amount of information and documentation that you need to pass through, as Banxa will be able retrieve all the required KYC details through the Sumsub API.

You can find Sumsub documentation for KYC sharing here.

📘

As per Sumsub documentation, the Banxa Sumsub clientId is banxa.com_5335. You must use this clientId when generating the share token so that Banxa is able use the token to retrieve customer details. If this clientId is not used, then Sumsub will block Banxa from using the share token that you have provided.

Required parameters for Sumsub

Please review the API Reference document for details of the required request structure.

externalCustomerId must be stable and reused for the same customer. Using different values for the same user will create separate identities.

Example request

curl -X POST "https://api.banxa-sandbox.com/{partnerRef}/v2/identities/token/share" \
  -H "Authorization: Bearer API_KEY:SIGNATURE:NONCE" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "externalCustomerId": "test001001",
    "mobileNumber": "+6146783792",
    "email": "[email protected]",
    "provider": {
      "vendor": "sumsub",
      "token": "_act-sbx-jwt-eyJhbGciOiJub25lIn0..."
    }
  }'

Response (202 Accepted)

{
  "externalCustomerId": "test001001"
}

All other KYC providers

This guide covers Sumsub token sharing. If you use another provider, contact Banxa to confirm supported options for identity sharing.

We also offer KYC Sharing options thorugh our v1.3 Identity API and our Banxa Native API.