Skip to main content
Create Customer via Link
curl --request POST \
  --url https://api.spherepay.co/v2/customer/kyc-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "individual",
  "email": "jane.smith@example.com",
  "phone": "+14155550123",
  "address": {
    "line1": "233 South Wacker Drive",
    "city": "Chicago",
    "country": "USA",
    "line2": "Suite 4700",
    "state": "IL",
    "postalCode": "60606"
  }
}
'
{
  "customerId": "customer_b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7",
  "url": "https://in.sumsub.com/websdk/p/sbx_uq30ag1ov7oHZhmx",
  "expiresAt": "2026-03-09T20:46:31.305Z"
}
Use this endpoint to create a customer and generate a hosted KYC link in a single request. Instead of creating the customer first and then requesting a link separately, you provide the customer’s type, email, phone, and address here, and the response returns the new customer’s ID along with a time-limited hosted verification URL. Redirect the customer to this URL to complete their identity checks with the verification provider.
Customers created via this onboarding link flow can only be managed with the onboarding link endpoints — they are not compatible with the direct API onboarding flows. Likewise, customers onboarded through the other API flows cannot be used with the onboarding link endpoints.
The returned URL expires at the time indicated by expiresAt — by default, 4 weeks (28 days) after creation. This default may change without notice, so always rely on expiresAt rather than assuming a fixed duration. If the link expires before the customer completes verification, generate a fresh one with Regenerate KYC Link using the customerId from this response.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
type
enum<string>
required

The type of customer to onboard.

Available options:
individual,
business
Example:

"individual"

​
email
string<email>
required

The customer email address.

Maximum string length: 254
Example:

"jane.smith@example.com"

​
phone
string
required

The customer phone number in E.164 format.

Pattern: ^\+(?:[0-9]){6,14}[0-9]$
Example:

"+14155550123"

​
address
object
required

The customer's address. For individual customers this is the residential address; for business customers this is the registered business address.

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