Skip to main content
Create TOS Link
curl --request POST \
  --url https://api.spherepay.co/v2/customer/{id}/tos-link \
  --header 'Authorization: Bearer <token>'
{
  "link": "https://spherepay.co/tos?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJjdXN0b21lcl9lMDE2MzNjNWY1OTY0MThiOGU5ZTQzNDEyMzQ2OTk0YyIsImFwcGxpY2F0aW9uSWQiOiJhcHBsaWNhdGlvbl84NWM5ZmE2ZTFjMjk0YzJmOTA2NDcwNWFlYTE3Y2ZkMyIsImN1c3RvbWVyVHlwZSI6ImluZGl2aWR1YWwiLCJtc2FTdGF0dXMiOiJpbmNvbXBsZXRlIiwibXNhUmVxdWlyZWQiOmZhbHNlLCJpYXQiOjE3NjQwMzQwMDUsImV4cCI6MTc2NjQ1MzIwNX0.6z3976YqDxDr5LkMJxoZhw526cu1PGE3nFZtAE8vIfY",
  "expiresAt": "2026-03-09T20:46:31.305Z"
}
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.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Customer ID

Example:

"customer_f31121c389624d3697cbf3ea8830b7a4"

Response

​
link
string
required

Terms of Service link URL

Example:

"https://spherepay.co/tos?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJjdXN0b21lcl9lMDE2MzNjNWY1OTY0MThiOGU5ZTQzNDEyMzQ2OTk0YyIsImFwcGxpY2F0aW9uSWQiOiJhcHBsaWNhdGlvbl84NWM5ZmE2ZTFjMjk0YzJmOTA2NDcwNWFlYTE3Y2ZkMyIsImN1c3RvbWVyVHlwZSI6ImluZGl2aWR1YWwiLCJtc2FTdGF0dXMiOiJpbmNvbXBsZXRlIiwibXNhUmVxdWlyZWQiOmZhbHNlLCJpYXQiOjE3NjQwMzQwMDUsImV4cCI6MTc2NjQ1MzIwNX0.6z3976YqDxDr5LkMJxoZhw526cu1PGE3nFZtAE8vIfY"

​
expiresAt
string
required

ISO 8601 formatted date and time of the TOS link expiration

Example:

"2026-03-09T20:46:31.305Z"

Last modified on June 18, 2026