Skip to main content
Regenerate KYC Link
curl --request POST \
  --url https://api.spherepay.co/v2/customer/{id}/kyc-link \
  --header 'Authorization: Bearer <token>'
{
  "customerId": "customer_b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7",
  "url": "https://in.sumsub.com/websdk/p/sbx_uq30ag1ov7oHZhmx",
  "expiresAt": "2026-03-09T20:46:31.305Z"
}
Use this endpoint to regenerate a hosted KYC link for an existing customer — for example, when a previously issued link expired before the customer completed verification. The response returns a time-limited URL that you redirect the customer to for any remaining identity checks handled by the verification provider. By default, links expire 4 weeks (28 days) after creation, but this default may change without notice — always rely on the expiresAt field in the response rather than assuming a fixed duration.
This endpoint only works for customers created via Create Customer via Link. Customers onboarded through the direct API flows are not compatible with the onboarding link endpoints — and customers created via onboarding links cannot be onboarded through the direct API flows.

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

​
customerId
string
required

The ID of the customer the KYC link belongs to

Example:

"customer_b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7"

​
url
string
required

Hosted KYC URL

Example:

"https://in.sumsub.com/websdk/p/sbx_uq30ag1ov7oHZhmx"

​
expiresAt
string
required

ISO 8601 formatted date and time of the KYC URL expiration. By default, links expire 4 weeks (28 days) after creation, but this default may change without notice — always rely on this field rather than assuming a fixed duration.

Example:

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

Last modified on July 2, 2026