Get platform configuration

Retrieve the current platform configuration

GET /config

cURL

cURL

curl --request GET \
  --url https://api.lightspark.com/grid/2025-10-13/config \
  --header 'Authorization: Basic <encoded-value>'

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.retrieve();

console.log(platformConfig.id);

package com.lightspark.grid.example

import com.lightspark.grid.client.LightsparkGridClient
import com.lightspark.grid.client.okhttp.LightsparkGridOkHttpClient
import com.lightspark.grid.models.config.ConfigRetrieveParams
import com.lightspark.grid.models.config.PlatformConfig

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

    val platformConfig: PlatformConfig = client.config().retrieve()
}

200

{
  "id": "PlatformConfig:019542f5-b3e7-1d02-0000-000000000003",
  "umaDomain": "platform.uma.domain",
  "proxyUmaSubdomain": "platform",
  "webhookEndpoint": "https://api.mycompany.com/webhooks/uma",
  "supportedCurrencies": [
    {
      "currencyCode": "USD",
      "minAmount": 100,
      "maxAmount": 1000000,
      "requiredCounterpartyFields": [
        {
          "name": "FULL_NAME",
          "mandatory": true
        },
        {
          "name": "BIRTH_DATE",
          "mandatory": true
        },
        {
          "name": "NATIONALITY",
          "mandatory": true
        }
      ],
      "enabledTransactionTypes": [
        "OUTGOING",
        "INCOMING"
      ],
      "providerRequiredCustomerFields": [
        "NATIONALITY",
        "BIRTH_DATE"
      ],
      "providerRequiredCounterpartyCustomerFields": [
        "FULL_NAME",
        "COUNTRY_OF_RESIDENCE"
      ]
    }
  ],
  "isRegulatedFinancialInstitution": false,
  "embeddedWalletConfig": {
    "appName": "Acme Wallet",
    "otpLength": 6,
    "alphanumeric": false,
    "expirationSeconds": 300,
    "sendFromEmailAddress": "[e-mail]",
    "sendFromEmailSenderName": "Acme Notifications",
    "replyToEmailAddress": "[e-mail]",
    "logoUrl": "https://acme.com/logo.png"
  },
  "createdAt": "2025-06-15T12:30:45Z",
  "updatedAt": "2025-06-15T12:30:45Z"
}

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

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

Authorizations

Authorization · string · header · required

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

Response

200

application/json

Successful operation

id · string · read-only

System-generated unique identifier

Example:

"PlatformConfig:019542f5-b3e7-1d02-0000-000000000003"

umaDomain · string

UMA domain for this platform

Example:

"platform.uma.domain"

proxyUmaSubdomain · string

The subdomain that incoming requests will be proxied to

Example:

"platform"

webhookEndpoint · string

URL where webhook notifications will be sent

Example:

"https://api.mycompany.com/webhooks/uma"

supportedCurrencies · object[]

List of currencies supported by the platform. This is what the platform's customers are able to hold, send, and receive.

Show child attributes

isRegulatedFinancialInstitution · boolean

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 · object

Embedded-wallet branding and OTP settings for this platform. Present only when the platform has configured embedded-wallet support; omitted otherwise.

Show child attributes

createdAt · string<date-time> · read-only

Creation timestamp

Example:

"2025-06-15T12:30:45Z"

updatedAt · string<date-time> · read-only

Last update timestamp

Example:

"2025-06-15T12:30:45Z"