Lightspark Agent Management API
Endpoints for creating and managing agents (experimental), called by the partner's backend using platform credentials. Covers the full agent lifecycle: creation, policy configuration, pausing, deletion, the device code installation flow, and approving or rejecting transactions initiated by agents.
Lightspark Agent Management API is one of 22 APIs that Lightspark publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Agent Management. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 12 operations across 9 paths, and defines 208 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.
12 operations
9 paths
208 schemas
1 DELETE4 GET2 PATCH5 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Lightspark Agent Management 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 12
Across 9 paths, the API surfaces 12 operations — 1 DELETE, 4 GET, 2 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.
Agent Management 12
Endpoints for creating and managing agents (experimental), called by the partner's backend using platform credentials. Covers the full agent lifecycle: creation, policy configurat…
POST
/agents
Create an agent
GET
/agents
List agents
GET
/agents/approvals
List agent transaction approval requests
GET
/agents/{agentId}
Get agent by ID
PATCH
/agents/{agentId}
Update agent
DELETE
/agents/{agentId}
Delete agent
PATCH
/agents/{agentId}/policy
Update agent policy
POST
/agents/{agentId}/device-codes
Regenerate a device code
POST
/agents/{agentId}/actions/{actionId}/approve
Approve an agent action
POST
/agents/{agentId}/actions/{actionId}/reject
Reject an agent action
GET
/agents/device-codes/{code}/status
Get device code status
POST
/agents/device-codes/{code}/redeem
Redeem device code
Schemas 208
The contract defines 208 schemas that model the data the API accepts and returns. The most detailed are CardTransaction (20 properties), Quote (18 properties), Transaction (14 properties), AgentAction (12 properties). Each schema is shown below with its type and property counts.
PaymentEmbeddedWalletInfo
EurAccountInfoBase
object
3 properties
2 required
PaymentBwpAccountInfo
QuoteSourceType
string
Type of quote funding source
AgentDeviceCodeRedeemResponse
object
4 properties
4 required
PaymentSlvAccountInfo
PaymentVndAccountInfo
TzsAccountInfo
PaymentBrlAccountInfo
PaymentJmdAccountInfo
PaymentHkdAccountInfo
Agent
object
A programmatic agent with scoped permissions and a spending policy, used to automate payment workflows.
9 properties
9 required
Error404
object
4 properties
3 required
InrAccountInfo
TransactionStatus
string
Status of a payment transaction. | Status | Description | |--------|-------------| | CREATED | Initial lookup has been created | | PENDING | Quote has been cre…
GtqAccountInfoBase
object
4 properties
4 required
CadAccountInfoBase
object
4 properties
4 required
EgpAccountInfo
PaymentNgnAccountInfo
QuoteDestinationOneOf
PaymentHtgAccountInfo
BaseWalletInfo
object
2 properties
2 required
BaseTransactionDestination
object
2 properties
1 required
PaymentEgpAccountInfo
AgentTransferDetails
object
Details of a transfer-type agent action (TRANSFEROUT or TRANSFERIN).
4 properties
4 required
GbpAccountInfoBase
object
3 properties
3 required
AgentActionListResponse
object
4 properties
2 required
PaymentRail
string
The payment rail used for the transfer. Payment rails represent the underlying payment network or system used to move funds between accounts.
PaymentSparkWalletInfo
ThbAccountInfo
MwkAccountInfo
OutgoingRateDetails
object
Details about the rate and fees for an outgoing transaction or quote. Note: counterpartyFixedFee is denominated in the receiving currency, so its equivalent va…
6 properties
6 required
XafAccountInfo
PaymentPhpAccountInfo
PaymentKesAccountInfo
OutgoingTransactionStatus
string
Status of an outgoing payment transaction. | Status | Description | |--------|-------------| | PENDING | Quote is pending confirmation | | PENDINGAUTHORIZATION…
DkkAccountInfo
Error409
object
4 properties
3 required
CardPullSummary
object
3 properties
2 required
PaymentBdtAccountInfo
HtgAccountInfo
CurrencyAmount
object
2 properties
2 required
IncomingTransaction
MyrAccountInfoBase
object
4 properties
4 required
TransactionSourceOneOf
OutgoingTransactionFailureReason
string
Reason for failure of an outgoing transaction. This is used to provide more context on why a transaction failed. If the transaction is not in a failed state, t…
AgentUpdateRequest
object
Partial update to an agent's basic fields. At least one field must be provided.
2 properties
PaymentSwiftAccountInfo
Error400
object
4 properties
3 required
HtgAccountInfoBase
object
2 properties
2 required
IdrAccountInfoBase
object
5 properties
5 required
PaymentThbAccountInfo
Error500
object
4 properties
3 required
RwfAccountInfo
AgentAction
object
An action submitted by an agent that may require platform approval before execution. All agent-initiated operations (quote execution, transfers) are represente…
12 properties
8 required
HkdAccountInfoBase
object
4 properties
4 required
SwiftAccountInfoBase
object
6 properties
4 required
EurAccountInfo
PaymentZarAccountInfo
PaymentInstructions
object
3 properties
1 required
BasePaymentAccountInfo
object
1 property
1 required
ZarAccountInfo
ZmwAccountInfo
AgentPermission
string
Permission granted to an agent that determines what actions it can perform. VIEWTRANSACTIONS: Can list and retrieve transactions and account balances. CREATETR…
PaymentXofAccountInfo
IncomingTransactionFailureReason
string
Reason for failure of an incoming transaction. This is used to provide more context on why a transaction failed. If the transaction is not in a failed state, t…
AccountTransactionSource
BaseQuoteSource
object
1 property
1 required
KesAccountInfoBase
object
3 properties
3 required
PaymentSolanaWalletInfo
AgentCreateResponse
object
Response returned when an agent is created, including the agent and a device code for installation.
2 properties
2 required
UgxAccountInfoBase
object
3 properties
3 required
MxnAccountInfoBase
object
2 properties
2 required
TransactionType
string
Type of transaction (incoming payment or outgoing payment)
InrAccountInfoBase
object
Required fields depend on the selected paymentRails: - NEFT: accountNumber, ifsc, rail - RTGS: accountNumber, ifsc, rail - UPI: vpa
6 properties
1 required
PolygonWalletInfo
object
2 properties
2 required
PaymentTzsAccountInfo
TransactionDirection
string
Whether the transaction credits (funds in) or debits (funds out) the customer's account. Independent of type: an incoming transaction is normally a CREDIT, but…
IdrAccountInfo
PaymentCadAccountInfo
PaymentZmwAccountInfo
AgentCreateRequest
object
3 properties
3 required
AccountDestination
PaymentUsdAccountInfo
Quote
object
18 properties
13 required
MwkAccountInfoBase
object
3 properties
3 required
Error401
object
4 properties
3 required
TransactionDestinationOneOf
RealtimeFundingTransactionSource
SolanaWalletInfo
object
2 properties
2 required
RwfAccountInfoBase
object
3 properties
3 required
PaymentAedAccountInfo
SlvAccountInfoBase
object
Required fields depend on the selected paymentRails: - BANKTRANSFER: bankAccountType, accountNumber - MOBILEMONEY: phoneNumber
5 properties
1 required
JmdAccountInfo
PhpAccountInfoBase
object
3 properties
3 required
GhsAccountInfoBase
object
Required fields depend on the selected paymentRails: - BANKTRANSFER: accountNumber, bankName - MOBILEMONEY: bankName, phoneNumber
4 properties
2 required
AgentActionType
string
The type of action the agent is requesting. | Type | Description | |------|-------------| | EXECUTEQUOTE | Execute a cross-currency quote | | TRANSFEROUT | Tra…
AedAccountInfoBase
object
3 properties
2 required
MxnAccountInfo
PaymentPolygonWalletInfo
GhsAccountInfo
PaymentRwfAccountInfo
OutgoingTransaction
BdtAccountInfo
ReconciliationInstructions
object
Instructions for reconciling a payment with this transaction. For the on-chain transaction to or from an external crypto wallet that is the transaction's own s…
2 properties
EthereumWalletInfo
object
2 properties
2 required
CardTransaction
object
Parent transaction row for a card authorization and all of the pulls / settlements / refunds that reconcile against it. Child events are rolled up into the pul…
20 properties
12 required
TronWalletInfo
object
2 properties
2 required
CardSettlementSummary
object
2 properties
2 required
PaymentInrAccountInfo
PaymentAccountType
string
Type of payment account or wallet
UmaAddressDestination
CardRefundSummary
object
2 properties
2 required
AgentPolicy
object
Policy governing what an agent can do, how it executes actions, and its spending boundaries.
5 properties
3 required
PaymentEurAccountInfo
CardTransactionStatus
string
Lifecycle status of a card transaction. | Status | Description | |--------|-------------| | AUTHORIZED | The auth has been approved and a hold placed on the fu…
AgentExecutionMode
string
Execution mode controlling whether agent actions require human approval. AUTO: The agent can execute actions autonomously without explicit approval. APPROVALRE…
CnyAccountInfoBase
object
Required fields depend on the selected paymentRails: - BANKTRANSFER: accountNumber, bankName - MOBILEMONEY: bankName, phoneNumber
4 properties
2 required
TransactionOneOf
CounterpartyInformation
object
Additional information about the counterparty, if available and relevant to the transaction and platform.
UmaAddressTransactionSource
DestinationType
string
Type of payment destination
KesAccountInfo
QuoteSourceOneOf
GbpAccountInfo
AccountTransactionDestination
OnChainTransaction
object
2 properties
2 required
CryptoNetwork
string
The blockchain network an on-chain transaction settled on. Whether this is the mainnet or a test network (e.g. Solana devnet) is determined by your platform's…
JmdAccountInfoBase
object
5 properties
5 required
TransactionSourceType
string
Type of transaction source
TransactionDestinationType
string
Type of transaction destination
CnyAccountInfo
UgxAccountInfo
SwiftAccountInfo
AgentAccountRule
object
Per-account policy override that takes precedence over the agent's default policy for a specific account.
3 properties
1 required
PaymentMwkAccountInfo
BwpAccountInfo
Transaction
object
14 properties
7 required
RailSelectionMode
string
How the payment rail was chosen — MANUAL when the platform specified a paymentRail on the destination, AUTO when Lightspark selects it.
NgnAccountInfoBase
object
3 properties
3 required
BaseDestination
object
1 property
1 required
PaymentIdrAccountInfo
SlvAccountInfo
AgentSpendingLimitsUpdate
object
Partial update to spending limits. Only provided fields will be updated; omitted fields retain their current values.
5 properties
PaymentLightningInvoiceInfo
AgentActionRejectRequest
object
1 property
AedAccountInfo
TzsAccountInfoBase
object
3 properties
3 required
PaymentSgdAccountInfo
ThbAccountInfoBase
object
4 properties
4 required
PhpAccountInfo
PaymentCnyAccountInfo
PaymentGtqAccountInfo
NgnAccountInfo
XafAccountInfoBase
object
4 properties
4 required
ScaChallenge
object
A Strong Customer Authentication challenge that must be satisfied before a money-movement operation can complete. This object is only present when the customer…
7 properties
4 required
PaymentEthereumWalletInfo
PaymentPkrAccountInfo
AgentActionStatus
string
Status of an agent action. | Status | Description | |--------|-------------| | PENDINGAPPROVAL | Submitted by the agent, awaiting platform approval before exec…
BdtAccountInfoBase
object
Required fields depend on the selected paymentRails: - BANKTRANSFER: accountNumber, bankName - MOBILEMONEY: bankName, phoneNumber
6 properties
2 required
PaymentUgxAccountInfo
MyrAccountInfo
RealtimeFundingQuoteSource
UsdAccountInfoBase
object
3 properties
3 required
XofAccountInfoBase
object
4 properties
4 required
PaymentBaseWalletInfo
VndAccountInfo
PkrAccountInfo
PkrAccountInfoBase
object
Required fields depend on the selected paymentRails: - BANKTRANSFER: accountNumber, bankName - MOBILEMONEY: bankName, phoneNumber
5 properties
2 required
PaymentMxnAccountInfo
EgpAccountInfoBase
object
Required fields depend on the selected paymentRails: - BANKTRANSFER: bankName, iban - MOBILEMONEY: bankName, phoneNumber
4 properties
2 required
ScaFactor
string
A Strong Customer Authentication factor. | Factor | Description | |--------|-------------| | SMSOTP | One-time code sent by SMS to the customer's verified phon…
PaymentXafAccountInfo
SparkWalletInfo
object
2 properties
2 required
DkkAccountInfoBase
object
3 properties
2 required
PaymentCopAccountInfo
ZmwAccountInfoBase
object
3 properties
3 required
VndAccountInfoBase
object
4 properties
4 required
AgentAccountRestrictions
object
Optional restrictions that limit the agent to specific accounts or override policy per account.
2 properties
BaseTransactionSource
object
2 properties
1 required
AgentUsage
object
Real-time counters tracking the agent's spending and transaction activity against its policy limits.
5 properties
3 required
IncomingRateDetails
object
Details about the rate and fees for an incoming transaction. Note: gridApiFixedFee is denominated in the receiving currency, so its equivalent value in the sen…
4 properties
4 required
PaymentGhsAccountInfo
AgentSpendingLimits
object
Spending limits that cap the agent's transaction amounts and frequency. All amount fields are integers in the smallest unit of the specified currency. When a t…
5 properties
2 required
PaymentDkkAccountInfo
PaymentMyrAccountInfo
AgentApprovalThresholds
object
Thresholds that force approval for high-value transactions, overriding the default execution mode. When a transaction is denominated in a different currency th…
2 properties
UmaAddressTransactionDestination
AccountQuoteSource
PaymentGbpAccountInfo
HkdAccountInfo
Currency
object
4 properties
BwpAccountInfoBase
object
3 properties
3 required
AgentPolicyUpdateRequest
object
Partial update to an agent's policy. Only provided fields will be updated; omitted fields retain their current values.
5 properties
Refund
object
5 properties
3 required
SgdAccountInfo
AgentDeviceCode
object
4 properties
4 required
AgentDeviceCodeStatusResponse
object
2 properties
2 required
ZarAccountInfoBase
object
3 properties
3 required
AgentListResponse
object
4 properties
2 required
PaymentArsAccountInfo
SgdAccountInfoBase
object
4 properties
3 required
CadAccountInfo
CardMerchant
object
3 properties
1 required
UsdAccountInfo
XofAccountInfo
GtqAccountInfo
PaymentTronWalletInfo
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Lightspark 12
Other APIs Lightspark publishes across the network.
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 Customers API
Lightspark Discoveries API
Lightspark Documents API
Lightspark Embedded Wallet Auth API
Lightspark Exchange Rates API
Lightspark External Accounts API
#Agent Management
Where this information came from
This is an independent, third-party profile of Lightspark Agent Management 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.