Effortless customer verification now available   View changelog
Sphere Paysphere

Customer KYC via Link

This guide will walk you through the process of using the Customer KYC Link.

Introduction

To initiate the KYC process via link, you will need to generate a KYC link and redirect the customer to the KYC page to complete the KYC process. This method is ideal for rapid integration and is suited for those comfortable utilizing SpherePay’s native KYC interface.

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

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

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": "individual | business",
    "address": {
      "line1": "string",
      "line2": "string",
      "city": "string",
      "postalCode": "string",
      "state": "string",
      "country": "string"
    }
  }

2. Accepting Terms of Service

After a customer has been created, you can generate a TOS link to redirect the 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/:customer_id/tos-link
POST https://api.sandbox.spherepay.co/v2/customer/: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.

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/:customer_id/kyc-link
POST https://api.sandbox.spherepay.co/v2/customer/: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. Please refer to the Customer Onboarding guide for more information. During the KYC/KYB process, the customer is able to register their wallet and bank account. The bank account will remain in pending status until the customer's identity is verified.

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/:customer_id
GET https://api.sandbox.spherepay.co/v2/customer/: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. Please refer to the Register Bank Account guide for more information.

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. Please refer to the Transfer guide for more information.