---
title: "Get a KYC link for onboarding a customer"
method: GET
path: "/customers/kyc-link"
tags: ["Customers"]
---

# Get a KYC link for onboarding a customer

`GET /customers/kyc-link`

Generate a hosted KYC link to onboard a customer

## Response `200`

Successful operation

- object
  - `kycUrl` string — A hosted KYC link for your customer to complete KYC
  - `platformCustomerId` string — The platform id of the customer to onboard
  - `customerId` string — The customer id of the newly created customer on the system

## Other responses

- `401` — Unauthorized
- `500` — Internal service error

## Changes

- **2026-02-05** `42f104b10868` — 4 breaking, 4 warning
  - the `status` response property const value `401` was removed for the status `401`
  - the `status` response property const value `401` was removed for the status `401`
  - the `status` response property const value `500` was removed for the status `500`
  - the `status` response property const value `500` was removed for the status `500`
  - …4 more

[Change history](https://skmtc.dev/lightsparkdev/apis/grid-api/changes/customers/kyc-link/get.md)

---

[API](https://skmtc.dev/lightsparkdev/apis/grid-api.md) · [All operations](https://skmtc.dev/lightsparkdev/apis/grid-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/lightsparkdev/grid-api/revisions/a3bb103c6b4a/schema)