> ## Documentation Index > Fetch the complete documentation index at: https://docs.lightspark.com/llms.txt > Use this file to discover all available pages before exploring further. # Update platform configuration > Update the platform configuration settings ## OpenAPI ````yaml https://app.stainless.com/api/spec/documented/grid/openapi.documented.yml patch /config openapi: 3.1.0 info: title: Grid API description: > API for managing global payments on the open Money Grid. Built by Lightspark. See the full documentation at https://docs.lightspark.com/. version: '2025-10-13' contact: name: Lightspark Support email: support@lightspark.com license: name: Proprietary url: https://lightspark.com/terms servers: - url: https://api.lightspark.com/grid/2025-10-13 description: Production server security: - BasicAuth: [] - AgentAuth: [] tags: - name: Platform Configuration description: >- Platform configuration endpoints for managing global settings. You can also configure these settings in the Grid dashboard. - name: Customers description: >- Customer management endpoints for creating and updating customer information - name: KYC/KYB Verifications description: >- Endpoints for Know Your Customer (KYC) and Know Your Business (KYB) verification, including managing beneficial owners and triggering verification for customers. - name: Documents description: >- Endpoints for uploading and managing verification documents for customers and beneficial owners. Supports KYC and KYB document requirements. - name: Internal Accounts description: >- Internal account management endpoints for creating and managing internal accounts - name: External Accounts description: >- External account management endpoints for creating and managing external bank accounts - name: Same-Currency Transfers description: >- Endpoints for transferring funds between internal and external accounts with the same currency - name: Cross-Currency Transfers description: Endpoints for creating and confirming quotes for cross-currency transfers - name: Transactions description: Endpoints for retrieving transaction information - name: Webhooks description: Webhook endpoints and configuration for receiving notifications - name: Invitations description: Endpoints for creating, claiming and managing UMA invitations - name: Sandbox description: Endpoints to trigger test cases in sandbox - name: API Tokens description: Endpoints to programmatically manage API tokens - name: Exchange Rates description: >- Endpoints for retrieving cached foreign exchange rates. Rates are cached for approximately 5 minutes and include platform-specific fees. - name: Discoveries description: >- Endpoints for discovering available payment rails, banks, and providers for a given country and currency corridor. - name: Embedded Wallet Auth description: >- Endpoints for registering and verifying end-user authentication credentials (email OTP, OAuth, passkey) used to sign Embedded Wallet actions. - name: Agent Management description: >- 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. - name: Agent Operations description: >- Endpoints called by the agent itself using its own credentials (obtained via device code redemption). Scoped to the agent's associated customer — all requests automatically operate on behalf of that customer and are subject to the agent's policy. When an action requires approval, the resulting transaction enters a pending state and must be approved by the platform via `POST /transactions/{transactionId}/approve`. - name: Cards description: >- Card management endpoints. Issue debit cards against an internal account, freeze / unfreeze, close, manage card funding sources, and list card transactions. paths: /config: patch: tags: - Platform Configuration summary: Update platform configuration description: Update the platform configuration settings operationId: updatePlatformConfig requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PlatformConfigUpdateRequest' example: umaDomain: mycompany.com webhookEndpoint: https://api.mycompany.com/webhooks/uma supportedCurrencies: - currencyCode: USD minAmount: 100 maxAmount: 1000000 enabledTransactionTypes: - OUTGOING - INCOMING requiredCounterpartyFields: - name: FULL_NAME mandatory: true - name: NATIONALITY mandatory: true - name: BIRTH_DATE mandatory: true embeddedWalletConfig: appName: Acme Wallet sendFromEmailAddress: noreply@acme.com sendFromEmailSenderName: Acme Notifications replyToEmailAddress: support@acme.com logoUrl: https://acme.com/logo.png responses: '200': description: Configuration updated successfully content: application/json: schema: $ref: '#/components/schemas/PlatformConfig' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/Error400' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error401' '500': description: Internal service error content: application/json: schema: $ref: '#/components/schemas/Error500' '501': description: Not implemented content: application/json: schema: $ref: '#/components/schemas/Error501' security: - BasicAuth: [] x-codeSamples: - lang: JavaScript source: |- 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 platformConfig = await client.config.update({ embeddedWalletConfig: { appName: 'Acme Wallet', sendFromEmailAddress: 'noreply@acme.com', sendFromEmailSenderName: 'Acme Notifications', replyToEmailAddress: 'support@acme.com', logoUrl: 'https://acme.com/logo.png', }, supportedCurrencies: [ { currencyCode: 'USD', minAmount: 100, maxAmount: 1000000, enabledTransactionTypes: ['OUTGOING', 'INCOMING'], requiredCounterpartyFields: [ { name: 'FULL_NAME', mandatory: true }, { name: 'NATIONALITY', mandatory: true }, { name: 'BIRTH_DATE', mandatory: true }, ], }, ], umaDomain: 'mycompany.com', webhookEndpoint: 'https://api.mycompany.com/webhooks/uma', }); console.log(platformConfig.id); - lang: Python source: |- import os from grid import LightsparkGrid client = LightsparkGrid( username=os.environ.get("GRID_CLIENT_ID"), # This is the default and can be omitted password=os.environ.get("GRID_CLIENT_SECRET"), # This is the default and can be omitted ) platform_config = client.config.update( embedded_wallet_config={ "app_name": "Acme Wallet", "send_from_email_address": "noreply@acme.com", "send_from_email_sender_name": "Acme Notifications", "reply_to_email_address": "support@acme.com", "logo_url": "https://acme.com/logo.png", }, supported_currencies=[{ "currency_code": "USD", "min_amount": 100, "max_amount": 1000000, "enabled_transaction_types": ["OUTGOING", "INCOMING"], "required_counterparty_fields": [{ "name": "FULL_NAME", "mandatory": True, }, { "name": "NATIONALITY", "mandatory": True, }, { "name": "BIRTH_DATE", "mandatory": True, }], }], uma_domain="mycompany.com", webhook_endpoint="https://api.mycompany.com/webhooks/uma", ) print(platform_config.id) - lang: Go source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/stainless-sdks/grid-go\"\n\t\"github.com/stainless-sdks/grid-go/option\"\n)\n\nfunc main() {\n\tclient := grid.NewClient(\n\t\toption.WithUsername(\"My Username\"),\n\t\toption.WithPassword(\"My Password\"),\n\t)\n\tplatformConfig, err := client.Config.Update(context.TODO(), grid.ConfigUpdateParams{\n\t\tPlatformConfigUpdateRequest: grid.PlatformConfigUpdateRequestParam{},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", platformConfig.ID)\n}\n" - lang: Kotlin source: |- package com.lightspark.grid.example import com.lightspark.grid.client.LightsparkGridClient import com.lightspark.grid.client.okhttp.LightsparkGridOkHttpClient import com.lightspark.grid.models.config.PlatformConfig import com.lightspark.grid.models.config.PlatformConfigUpdateRequest fun main() { val client: LightsparkGridClient = LightsparkGridOkHttpClient.fromEnv() val params: PlatformConfigUpdateRequest = PlatformConfigUpdateRequest.builder().build() val platformConfig: PlatformConfig = client.config().update(params) } - lang: Ruby source: >- require "grid" lightspark_grid = Grid::Client.new(username: "My Username", password: "My Password") platform_config = lightspark_grid.config.update puts(platform_config) - lang: PHP source: |- config->update( embeddedWalletConfig: [ 'alphanumeric' => false, 'appName' => 'Acme Wallet', 'expirationSeconds' => 300, 'logoURL' => 'https://acme.com/logo.png', 'otpLength' => 6, 'replyToEmailAddress' => 'support@acme.com', 'sendFromEmailAddress' => 'noreply@acme.com', 'sendFromEmailSenderName' => 'Acme Notifications', ], supportedCurrencies: [ [ 'currencyCode' => 'USD', 'enabledTransactionTypes' => [ TransactionType::OUTGOING, TransactionType::INCOMING ], 'maxAmount' => 1000000, 'minAmount' => 100, 'requiredCounterpartyFields' => [ ['mandatory' => true, 'name' => CustomerInfoFieldName::FULL_NAME], ['mandatory' => true, 'name' => CustomerInfoFieldName::BIRTH_DATE], ['mandatory' => true, 'name' => CustomerInfoFieldName::NATIONALITY], ], ], ], umaDomain: 'mycompany.com', webhookEndpoint: 'https://api.mycompany.com/webhooks/uma', ); var_dump($platformConfig); } catch (APIException $e) { echo $e->getMessage(); } - lang: C# source: |- using System; using Grid; using Grid.Models.Config; LightsparkGridClient client = new(); ConfigUpdateParams parameters = new(); var platformConfig = await client.Config.Update(parameters); Console.WriteLine(platformConfig); - lang: CLI source: |- grid config update \ --username 'My Username' \ --password 'My Password' components: schemas: PlatformConfigUpdateRequest: type: object properties: umaDomain: type: string example: mycompany.com webhookEndpoint: type: string example: https://api.mycompany.com/webhooks/uma supportedCurrencies: type: array items: $ref: '#/components/schemas/PlatformCurrencyConfig' embeddedWalletConfig: $ref: '#/components/schemas/EmbeddedWalletConfig' description: > Update or create the embedded-wallet configuration for this platform. Fields omitted from the nested object are left unchanged. Omit this field at the top level to leave the embedded-wallet configuration unchanged entirely. PlatformConfig: type: object properties: id: type: string description: System-generated unique identifier readOnly: true example: PlatformConfig:019542f5-b3e7-1d02-0000-000000000003 umaDomain: type: string description: UMA domain for this platform example: platform.uma.domain proxyUmaSubdomain: type: string description: The subdomain that incoming requests will be proxied to example: platform webhookEndpoint: type: string description: URL where webhook notifications will be sent example: https://api.mycompany.com/webhooks/uma supportedCurrencies: type: array items: $ref: '#/components/schemas/PlatformCurrencyConfig' description: > List of currencies supported by the platform. This is what the platform's customers are able to hold, send, and receive. isRegulatedFinancialInstitution: type: boolean description: > Whether the platform is a regulated financial institution. This is used to determine if the platform's customers must be KYC/KYB'd by Lightspark via the KYC link flow. This can only be set by Lightspark during platform creation. example: false embeddedWalletConfig: $ref: '#/components/schemas/EmbeddedWalletConfig' description: | Embedded-wallet branding and OTP settings for this platform. Present only when the platform has configured embedded-wallet support; omitted otherwise. createdAt: type: string format: date-time description: Creation timestamp readOnly: true example: '2025-06-15T12:30:45Z' updatedAt: type: string format: date-time description: Last update timestamp readOnly: true example: '2025-06-15T12:30:45Z' Error400: type: object required: - message - status - code properties: status: type: integer enum: - 400 description: HTTP status code code: type: string description: > | Error Code | Description | |------------|-------------| | INVALID_INPUT | Invalid input provided | | MISSING_MANDATORY_USER_INFO | Required customer information is missing | | INVITATION_ALREADY_CLAIMED | Invitation has already been claimed | | INVITATIONS_NOT_CONFIGURED | Invitations are not configured | | INVALID_UMA_ADDRESS | UMA address format is invalid | | INVITATION_CANCELLED | Invitation has been cancelled | | QUOTE_REQUEST_FAILED | An issue occurred during the quote process; this is retryable | | INVALID_PAYREQ_RESPONSE | Counterparty Payreq response was invalid | | INVALID_RECEIVER | Receiver is invalid | | PARSE_PAYREQ_RESPONSE_ERROR | Error parsing receiver PayReq response | | CERT_CHAIN_INVALID | Counterparty certificate chain is invalid | | CERT_CHAIN_EXPIRED | Counterparty certificate chain has expired | | INVALID_PUBKEY_FORMAT | Counterparty Public key format is invalid | | MISSING_REQUIRED_UMA_PARAMETERS | Counterparty required UMA parameters are missing | | SENDER_NOT_ACCEPTED | Sender is not accepted | | AMOUNT_OUT_OF_RANGE | Amount is out of range | | INVALID_CURRENCY | Currency is invalid | | INVALID_TIMESTAMP | Timestamp is invalid | | INVALID_NONCE | Nonce is invalid | | INVALID_REQUEST_FORMAT | Request format is invalid | | INVALID_BANK_ACCOUNT | Bank account is invalid | | SELF_PAYMENT | Self payment not allowed | | LOOKUP_REQUEST_FAILED | Lookup request failed | | PARSE_LNURLP_RESPONSE_ERROR | Error parsing LNURLP response | | INVALID_AMOUNT | Amount is invalid | | WEBHOOK_ENDPOINT_NOT_SET | Webhook endpoint is not set | | WEBHOOK_DELIVERY_ERROR | Webhook delivery error | | LOW_QUALITY | Document quality too low to process | | DATA_MISMATCH | Document details don't match provided information | | EXPIRED | Document has expired | | SUSPECTED_FRAUD | Document suspected of being forged or edited | | UNSUITABLE_DOCUMENT | Document type is not accepted or not supported | | INCOMPLETE | Document is missing pages or sides | | EMAIL_OTP_CREDENTIAL_ALREADY_EXISTS | An EMAIL_OTP credential is already registered on the target internal account; only one email OTP credential is supported per internal account at this time | | PASSKEY_CREDENTIAL_ALREADY_EXISTS | A PASSKEY credential with the same WebAuthn credentialId is already registered on the target internal account | enum: - INVALID_INPUT - MISSING_MANDATORY_USER_INFO - INVITATION_ALREADY_CLAIMED - INVITATIONS_NOT_CONFIGURED - INVALID_UMA_ADDRESS - INVITATION_CANCELLED - QUOTE_REQUEST_FAILED - INVALID_PAYREQ_RESPONSE - INVALID_RECEIVER - PARSE_PAYREQ_RESPONSE_ERROR - CERT_CHAIN_INVALID - CERT_CHAIN_EXPIRED - INVALID_PUBKEY_FORMAT - MISSING_REQUIRED_UMA_PARAMETERS - SENDER_NOT_ACCEPTED - AMOUNT_OUT_OF_RANGE - INVALID_CURRENCY - INVALID_TIMESTAMP - INVALID_NONCE - INVALID_REQUEST_FORMAT - INVALID_BANK_ACCOUNT - SELF_PAYMENT - LOOKUP_REQUEST_FAILED - PARSE_LNURLP_RESPONSE_ERROR - INVALID_AMOUNT - WEBHOOK_ENDPOINT_NOT_SET - WEBHOOK_DELIVERY_ERROR - LOW_QUALITY - DATA_MISMATCH - EXPIRED - SUSPECTED_FRAUD - UNSUITABLE_DOCUMENT - INCOMPLETE - EMAIL_OTP_CREDENTIAL_ALREADY_EXISTS - PASSKEY_CREDENTIAL_ALREADY_EXISTS message: type: string description: Error message details: type: object description: Additional error details additionalProperties: true Error401: type: object required: - message - status - code properties: status: type: integer enum: - 401 description: HTTP status code code: type: string description: > | Error Code | Description | |------------|-------------| | UNAUTHORIZED | Issue with API credentials | | INVALID_SIGNATURE | Signature header is invalid | | WALLET_SIGNATURE_MISSING | The `Grid-Wallet-Signature` header is required for this Embedded Wallet action but was not supplied | | WALLET_SIGNATURE_MALFORMED | The `Grid-Wallet-Signature` header could not be parsed (bad encoding, structure, or fields) | | WALLET_SIGNATURE_BODY_MISMATCH | The `Grid-Wallet-Signature` was computed over a different request body than the one received | | WALLET_SIGNATURE_INVALID | The `Grid-Wallet-Signature` failed cryptographic verification against the registered credential | | REQUEST_ID_MISSING | The `Request-Id` header is required on the signed retry but was not supplied (paired with `Grid-Wallet-Signature`) | enum: - UNAUTHORIZED - INVALID_SIGNATURE - WALLET_SIGNATURE_MISSING - WALLET_SIGNATURE_MALFORMED - WALLET_SIGNATURE_BODY_MISMATCH - WALLET_SIGNATURE_INVALID - REQUEST_ID_MISSING message: type: string description: Error message details: type: object description: Additional error details additionalProperties: true Error500: type: object required: - message - status - code properties: status: type: integer enum: - 500 description: HTTP status code code: type: string description: | | Error Code | Description | |------------|-------------| | GRID_SWITCH_ERROR | Grid switch error | | INTERNAL_ERROR | Internal server or UMA error | enum: - GRID_SWITCH_ERROR - INTERNAL_ERROR message: type: string description: Error message details: type: object description: Additional error details additionalProperties: true Error501: type: object required: - message - status - code properties: status: type: integer enum: - 501 description: HTTP status code code: type: string description: > | Error Code | Description | |------------|-------------| | UNRECOGNIZED_MANDATORY_PAYEE_DATA_KEY | Unrecognized mandatory payee data key | | NOT_IMPLEMENTED | Feature not implemented | enum: - UNRECOGNIZED_MANDATORY_PAYEE_DATA_KEY - NOT_IMPLEMENTED message: type: string description: Error message details: type: object description: Additional error details additionalProperties: true PlatformCurrencyConfig: type: object properties: currencyCode: type: string description: Three-letter currency code (ISO 4217) example: USD minAmount: type: integer format: int64 description: >- Minimum amount that can be sent in the smallest unit of this currency minimum: 0 example: 100 maxAmount: type: integer format: int64 description: >- Maximum amount that can be sent in the smallest unit of this currency minimum: 0 example: 1000000 requiredCounterpartyFields: type: array items: $ref: '#/components/schemas/CounterpartyFieldDefinition' description: >- List of fields which the platform requires from the counterparty institutions about counterparty customers. Platforms can set mandatory to false if the platform does not require the field, but would like to have it available. Some fields may be required by the underlying UMA provider. example: - name: FULL_NAME mandatory: true - name: BIRTH_DATE mandatory: true - name: NATIONALITY mandatory: true providerRequiredCustomerFields: type: array items: $ref: '#/components/schemas/CustomerInfoFieldName' description: >- List of customer info field names that are required by the underlying UMA provider when creating a customer for this currency. These fields must be supplied when creating or updating a customer if this currency is intended to be used by that customer. If no fields are required, this field is omitted. readOnly: true example: - NATIONALITY - BIRTH_DATE providerRequiredCounterpartyCustomerFields: type: array items: $ref: '#/components/schemas/CustomerInfoFieldName' description: >- List of fields that are required by the underlying UMA provider for this currency. If the counterparty does not provide these fields, quote requests will fail. readOnly: true example: - FULL_NAME - COUNTRY_OF_RESIDENCE enabledTransactionTypes: type: array items: $ref: '#/components/schemas/TransactionType' description: List of transaction types that are enabled for this currency. example: - OUTGOING - INCOMING required: - currencyCode - minAmount - maxAmount - requiredCounterpartyFields - enabledTransactionTypes EmbeddedWalletConfig: type: object description: | Per-platform embedded-wallet configuration. Controls branding and OTP behavior for the email sent when a customer authenticates with an EMAIL_OTP credential. Fields omitted from a request are left unchanged. properties: appName: type: string maxLength: 255 description: App name displayed in the default OTP email template. example: Acme Wallet otpLength: type: integer minimum: 4 maximum: 12 description: | Number of digits / characters in the OTP code. Defaults to 6 when not set. example: 6 alphanumeric: type: boolean description: | If true, OTP includes letters in addition to digits. Defaults to numeric-only when not set. example: false expirationSeconds: type: integer minimum: 1 maximum: 86400 description: | OTP validity window in seconds. Defaults to 300 when not set. example: 300 sendFromEmailAddress: type: string format: email maxLength: 255 description: Custom sender email address for OTP emails. example: noreply@acme.com sendFromEmailSenderName: type: string maxLength: 255 description: > Custom sender display name. Defaults to "Notifications" when not set. example: Acme Notifications replyToEmailAddress: type: string format: email maxLength: 255 description: Custom reply-to email address for OTP emails. example: support@acme.com logoUrl: type: string format: uri maxLength: 512 description: URL to a PNG logo for the OTP email. Resized to 340x124px. example: https://acme.com/logo.png CounterpartyFieldDefinition: type: object properties: name: $ref: '#/components/schemas/CustomerInfoFieldName' mandatory: type: boolean description: Whether the field is mandatory example: true required: - name - mandatory CustomerInfoFieldName: type: string enum: - FULL_NAME - BIRTH_DATE - NATIONALITY - PHONE_NUMBER - EMAIL - POSTAL_ADDRESS - TAX_ID - REGISTRATION_NUMBER - USER_TYPE - COUNTRY_OF_RESIDENCE - ACCOUNT_IDENTIFIER - FI_LEGAL_ENTITY_NAME - FI_ADDRESS - PURPOSE_OF_PAYMENT - ULTIMATE_INSTITUTION_COUNTRY - IDENTIFIER - BUSINESS_TYPE - COMPANY_LEGAL_NAME - ID_TYPE - ID_NUMBER description: >- Name of a type of field containing info about a platform's customer or counterparty customer. example: FULL_NAME TransactionType: type: string enum: - INCOMING - OUTGOING description: Type of transaction (incoming payment or outgoing payment) securitySchemes: BasicAuth: type: http scheme: basic description: >- API token authentication using format `:` AgentAuth: type: http scheme: bearer description: >- Bearer token authentication for agent-scoped endpoints. The token is the `accessToken` returned when redeeming a device code via `POST /agents/device-codes/{code}/redeem`. Agent credentials are user-scoped: all requests are automatically bound to the agent's associated customer and subject to the agent's policy. ````