Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.lumx.io/llms.txt

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

Every customer has to accept Lumx’s Terms of Service before they can complete identity verification and move money. Acceptance is collected programmatically through the API. Until the customer accepts, the TERMS_OF_SERVICE entry stays in their requirements array and verification can’t proceed. Send a POST request to /customers/{id}/tos to generate an acceptance URL for a specific customer. Optionally include a redirectUrl to send the customer back to your app after they accept.
Request
curl -X POST https://api-sandbox.lumx.io/customers/3c90c3cc-0d44-4b50-8888-8dd25736052a/tos \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "redirectUrl": "https://yourapp.com/onboarding/next-step"
  }'
Response
{
  "url": "https://dashboard.lumx.io/tos/eyJhbGciOiJSUzI1...",
  "expiresAt": "2026-04-09T16:00:00Z"
}
The returned url expires after 24 hours. If it expires before the customer accepts, generate a new one. The acceptance flow lives on a Lumx-hosted page. Share the returned url with the customer through whichever channel fits your product: email, SMS, in-app link, or as part of an onboarding redirect. When the customer opens the link, they review the Terms of Service and accept. If a redirectUrl was provided, they’re sent back to your app afterwards.

​
Tracking acceptance status

Terms of Service appears as a TERMS_OF_SERVICE entry inside the customer’s requirements array, alongside other onboarding requirements. Subscribe to customer webhooks to be notified as the customer progresses through verification, or read the customer at any time to inspect the current requirements.
Request
curl https://api-sandbox.lumx.io/customers/3c90c3cc-0d44-4b50-8888-8dd25736052a \
  -H "Authorization: Bearer YOUR_API_KEY"
Response (excerpt)
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "requirements": [
    { "name": "TERMS_OF_SERVICE", "status": "NOT_SENT" }
  ]
}

Legal Documents

Full list of Lumx’s legal documents and policies.

Identity Verification

Data requirements for KYC/KYB after acceptance.

Individual verification

End-to-end onboarding flow for individual customers.

Business verification

End-to-end onboarding flow for business customers.