> ## Documentation Index
> Fetch the complete documentation index at: https://ramps-docs-sync-20260519.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Configuring Customers
> Complete guide to creating and managing customers for Bitcoin rewards
This guide covers everything you need to know about creating and managing customers in the Grid API for Bitcoin rewards distribution.
## Overview
Customers are the *payers* of your Bitcoin rewards. They can be individuals or businesses. Each customer in the Grid system has:
* **System-generated ID**: Unique identifier assigned by Grid (e.g., `Customer:019542f5-b3e7-1d02-0000-000000000001`)
* **Customer Type**: Either `INDIVIDUAL` or `BUSINESS`
* **KYC Status**: Indicates if the customer has been verified and approved.
* **Internal Accounts**: Automatically created for each supported currency upon customer creation
* **Platform Customer ID**: Optional field to link to your own user/customer ID
The `platformCustomerId` field is optional but recommended. Use your existing user IDs to maintain a simple mapping between your system and Grid.
## Customer Onboarding
**Regulated platforms** have lighter KYC requirements since they handle compliance verification internally.
The KYC/KYB flow allows you to onboard customers through direct API calls.
Regulated financial institutions can:
* **Direct API Onboarding**: Create customers directly via API calls with minimal verification
* **Internal KYC/KYB**: Handle identity verification through your own compliance systems
* **Reduced Documentation**: Only provide essential customer information required by your payment counterparty or service provider.
* **Faster Onboarding**: Streamlined process for known, verified customers
#### Creating Customers via Direct API
For regulated platforms, you can create customers directly through the API without requiring external KYC verification:
To register a new customer in the system, use the `POST /customers` endpoint:
```bash theme={null}
curl -X POST "https://api.lightspark.com/grid/2025-10-13/customers" \
-H "Authorization: Basic $GRID_CLIENT_ID:$GRID_CLIENT_SECRET" \
-H "Content-Type: application/json" \
-d '{
"platformCustomerId": "customer_12345",
"customerType": "INDIVIDUAL",
"fullName": "Jane Doe",
"birthDate": "1992-03-25",
"nationality": "US",
"address": {
"line1": "123 Pine Street",
"city": "Seattle",
"state": "WA",
"postalCode": "98101",
"country": "US"
}
}'
```
The examples below show a more comprehensive set of data. Not all fields are strictly required by the API for customer creation itself, but become necessary based on currency and UMA provider requirements if using UMA.
```json theme={null}
{
"platformCustomerId": "9f84e0c2a72c4fa",
"customerType": "INDIVIDUAL",
"fullName": "John Sender",
"birthDate": "1985-06-15",
"address": {
"line1": "Paseo de la Reforma 222",
"line2": "Piso 15",
"city": "Ciudad de México",
"state": "Ciudad de México",
"postalCode": "06600",
"country": "MX"
}
}
```
```json theme={null}
{
"platformCustomerId": "b87d2e4a9c13f5b",
"customerType": "BUSINESS",
"businessInfo": {
"legalName": "Acme Corporation",
"registrationNumber": "789012345",
"taxId": "123-45-6789"
},
"address": {
"line1": "456 Oak Avenue",
"line2": "Floor 12",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "US"
}
}
```
**Unregulated platforms** require full KYC/KYB verification of customers through hosted flows.
Unregulated platforms must:
* **Hosted KYC Flow**: Use the hosted KYC link for complete identity verification
* **Extended Review**: Customers may require manual review and approval in some cases
### Hosted KYC Link Flow
The hosted KYC flow provides a secure, hosted interface where customers can complete their identity verification and onboarding process.
The flow is two steps: create the customer with the information you have, then generate a hosted KYC link for that customer. The customer's `kycStatus` stays `PENDING` until they complete the hosted flow.
#### 1. Create the customer
Create the customer with `POST /customers`, supplying at least `customerType` and any fields you already have. See [Configuring Customers](/payouts-and-b2b/onboarding/configuring-customers) for the full list of optional pre-fill fields.
```bash theme={null}
curl -X POST "https://api.lightspark.com/grid/2025-10-13/customers" \
-u "$GRID_CLIENT_ID:$GRID_CLIENT_SECRET" \
-H "Content-Type: application/json" \
-d '{
"customerType": "INDIVIDUAL",
"platformCustomerId": "9f84e0c2a72c4fa",
"region": "US",
"currencies": ["USD", "USDC"],
"email": "jane.doe@example.com",
"fullName": "Jane Doe"
}'
```
Persist the returned `id` (the Grid customer ID) — you'll need it for the next step.
#### 2. Generate a KYC link
```bash theme={null}
curl -X POST "https://api.lightspark.com/grid/2025-10-13/customers/Customer:019542f5-b3e7-1d02-0000-000000000001/kyc-link" \
-u "$GRID_CLIENT_ID:$GRID_CLIENT_SECRET" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"redirectUri": "https://yourapp.com/onboarding-complete"
}'
```
**Response:**
```json theme={null}
{
"kycUrl": "https://kyc.lightspark.com/onboard/abc123def456",
"expiresAt": "2027-01-15T14:32:00Z",
"provider": "SUMSUB",
"token": "_act-sbx-jwt-eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
```
The response always includes `kycUrl` for the hosted flow. For providers that support direct SDK integration (currently SUMSUB), a `token` is also returned — you can pass this to the provider's web SDK to embed verification in your own UI instead of redirecting. Both paths update the customer's `kycStatus` identically.
#### Complete KYC Process
Call `POST /customers` with `customerType` and any pre-fill fields you have. The returned `id` is the customer's Grid ID; their `kycStatus` is `PENDING` until verification completes.
Call `POST /customers/{customerId}/kyc-link`. Each call returns a fresh single-use `kycUrl` and `expiresAt`; previously-issued links remain single-use but aren't invalidated.
The `redirectUri` you pass is embedded in the generated `kycUrl` and is used to automatically return the customer to your application after they complete verification.
Redirect the customer to `kycUrl`, or — if you want to embed the flow directly — initialize the provider's SDK with the returned `token`.
The hosted URL is single-use and expires at `expiresAt`. If a customer needs to retry, call the endpoint again to generate a new link.
Reaching your `redirectUri` only means the customer **finished the hosted flow** — not that they were approved. Wait for the final decision in one of two ways:
* **Webhook (recommended):** Subscribe to `KYC_STATUS` to be notified when the customer reaches a terminal status (`APPROVED`, `REJECTED`, `EXPIRED`, or `CANCELED`).
* **Polling:** Call `GET /customers/{customerId}` and inspect `kycStatus`.
On `APPROVED`, the customer is ready to transact — proceed with account setup and unlock funding. On `REJECTED` or `EXPIRED`, surface the appropriate next step (for example, regenerate the link or request manual review).
When a customer is created successfully, internal accounts are automatically created for each currency configured on your platform. These accounts can be used as sources or destinations for transfers.
### Hanlding KYC/KYC Webhooks
After a customer completes the KYC/KYB verification process, you'll receive webhook notifications about their KYC status. These notifications are sent to your configured webhook endpoint.
For regulated platforms, customers are created with `APPROVED` KYC status by default.
**Webhook Payload (sent to your endpoint):**
```json theme={null}
{
"id": "Webhook:019542f5-b3e7-1d02-0000-000000000020",
"type": "CUSTOMER.KYC_APPROVED",
"timestamp": "2025-07-21T17:32:28Z",
"data": {
"id": "Customer:019542f5-b3e7-1d02-0000-000000000001",
"platformCustomerId": "9f84e0c2a72c4fa",
"customerType": "INDIVIDUAL",
"umaAddress": "$john.doe@uma.domain.com",
"kycStatus": "APPROVED",
"fullName": "John Michael Doe",
"birthDate": "1990-01-15",
"nationality": "US",
"address": {
"line1": "123 Main Street",
"line2": "Apt 4B",
"city": "San Francisco",
"state": "CA",
"postalCode": "94105",
"country": "US"
},
"createdAt": "2025-07-21T17:32:28Z",
"updatedAt": "2025-07-21T17:32:28Z",
"isDeleted": false
}
}
```
**Webhook Headers:**
* `Content-Type: application/json`
* `X-Grid-Signature: {"v": "1", "s": "base64_signature..."}`
Unique identifier for this webhook delivery. Use this for idempotency to prevent processing duplicate webhooks.
Status-specific event type. KYC webhooks use `CUSTOMER.*` types:
* `CUSTOMER.KYC_APPROVED`: Customer verification completed successfully
* `CUSTOMER.KYC_REJECTED`: Customer verification was rejected
* `CUSTOMER.KYC_SUBMITTED`: KYC verification was initially submitted
* `CUSTOMER.KYC_MANUALLY_APPROVED`: Customer was manually approved by platform
* `CUSTOMER.KYC_MANUALLY_REJECTED`: Customer was manually rejected by platform
The full customer resource object, same as the corresponding `GET /customers/{id}` endpoint would return. Includes all customer fields such as `id`, `kycStatus`, `fullName`, `birthDate`, `nationality`, `address`, etc.
Intermediate states like `PENDING_REVIEW` do not trigger webhook notifications. Only final resolution states will send webhook notifications.
```javascript theme={null}
// Example webhook handler for KYC status updates
// Note: Only final states trigger webhook notifications
app.post('/webhooks/kyc-status', async (req, res) => {
const { type, data } = req.body;
switch (type) {
case 'CUSTOMER.KYC_APPROVED':
// Activate customer account
await activateCustomer(data.id);
await sendWelcomeEmail(data.id);
break;
case 'CUSTOMER.KYC_REJECTED':
// Notify support and customer
await notifySupport(data.id, 'KYC_REJECTED');
await sendRejectionEmail(data.id);
break;
case 'CUSTOMER.KYC_MANUALLY_APPROVED':
// Handle manual approval
await activateCustomer(data.id);
await sendWelcomeEmail(data.id);
break;
case 'CUSTOMER.KYC_MANUALLY_REJECTED':
// Handle manual rejection
await notifySupport(data.id, 'KYC_MANUALLY_REJECTED');
await sendRejectionEmail(data.id);
break;
default:
// Log unexpected types
console.log(`Unexpected webhook type ${type} for customer ${data.id}`);
}
res.status(200).send('OK');
});
```
## Listing Customers
Retrieve a paginated list of customers with optional filtering:
```bash theme={null}
curl -X GET "https://api.lightspark.com/grid/2025-10-13/customers?limit=20&customerType=INDIVIDUAL" \
-H "Authorization: Basic $GRID_CLIENT_ID:$GRID_CLIENT_SECRET"
```
### Query Parameters
Filter by your platform's customer identifier
Filter by customer type (`INDIVIDUAL` or `BUSINESS`)
Filter customers created after this timestamp (ISO 8601)
Filter customers created before this timestamp (ISO 8601)
Filter customers updated after this timestamp (ISO 8601)
Filter customers updated before this timestamp (ISO 8601)
Whether to include deleted customers in results (default: false)
Maximum number of results per page (default: 20, max: 100)
Pagination cursor from previous response
### Response
```json theme={null}
{
"data": [
{
"id": "Customer:019542f5-b3e7-1d02-0000-000000000001",
"platformCustomerId": "user_12345",
"customerType": "INDIVIDUAL",
"kycStatus": "APPROVED",
"fullName": "Jane Doe",
"birthDate": "1992-03-25",
"address": {
"line1": "123 Pine Street",
"line2": "Unit 501",
"city": "Seattle",
"state": "WA",
"postalCode": "98101",
"country": "US"
},
"createdAt": "2025-10-03T12:00:00Z",
"updatedAt": "2025-10-03T12:00:00Z",
"isDeleted": false
}
],
"hasMore": true,
"nextCursor": "MjAyNS0xMC0wM1QxMjowMDowMFo=",
"totalCount": 152
}
```
To find a specific customer by your platform ID, use: `GET /customers?platformCustomerId=user_12345`
## Retrieving a Single Customer
Get detailed information about a specific customer:
```bash theme={null}
curl -X GET "https://api.lightspark.com/grid/2025-10-13/customers/{customerId}" \
-H "Authorization: Basic $GRID_CLIENT_ID:$GRID_CLIENT_SECRET"
```
## Deleting Customers
Delete a customer by their system-generated ID:
```bash theme={null}
curl -X DELETE "https://api.lightspark.com/grid/2025-10-13/customers/{customerId}" \
-H "Authorization: Basic $GRID_CLIENT_ID:$GRID_CLIENT_SECRET"
```
Deleting a customer is permanent and will prevent them from receiving future payments. Their transaction history will be preserved but the customer record will be marked as deleted.
## Related Resources
* [API Reference: Customers](/api-reference/customers/add-a-new-customer) - Complete customer API documentation
* [Quick Start Guide](/rewards/quickstart) - End-to-end Bitcoin rewards walkthrough
* [Handling Webhooks](/rewards/platform-tools/webhooks) - Implement webhook handling for real-time notifications