Update customer by ID

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",
  "address": {
    "line1": "456 Market St",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94103",
    "country": "US"
  }
}
'

{
  "platformCustomerId": "9f84e0c2a72c4fa",
  "customerType": "INDIVIDUAL",
  "umaAddress": "[email protected]",
  "id": "Customer:019542f5-b3e7-1d02-0000-000000000001",
  "kycStatus": "APPROVED",
  "createdAt": "2025-07-21T17:32:28Z",
  "updatedAt": "2025-07-21T17:32:28Z",
  "isDeleted": false,
  "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"
  }
}

PATCH

customers

{customerId}

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",
  "address": {
    "line1": "456 Market St",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94103",
    "country": "US"
  }
}
'

{
  "platformCustomerId": "9f84e0c2a72c4fa",
  "customerType": "INDIVIDUAL",
  "umaAddress": "[email protected]",
  "id": "Customer:019542f5-b3e7-1d02-0000-000000000001",
  "kycStatus": "APPROVED",
  "createdAt": "2025-07-21T17:32:28Z",
  "updatedAt": "2025-07-21T17:32:28Z",
  "isDeleted": false,
  "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"
  }
}

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

Update Individual Customer
Update Business Customer

customerType

enum<string>

required

Customer type

Available options:

INDIVIDUAL

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

address.line1

string

required

Street address line 1

Example:

"123 Main Street"

address.postalCode

string

required

Postal/ZIP code

Example:

"94105"

address.country

string

required

Country code (ISO 3166-1 alpha-2)

Example:

"US"

address.line2

string

Street address line 2

Example:

"Apt 4B"

address.city

string

City

Example:

"San Francisco"

address.state

string

State/Province/Region

Example:

"CA"

umaAddress

string

Optional UMA address identifier. If not provided during customer creation, one will be generated by the system. If provided during customer update, the UMA address will be updated to the provided value. This is an optional identifier to route payments to the customer.

Example:

"[email protected]"

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,

BUSINESS

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:

"[email protected]"

string

System-generated unique identifier

Example:

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

kycStatus

enum<string>

The current KYC status of a customer

Available options:

APPROVED,

REJECTED,

PENDING_REVIEW,

EXPIRED,

CANCELED,

MANUALLY_APPROVED,

MANUALLY_REJECTED

Example:

"APPROVED"

createdAt

string<date-time>

Creation timestamp

Example:

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

updatedAt

string<date-time>

Last update timestamp

Example:

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

isDeleted

boolean

Whether the customer is marked as deleted

Example:

false

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

address.line1

string

required

Street address line 1

Example:

"123 Main Street"

address.postalCode

string

required

Postal/ZIP code

Example:

"94105"

address.country

string

required

Country code (ISO 3166-1 alpha-2)

Example:

"US"

address.line2

string

Street address line 2

Example:

"Apt 4B"

address.city

string

City

Example:

"San Francisco"

address.state

string

State/Province/Region

Example:

"CA"

Delete customer by ID Get a KYC link for onboarding a customer

⌘I

Using the API

API documentation

Authorizations

Path Parameters

Body

Response