---
title: "Create Customer via Link"
method: POST
path: "/v2/customer/kyc-link"
---

# Create Customer via Link

`POST /v2/customer/kyc-link`

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

## Request body

- CreateCustomerKycLinkDto
  - `type` 'individual' | 'business', required — The type of customer to onboard.
  - `email` string, email, required — The customer email address.
  - `phone` string, required — The customer phone number in E.164 format.
  - `address` object, required — The customer's address. For individual customers this is the residential address; for business customers this is the registered business address.
    - `line1` string, required — The first line of the street address
    - `line2` string — The second line of the street address (apartment, suite, etc.)
    - `city` string, required — The city name
    - `state` string — The state or province code (ISO3166-2 subdivision code). Required for countries that have states/provinces. See State Codes.
    - `postalCode` string — The postal or ZIP code. Required for countries that use postal codes
    - `country` string, required — The ISO3166-1 Alpha-3 country code (e.g., USA, GBR, CAN). See [Country Codes](/concepts/reference/supported-countries).

## Response `201`

- GenerateKycUrlResponseDto
  - `customerId` string, required — The ID of the customer the KYC link belongs to
  - `url` string, required — Hosted KYC URL
  - `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.

## Other responses

- `400` — Bad Request
- `404` — Not Found
- `422` — Unprocessable Entity - Validation Error

---

[API](https://skmtc.net/spherepay/apis/docs-spherepay-co.md) · [All operations](https://skmtc.net/spherepay/apis/docs-spherepay-co/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/spherepay/docs-spherepay-co/versions/4f3f5484aed3/schema)