Business Customer KYB via Link

This guide walks you through onboarding business customers using the Business Customer KYB Link.

Introduction

To initiate the KYB process via link, generate a KYB link and redirect the customer to the hosted KYB page to complete the verification process. This method is ideal for rapid integration and is best suited for integrators who prefer using SpherePay’s native KYB experience.

KYB Link Flow

KYB via Link

The KYB link is a link that redirects the business customer to the KYB page to complete the KYB process. To create a KYB link, you can use the Create KYB Link endpoint.

Once the link is generated, you can redirect the business customer to the link to complete the KYB process. The business customer is expected to provide the required information to complete the KYB process.

Onboarding a Business Customer step by step using KYB Link

The following steps will guide you through the process of onboarding a customer step by step using KYC Link.

1. Create a Customer

To create a customer, you can use the Create Customer endpoint.

POST https://api.spherepay.co/v2/customer

POST https://api.sandbox.spherepay.co/v2/customer

Request Example

{
    "type": "business",
    "address": {
      "line1": "string",
      "line2": "string",
      "city": "string",
      "postalCode": "string",
      "state": "string",
      "country": "string"
    }
  }

2. Accepting Terms of Service & Signing Merchant Service Agreement

After a business customer has been created, you can generate a TOS link to redirect the business customer to the Terms of Service and Privacy Policy. To generate a TOS link, you can use the Generate TOS Link endpoint

POST https://api.spherepay.co/v2/customer/{id}/tos-link

POST https://api.sandbox.spherepay.co/v2/customer/{id}/tos-link

Once the link is generated, you can redirect the customer to the link to complete the onboarding process. The customer is expected to accept the Terms and Conditions, and Privacy Policy before proceeding. After the customer has accepted the Terms and Conditions, SpherePay will automatically redirect the user to a form to fill out required information for the Merchant Service Agreement (MSA). Once the form is completed, the customer will be redirected to the Merchant Service Agreement page to sign the agreement.

3. Know your Customer/Business (KYC/KYB)

In parallel to the onboarding process, you can also collect KYC/KYB information from the customer. To generate a KYC/KYB link, you can use the Generate KYC/KYB Link endpoint.

POST https://api.spherepay.co/v2/customer/{id}/kyc-link

POST https://api.sandbox.spherepay.co/v2/customer/{id}/kyc-link

Once the link is generated, you can redirect the customer to the link to complete the KYC/KYB process. The customer is expected to provide the required information to complete the KYC/KYB process. During the KYC/KYB process, the customer can register their wallet and bank account. The bank account will remain in pending status until the customer's identity is verified.

Notice

The link contains all the required questions and services for the business customer to complete the KYB process. This includes uploading the required documents and registering the business representative (UBO).

4. Check Customer Status

After the customer has completed the KYC/KYB process, you can check the customer status to ensure the customer is onboarded. To check the customer status, you can use the Check Customer Status endpoint.

GET https://api.spherepay.co/v2/customer/{id}

GET https://api.sandbox.spherepay.co/v2/customer/{id}

5. Register Bank Account

Once the customer has been created and the KYC/KYB process is complete, you can register a bank account for the customer. See /guide/product-guides/bank-accounts.

6. Create a Transfer

Once the customer has been created and the KYC/KYB process is complete, you can create a transfer for the customer. See /guide/product-guides/transfers-api.

Business Customer KYB via Link

On this page