Skip to main content
POST
/
customers
/
{id}
/
tos
Create TOS acceptance link
curl --request POST \
  --url https://api.lumx.io/customers/{id}/tos \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "redirectUrl": "https://yourapp.com/onboarding/next-step"
}
'
{
  "url": "https://dashboard.lumx.io/tos/eyJhbGciOiJSUzI1...",
  "expiresAt": "2026-04-09T16:00:00Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header on the format Bearer <API_KEY>.

Path Parameters

​
id
string<uuid>
required

Customer's unique identifier.

Body

application/json
​
redirectUrl
string<uri>

URL to redirect the customer to after they accept the terms of service.

Response

200 - application/json

Terms of service URL successfully generated.

​
url
string<uri>

The acceptance link for the customer to accept the terms of service.

​
expiresAt
string<date-time>

Expiration date and time of the acceptance link. The link expires after 24 hours.