Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.spherepay.co/llms.txt

Use this file to discover all available pages before exploring further.

Generate a hosted Terms of Service acceptance link for a customer. This endpoint is required only in the Sphere-Managed onboarding model — in the Platform-Managed model, TOS acceptance is handled upstream by your own platform before the customer is passed to SpherePay. Redirect the customer to the returned link so they can review and accept SpherePay’s Terms of Service. The link expires at the time indicated by expiresAt.
TOS acceptance is a required step in the Sphere-Managed KYC flow. The customer cannot be approved for transfers until they have accepted the Terms of Service. If you are using the Platform-Managed model, skip this endpoint.

​
Endpoint

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

​
Authentication

All requests must include a Bearer token in the Authorization header. 
Authorization: Bearer <token>

​
Path parameters

​
id
string
required
The ID of the customer for whom to generate the Terms of Service link.
  -H "Authorization: Bearer <token>"

​
Response fields

​
link
string
The hosted URL to redirect the customer to for Terms of Service acceptance. The link contains a signed token scoped to the specific customer.
​
expiresAt
string
ISO 8601 timestamp indicating when the TOS link expires. Generate a new link if the customer has not completed acceptance before this time.
{
  "link": "https://spherepay.co/tos?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJjdXN0b21lcl9lMDE2MzNjNWY1OTY0MThiOGU5ZTQzNDEyMzQ2OTk0YyIsImFwcGxpY2F0aW9uSWQiOiJhcHBsaWNhdGlvbl84NWM5ZmE2ZTFjMjk0YzJmOTA2NDcwNWFlYTE3Y2ZkMyIsImN1c3RvbWVyVHlwZSI6ImluZGl2aWR1YWwiLCJtc2FTdGF0dXMiOiJpbmNvbXBsZXRlIiwibXNhUmVxdWlyZWQiOmZhbHNlLCJpYXQiOjE3NjQwMzQwMDUsImV4cCI6MTc2NjQ1MzIwNX0.6z3976YqDxDr5LkMJxoZhw526cu1PGE3nFZtAE8vIfY",
  "expiresAt": "2026-03-09T20:46:31.305Z"
}
Last modified on May 12, 2026