> ## Documentation Index > Fetch the complete documentation index at: https://ramps-docs-sync-20260321.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Get a KYC link for onboarding a customer > Generate a hosted KYC link to onboard a customer ## OpenAPI ````yaml https://app.stainless.com/api/spec/documented/grid/openapi.documented.yml get /customers/kyc-link openapi: 3.1.0 info: title: Grid API description: > API for managing global payments on the open Money Grid. Built by Lightspark. See the full documentation at https://grid.lightspark.com/. version: '2025-10-13' contact: name: Lightspark Support email: support@lightspark.com license: name: Proprietary url: https://lightspark.com/terms servers: - url: https://api.lightspark.com/grid/2025-10-13 description: Production server security: - BasicAuth: [] tags: - name: Platform Configuration description: >- Platform configuration endpoints for managing global settings. You can also configure these settings in the Grid dashboard. - name: Customers description: >- Customer management endpoints for creating and updating customer information - name: KYC/KYB Verifications description: >- Endpoints for Know Your Customer (KYC) and Know Your Business (KYB) verification, including managing beneficial owners and triggering verification for customers. - name: Documents description: >- Endpoints for uploading and managing verification documents for customers and beneficial owners. Supports KYC and KYB document requirements. - name: Internal Accounts description: >- Internal account management endpoints for creating and managing internal accounts - name: External Accounts description: >- External account management endpoints for creating and managing external bank accounts - name: Same-Currency Transfers description: >- Endpoints for transferring funds between internal and external accounts with the same currency - name: Cross-Currency Transfers description: Endpoints for creating and confirming quotes for cross-currency transfers - name: Transactions description: Endpoints for retrieving transaction information - name: Webhooks description: Webhook endpoints and configuration for receiving notifications - name: Invitations description: Endpoints for creating, claiming and managing UMA invitations - name: Sandbox description: Endpoints to trigger test cases in sandbox - name: API Tokens description: Endpoints to programmatically manage API tokens - name: Exchange Rates description: >- Endpoints for retrieving cached foreign exchange rates. Rates are cached for approximately 5 minutes and include platform-specific fees. - name: Discoveries description: >- Endpoints for discovering available payment rails, banks, and providers for a given country and currency corridor. paths: /customers/kyc-link: parameters: - name: redirectUri in: query description: >- An optional uri a customer will be redirected to after completing the hosted KYC flow required: false schema: type: string - name: platformCustomerId in: query description: The platform id of the customer to onboard required: true schema: type: string get: tags: - KYC/KYB Verifications summary: Get a KYC link for onboarding a customer description: Generate a hosted KYC link to onboard a customer operationId: getKycLinkForCustomer responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/KycLinkResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '500': description: Internal service error content: application/json: schema: $ref: '#/components/schemas/Error500' security: - BasicAuth: [] x-codeSamples: - lang: JavaScript source: >- 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); - lang: Python source: |- import os from grid import LightsparkGrid client = LightsparkGrid( username=os.environ.get("GRID_CLIENT_ID"), # This is the default and can be omitted password=os.environ.get("GRID_CLIENT_SECRET"), # This is the default and can be omitted ) response = client.customers.get_kyc_link( platform_customer_id="platformCustomerId", ) print(response.customer_id) - lang: Kotlin source: >- 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) } components: schemas: KycLinkResponse: type: object properties: kycUrl: type: string description: A hosted KYC link for your customer to complete KYC example: https://example.com/redirect platformCustomerId: type: string description: The platform id of the customer to onboard example: 019542f5-b3e7-1d02-0000-000000000001 customerId: type: string description: The customer id of the newly created customer on the system example: Customer:019542f5-b3e7-1d02-0000-000000000001 Error401: type: object required: - message - status - code properties: status: type: integer enum: - 401 description: HTTP status code code: type: string description: | | Error Code | Description | |------------|-------------| | UNAUTHORIZED | Issue with API credentials | | INVALID_SIGNATURE | Signature header is invalid | enum: - UNAUTHORIZED - INVALID_SIGNATURE message: type: string description: Error message details: type: object description: Additional error details additionalProperties: true Error500: type: object required: - message - status - code properties: status: type: integer enum: - 500 description: HTTP status code code: type: string description: | | Error Code | Description | |------------|-------------| | GRID_SWITCH_ERROR | Grid switch error | | INTERNAL_ERROR | Internal server or UMA error | enum: - GRID_SWITCH_ERROR - INTERNAL_ERROR message: type: string description: Error message details: type: object description: Additional error details additionalProperties: true securitySchemes: BasicAuth: type: http scheme: basic description: >- API token authentication using format `:` ````