API Deprecation Notice:   The /v1/customer  endpoint will be deprecated on June 6, 2025. Please migrate to  /v2/customerView changelog for details →.
Sphere Paysphere

Customer Registration

This guide will walk you through the process of registering a customer for transfers.

Customer

A Customer is a user or business that is associated with your application. Customers are user or business parties that use your application to send and receive transfers.

Customer Registration

Customer registration is a process that allows you to create a customer in Sphere. This process involves verifying the customer's identity and creating a customer record in Sphere.

Customer Registration

1. Create a Customer

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

POST https://api.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

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

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

Last updated on

On this page