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 a business representative (UBO). After calling this endpoint, redirect the representative to the returned url so they can complete the face liveness check as part of KYB verification. The link expires at the time indicated by expiresAt — if the representative has not completed liveness by that time, call this endpoint again to get a fresh link.
This endpoint targets a business representative, not a customer. Use the representative’s ID (prefixed associatedPerson_) as the path parameter, not the parent business customer’s ID.

Endpoint

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

Response fields

url
string
The Sumsub-hosted URL to redirect the business representative to for face liveness verification.
expiresAt
string
ISO 8601 timestamp indicating when the verification link expires.
{
  "url": "https://in.sumsub.com/websdk/p/sbx_uq30ag1ov7oHZhmx",
  "expiresAt": "2026-03-09T20:46:31.305Z"
}
Last modified on May 12, 2026