How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Lightspark Customers API

Customer management endpoints for creating and updating customer information

Lightspark Customers API is one of 22 APIs that Lightspark publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Customers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 7 operations across 4 paths, and defines 46 schemas. It is described by OpenAPI 3.1.0, at version 2025-10-13.

Requests are made against a single base URL, https://api.lightspark.com/grid/2025-10-13.

7 operations 4 paths 46 schemas 1 DELETE3 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2025-10-13
Base URL
https://api.lightspark.com/grid/2025-10-13
Authentication
HTTP Basic, HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 3

Lightspark Customers API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). It accepts HTTP bearer tokens (AgentAuth). An API key is passed in the header as X-Grid-Signature (WebhookSignature). By default, every request must be authenticated.

  • BasicAuth — API token authentication using format :
  • AgentAuth — Bearer token authentication for agent-scoped endpoints. The token is the accessToken returned when redeeming a device code via POST /agents/device-codes/{code}…
  • WebhookSignature — Secp256r1 (P-256) asymmetric signature of the webhook payload, which can be used to verify that the webhook was sent by Grid. To verify the signature: 1. Get t…

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Customers 7

Customer management endpoints for creating and updating customer information

POST
/customers
Add a new customer
createCustomer body → 201400401405409500501
GET
/customers
List customers
listCustomers 12 params → 200400401405500
GET
/customers/{customerId}
Get customer by ID
getCustomerById 1 param → 200401404500
PATCH
/customers/{customerId}
Update customer by ID
updateCustomerById 3 params body → 200202400401404409424500
DELETE
/customers/{customerId}
Delete customer by ID
deleteCustomerById 1 param → 200401404410500
POST
/customers/bulk/csv
Upload customers via CSV file
uploadCustomersCsv body → 202401500
GET
/customers/bulk/jobs/{jobId}
Get bulk import job status
getBulkCustomerImportJob 1 param → 200401404500

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are BusinessInfo (19 properties), BusinessInfoUpdate (19 properties), BusinessInfoResponse (19 properties), Customer (12 properties). Each schema is shown below with its type and property counts.

BeneficialOwnerPersonalInfo
object
11 properties 7 required
Error424
object
4 properties 3 required
IndividualCustomerFields
object
6 properties 1 required
Address
object
6 properties 3 required
BeneficialOwner
object
8 properties 7 required
BusinessCustomerCreateRequest
BulkCustomerImportJobAccepted
object
2 properties 2 required
CustomerListResponse
object
4 properties 2 required
Error404
object
4 properties 3 required
Customer
object
12 properties 3 required
CustomerType
string
Whether the customer is an individual or a business entity
PurposeOfAccount
string
The intended purpose for using the Grid account
BusinessCustomerFields
object
4 properties 1 required
Error401
object
4 properties 3 required
BulkCustomerImportErrorEntry
BusinessType
string
The high-level industry category of the business
IdentificationType
string
Type of tax identification
SignedRequestChallenge
object
Common base for two-step signed-retry challenge responses on Embedded Wallet endpoints (credential registration or revocation, session refresh or revocation, w…
3 properties 3 required
IndividualCustomer
BusinessInfo
object
Additional information required for business entities
19 properties 3 required
Error410
object
4 properties 3 required
CustomerCreateRequest
object
7 properties 1 required
Error501
object
4 properties 3 required
GridError
object
3 properties
SourceOfFundsCategory
string
A structured source-of-funds category for the business
Error409
object
4 properties 3 required
EntityType
string
Legal entity type of the business
BusinessInfoUpdate
object
Additional information for business entities
19 properties
CustomerOneOf
CustomerUpdateRequest
object
Request body for PATCH /customers/{customerId}. When email changes for a customer with tied Embedded Wallet internal accounts, Grid updates the customer email…
5 properties 1 required
IndividualCustomerUpdateRequest
BusinessCustomer
ContactVerificationStatus
string
Status of an individual contact-verification channel (email or phone). PENDING means verification is required but not yet completed; VERIFIED means the channel…
CustomerUpdateRequestOneOf
KybStatus
string
The current KYB status of a business customer. HOLD means the customer is placed on hold and may be required to update or provide more information.
IndividualCustomerCreateRequest
Error400
object
4 properties 3 required
ContactVerification
object
Email and/or phone verification state for the customer. This object is only present when the customer's regulatory jurisdiction requires contact verification (…
2 properties
BeneficialOwnerRole
string
Role of the beneficial owner within the business
CustomerCreateRequestOneOf
BusinessCustomerUpdateRequest
Error500
object
4 properties 3 required
KycStatus
string
The current KYC status of a customer. HOLD means the customer is placed on hold and may be required to update or provide more information.
Error405
object
4 properties 3 required
BusinessInfoResponse
object
Business information returned on a customer. taxId and incorporatedOn are required on creation but may be absent on legacy customers that pre-date the requirem…
19 properties 1 required
BulkCustomerImportJob
object
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lightspark-customers-api-openapi.yml Raw ↑

Other APIs Lightspark publishes across the network.

Lightspark Agent Management API
Lightspark Agent Operations API
Lightspark API Tokens API
Lightspark Available UMA Providers API
Lightspark Cards API
Lightspark Contact Verification API
Lightspark Cross-Currency Transfers API
Lightspark Discoveries API
Lightspark Documents API
Lightspark Embedded Wallet Auth API
Lightspark Exchange Rates API
Lightspark External Accounts API
Where this information came from

This is an independent, third-party profile of Lightspark Customers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.