---
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-13** `ecd31fe01b4e` — 10 breaking, 2 warning
  - added `#/components/schemas/Error401_UNAUTHORIZED, #/components/schemas/Error401_INVALID_SIGNATURE` to the response body `oneOf` list for the response status `401`
  - added `#/components/schemas/Error500_GRID_SWITCH_ERROR, #/components/schemas/Error500_INTERNAL_ERROR` to the response body `oneOf` list for the response status `500`
  - the response's body type/format changed from `object`/`` to ``/`` for status `401`
  - the response's body type/format changed from `object`/`` to ``/`` for status `500`
  - …8 more
- **2026-02-13** `2055da1ed488` — 2 breaking, 10 info
  - the response's body type/format changed from ``/`` to `object`/`` for status `401`
  - the response's body type/format changed from ``/`` to `object`/`` for status `500`
  - removed `#/components/schemas/Error401_UNAUTHORIZED, #/components/schemas/Error401_INVALID_SIGNATURE` from the response body `oneOf` list for the response status `401`
  - removed `#/components/schemas/Error500_GRID_SWITCH_ERROR, #/components/schemas/Error500_INTERNAL_ERROR` from the response body `oneOf` list for the response status `500`
  - …8 more
- …earlier changes not shown

[Full 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/ecd31fe01b4e/schema)