---
title: "Get platform configuration"
method: GET
path: "/config"
tags: ["Platform Configuration"]
---

# Get platform configuration

`GET /config`

Retrieve the current platform configuration

## Response `200`

Successful operation

- PlatformConfig
  - `id` string — System-generated unique identifier
  - `umaDomain` string — UMA domain for this platform
  - `proxyUmaSubdomain` string — The subdomain that incoming requests will be proxied to
  - `webhookEndpoint` string — URL where webhook notifications will be sent
  - `supportedCurrencies` PlatformCurrencyConfig[] — List of currencies supported by the platform. This is what the platform's customers are able to hold, send, and receive.
    - `currencyCode` string, required — Three-letter currency code (ISO 4217)
    - `minAmount` integer, required — Minimum amount that can be sent in the smallest unit of this currency
    - `maxAmount` integer, required — Maximum amount that can be sent in the smallest unit of this currency
    - `requiredCounterpartyFields` CounterpartyFieldDefinition[], required — 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.
      - `name` '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', required — Name of a type of field containing info about a platform's customer or counterparty customer.
      - `mandatory` boolean, required — Whether the field is mandatory
    - `providerRequiredCustomerFields` CustomerInfoFieldName[] — 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.
    - `providerRequiredCounterpartyCustomerFields` CustomerInfoFieldName[] — 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.
    - `enabledTransactionTypes` TransactionType[], required — List of transaction types that are enabled for this currency.
  - `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.
  - `createdAt` string, date-time — Creation timestamp
  - `updatedAt` string, date-time — Last update timestamp

## Other responses

- `401` — Unauthorized
- `500` — Internal service error

## Changes

- **2026-02-05** `42f104b10868` — 4 breaking, 4 warning
  - the `status` response property const value `401` was removed for the status `401`
  - the `status` response property const value `401` was removed for the status `401`
  - the `status` response property const value `500` was removed for the status `500`
  - the `status` response property const value `500` was removed for the status `500`
  - …4 more

[Change history](https://skmtc.dev/lightsparkdev/apis/grid-api/changes/config/get.md)

---

[API](https://skmtc.dev/lightsparkdev/apis/grid-api.md) · [All operations](https://skmtc.dev/lightsparkdev/apis/grid-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/lightsparkdev/grid-api/revisions/9d1655bef82d/schema)