Get a KYC link for onboarding a customer

Generate a hosted KYC link to onboard a customer

GET /customers/kyc-link

cURL

cURL

curl --request GET \
  --url https://api.lightspark.com/grid/2025-10-13/customers/kyc-link \
  --header 'Authorization: Basic <encoded-value>'

import LightsparkGrid from '@lightsparkdev/grid';

const client = new LightsparkGrid({
  username: process.env['GRID_CLIENT_ID'], // This is the default and can be omitted
  password: process.env['GRID_CLIENT_SECRET'], // This is the default and can be omitted
});

const response = await client.customers.getKYCLink({ platformCustomerId: 'platformCustomerId' });

console.log(response.customerId);

package com.lightspark.grid.example

import com.lightspark.grid.client.LightsparkGridClient
import com.lightspark.grid.client.okhttp.LightsparkGridOkHttpClient
import com.lightspark.grid.models.customers.CustomerGetKycLinkParams
import com.lightspark.grid.models.customers.CustomerGetKycLinkResponse

fun main() {
    val client: LightsparkGridClient = LightsparkGridOkHttpClient.fromEnv()

    val params: CustomerGetKycLinkParams = CustomerGetKycLinkParams.builder()
        .platformCustomerId("platformCustomerId")
        .build()
    val response: CustomerGetKycLinkResponse = client.customers().getKycLink(params)
}

200

{
  "kycUrl": "https://example.com/redirect",
  "platformCustomerId": "019542f5-b3e7-1d02-0000-000000000001",
  "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001"
}

{
  "status": 401,
  "message": "<string>",
  "details": {}
}

{
  "status": 500,
  "message": "<string>",
  "details": {}
}

Authorizations

Authorization · string · header · required

API token authentication using format <api token id>:<api client secret>

Query Parameters

redirectUri · string

An optional uri a customer will be redirected to after completing the hosted KYC flow

platformCustomerId · string · required

The platform id of the customer to onboard

Response

200

application/json

Successful operation

kycUrl · string

A hosted KYC link for your customer to complete KYC

Example:

"https://example.com/redirect"

platformCustomerId · string

The platform id of the customer to onboard

Example:

"019542f5-b3e7-1d02-0000-000000000001"

customerId · string

The customer id of the newly created customer on the system

Example:

"Customer:019542f5-b3e7-1d02-0000-000000000001"