Update customer by ID

cURL

curl --request PATCH \
  --url https://api.lightspark.com/grid/2025-10-13/customers/{customerId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerType": "INDIVIDUAL",
  "fullName": "John Smith",
  "birthDate": "1985-06-15",
  "currencies": [
    "USD",
    "EUR",
    "USDC"
  ],
  "address": {
    "line1": "456 Market St",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94103",
    "country": "US"
  }
}
'

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 customerOneOf = await client.customers.update('customerId', {
  UpdateCustomerRequest: { customerType: 'INDIVIDUAL' },
});

console.log(customerOneOf);

package com.lightspark.grid.example

import com.lightspark.grid.client.LightsparkGridClient
import com.lightspark.grid.client.okhttp.LightsparkGridOkHttpClient
import com.lightspark.grid.models.customers.CustomerOneOf
import com.lightspark.grid.models.customers.CustomerUpdateParams
import com.lightspark.grid.models.customers.IndividualCustomerFields

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

    val params: CustomerUpdateParams = CustomerUpdateParams.builder()
        .customerId("customerId")
        .updateCustomerRequest(CustomerUpdateParams.UpdateCustomerRequest.Individual.builder()
            .customerType(IndividualCustomerFields.CustomerType.INDIVIDUAL)
            .build())
        .build()
    val customerOneOf: CustomerOneOf = client.customers().update(params)
}

{
  "platformCustomerId": "9f84e0c2a72c4fa",
  "customerType": "INDIVIDUAL",
  "umaAddress": "$john.doe@uma.domain.com",
  "id": "Customer:019542f5-b3e7-1d02-0000-000000000001",
  "region": "US",
  "currencies": [
    "USD",
    "USDC"
  ],
  "createdAt": "2025-07-21T17:32:28Z",
  "updatedAt": "2025-07-21T17:32:28Z",
  "isDeleted": false,
  "kycStatus": "APPROVED",
  "fullName": "John Michael Doe",
  "birthDate": "1990-01-15",
  "nationality": "US",
  "address": {
    "line1": "123 Main Street",
    "postalCode": "94105",
    "country": "US",
    "line2": "Apt 4B",
    "city": "San Francisco",
    "state": "CA"
  }
}

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

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

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

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

PATCH

customers

{customerId}

cURL

curl --request PATCH \
  --url https://api.lightspark.com/grid/2025-10-13/customers/{customerId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerType": "INDIVIDUAL",
  "fullName": "John Smith",
  "birthDate": "1985-06-15",
  "currencies": [
    "USD",
    "EUR",
    "USDC"
  ],
  "address": {
    "line1": "456 Market St",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94103",
    "country": "US"
  }
}
'

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 customerOneOf = await client.customers.update('customerId', {
  UpdateCustomerRequest: { customerType: 'INDIVIDUAL' },
});

console.log(customerOneOf);

package com.lightspark.grid.example

import com.lightspark.grid.client.LightsparkGridClient
import com.lightspark.grid.client.okhttp.LightsparkGridOkHttpClient
import com.lightspark.grid.models.customers.CustomerOneOf
import com.lightspark.grid.models.customers.CustomerUpdateParams
import com.lightspark.grid.models.customers.IndividualCustomerFields

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

    val params: CustomerUpdateParams = CustomerUpdateParams.builder()
        .customerId("customerId")
        .updateCustomerRequest(CustomerUpdateParams.UpdateCustomerRequest.Individual.builder()
            .customerType(IndividualCustomerFields.CustomerType.INDIVIDUAL)
            .build())
        .build()
    val customerOneOf: CustomerOneOf = client.customers().update(params)
}

{
  "platformCustomerId": "9f84e0c2a72c4fa",
  "customerType": "INDIVIDUAL",
  "umaAddress": "$john.doe@uma.domain.com",
  "id": "Customer:019542f5-b3e7-1d02-0000-000000000001",
  "region": "US",
  "currencies": [
    "USD",
    "USDC"
  ],
  "createdAt": "2025-07-21T17:32:28Z",
  "updatedAt": "2025-07-21T17:32:28Z",
  "isDeleted": false,
  "kycStatus": "APPROVED",
  "fullName": "John Michael Doe",
  "birthDate": "1990-01-15",
  "nationality": "US",
  "address": {
    "line1": "123 Main Street",
    "postalCode": "94105",
    "country": "US",
    "line2": "Apt 4B",
    "city": "San Francisco",
    "state": "CA"
  }
}

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

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

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

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

Authorizations

Authorization

string

header

required

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

Path Parameters

customerId

string

required

System-generated unique customer identifier

Body

application/json

Individual Customer Update Request
Business Customer Update Request

customerType

enum<string>

required

Whether the customer is an individual or a business entity

Available options:

INDIVIDUAL

Example:

"INDIVIDUAL"

currencies

string[]

Updated list of currency codes the customer will use (ISO 4217 for fiat, e.g. "USD", "EUR"; tickers for crypto, e.g. "BTC", "USDC"). Replaces the existing list. Some currency combinations may require separate customers — if so, the request will be rejected with details.

Example:

["USD", "EUR", "USDC"]

umaAddress

string

Optional UMA address identifier. If provided, the customer's UMA address will be updated. This is an optional identifier to route payments to the customer.

Example:

"$john.doe@uma.domain.com"

kycStatus

enum<string>

The current KYC status of a customer

Available options:

UNVERIFIED,

PENDING,

APPROVED,

REJECTED

Example:

"APPROVED"

fullName

string

Individual's full name

Example:

"John Michael Doe"

birthDate

string<date>

Date of birth in ISO 8601 format (YYYY-MM-DD)

Example:

"1990-01-15"

nationality

string

Country code (ISO 3166-1 alpha-2)

Example:

"US"

address

object

Show child attributes

Response

Customer updated successfully

Individual Customer
Business Customer

platformCustomerId

string

required

Platform-specific customer identifier

Example:

"9f84e0c2a72c4fa"

customerType

enum<string>

required

Whether the customer is an individual or a business entity

Available options:

INDIVIDUAL

Example:

"INDIVIDUAL"

umaAddress

string

required

Full UMA address (always present in responses, even if system-generated). This is an optional identifier to route payments to the customer.

Example:

"$john.doe@uma.domain.com"

string

read-only

System-generated unique identifier

Example:

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

region

string

Country code (ISO 3166-1 alpha-2) representing the customer's regional identity and regulatory jurisdiction.

Example:

"US"

currencies

string[]

List of currency codes enabled for this customer.

Example:

["USD", "USDC"]

createdAt

string<date-time>

read-only

Creation timestamp

Example:

"2025-07-21T17:32:28Z"

updatedAt

string<date-time>

read-only

Last update timestamp

Example:

"2025-07-21T17:32:28Z"

isDeleted

boolean

read-only

Whether the customer is marked as deleted

Example:

false

kycStatus

enum<string>

The current KYC status of a customer

Available options:

UNVERIFIED,

PENDING,

APPROVED,

REJECTED

Example:

"APPROVED"

fullName

string

Individual's full name

Example:

"John Michael Doe"

birthDate

string<date>

Date of birth in ISO 8601 format (YYYY-MM-DD)

Example:

"1990-01-15"

nationality

string

Country code (ISO 3166-1 alpha-2)

Example:

"US"

address

object

Show child attributes

Delete customer by ID

Upload customers via CSV file

⌘I

Using the API

API documentation

Authorizations

Path Parameters

Body

Response