Introducing Starknet Network:   OffRamp and OnRamp USDC are now supported for Starknet network.  View changelog for details →.
Sphere Paysphere
Kyc link

Create KYC Link

POST
/v2/customer/{customer_id}/kyc-link
AuthorizationBearer <token>

In: header

Path Parameters

customer_idstring

The customer's id.

typestring

The customer type of either individual or business.

firstNamestring

The first name of the customer.

lastNamestring

The last name of the customer.

emailstring

The email of the customer.

Format"email"

Response Body

curl -X POST "https://api.sandbox.spherepay.co/v2/customer/{{customer_id}}/kyc-link" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "individual",
    "firstName": "Jane",
    "lastName": "Doe",
    "email": "janedoe123@gmail.com"
  }'
const body = JSON.stringify({
  "type": "individual",
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "janedoe123@gmail.com"
})

fetch("https://api.sandbox.spherepay.co/v2/customer/{{customer_id}}/kyc-link", {
  body
})
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
  "strings"
)

func main() {
  url := "https://api.sandbox.spherepay.co/v2/customer/{{customer_id}}/kyc-link"
  body := strings.NewReader(`{
    "type": "individual",
    "firstName": "Jane",
    "lastName": "Doe",
    "email": "janedoe123@gmail.com"
  }`)
  req, _ := http.NewRequest("POST", url, body)
  req.Header.Add("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}
import requests

url = "https://api.sandbox.spherepay.co/v2/customer/{{customer_id}}/kyc-link"
body = {
  "type": "individual",
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "janedoe123@gmail.com"
}
response = requests.request("POST", url, json = body, headers = {
  "Content-Type": "application/json"
})

print(response.text)
{
  "url": "https://in.sumsub.com/websdk/p/sbx_gq9t7z0Zf6agMcbn",
  "expiresAt": "2025-04-27T02:35:18.842Z"
}
{
  "ts": "2025-04-20T02:38:08.659Z",
  "error": {
    "general": "Bad Request Exception"
  }
}
{
  "ts": "2025-04-20T02:37:05.790Z",
  "error": {
    "general": "Customer not found"
  }
}