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 Sumsub face liveness verification link for an individual customer. This endpoint is part of the Sphere-Managed KYC onboarding model, where SpherePay hosts the liveness check experience. After calling this endpoint, redirect your customer to the returned url so they can complete the face liveness check in their browser. The link expires at the time indicated by expiresAt — generate a new one if it has expired before the customer completes verification.
This endpoint is only required in the Sphere-Managed onboarding model. If you are using the Platform-Managed model, upload a liveness report document directly via the document upload endpoint instead.

​
Endpoint

POST https://api.spherepay.co/v2/customer/{id}/face-verification-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 individual customer for whom to generate the face verification link.
  -H "Authorization: Bearer <token>"

​
Response fields

​
url
string
The Sumsub-hosted URL to redirect the customer to for face liveness verification.
​
expiresAt
string
ISO 8601 timestamp indicating when the verification link expires. Generate a new link if the customer has not completed verification before this time.
{
  "url": "https://in.sumsub.com/websdk/p/sbx_uq30ag1ov7oHZhmx",
  "expiresAt": "2026-03-09T20:46:31.305Z"
}
Last modified on May 12, 2026