v1

latestOpenAPI 3.0.02026-07-224537337.5 KB

Create Customer via Link

Create a customer via the hosted onboarding link flow. Returns a KYC link and its expiry.

post/v2/customer/kyc-link

Request body

type'individual' | 'business' required

The type of customer to onboard.

emailstring email required

The customer email address.

phonestring required

The customer phone number in E.164 format.

Example request

{
  "type": "individual",
  "email": "jane.smith@example.com",
  "phone": "+14155550123",
  "address": {
    "line1": "233 South Wacker Drive",
    "line2": "Suite 4700",
    "city": "Chicago",
    "state": "IL",
    "postalCode": "60606",
    "country": "USA"
  }
}

Response

customerIdstring required

The ID of the customer the KYC link belongs to

urlstring required

Hosted KYC URL

expiresAtstring 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 response

{
  "customerId": "customer_b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7",
  "url": "https://in.sumsub.com/websdk/p/sbx_uq30ag1ov7oHZhmx",
  "expiresAt": "2026-03-09T20:46:31.305Z"
}