---
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' | 'BUSINESS_TYPE' | 'COMPANY_LEGAL_NAME' | 'ID_TYPE' | 'ID_NUMBER', 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.
  - `embeddedWalletConfig` EmbeddedWalletConfig — 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.
    - `appName` string — App name displayed in the default OTP email template.
    - `otpLength` integer — Number of digits / characters in the OTP code. Defaults to 6 when not set.
    - `alphanumeric` boolean — If true, OTP includes letters in addition to digits. Defaults to numeric-only when not set.
    - `expirationSeconds` integer — OTP validity window in seconds. Defaults to 300 when not set.
    - `sendFromEmailAddress` string, email — Custom sender email address for OTP emails.
    - `sendFromEmailSenderName` string — Custom sender display name. Defaults to "Notifications" when not set.
    - `replyToEmailAddress` string, email — Custom reply-to email address for OTP emails.
    - `logoUrl` string, uri — URL to a PNG logo for the OTP email. Resized to 340x124px.
  - `cardTokenization2faConfig` CardTokenization2FAConfig — Per-platform branding for authentication codes sent when a cardholder adds a Grid-issued card to a digital wallet. Updates apply to subsequent delivery attempts. Invalid sender or provider configuration can cause delivery to fail.
    - `displayName` string — Platform name displayed in authentication messages.
    - `logoUrl` string, uri — HTTPS URL of the logo displayed in email messages.
    - `email` CardTokenization2FAEmailConfig — Email branding and sender settings for card-tokenization authentication messages. Invalid or unverified sender identities can cause delivery to fail.
      - `fromAddress` string, email — Sender address for card-tokenization authentication emails.
      - `fromName` string — Sender display name.
      - `replyToAddress` string, email — Reply-to address for card-tokenization authentication emails.
      - `subject` string — Subject for the authentication email.
      - `bodyText` string — Plain-text message content. Lightspark inserts the authentication code into a controlled text and HTML template; arbitrary HTML and template variables are not supported.
    - `sms` CardTokenization2FASmsConfig — SMS settings for card-tokenization authentication messages delivered through a Lightspark-managed Twilio sender.
      - `templateSid` string — Twilio Verify template SID to use for this platform. An invalid or unavailable template can cause delivery to fail.
      - `bodyText` string — Plain-text fallback message used when Twilio Verify is unavailable for the authentication code. Lightspark appends the code to this text.
  - `feeConfigs` FeeConfig[] — Platform-collected fees that should be added on top of Grid-collected fees. Contains every currently-active fee config for the platform.
    - `feeType` 'CROSS_CURRENCY_TRANSACTION', required — The kind of activity this fee applies to. - `CROSS_CURRENCY_TRANSACTION` — fee charged on a cross-currency Grid transaction (source currency differs from destination currency).
    - `sourceCurrency` string, required — Currency code of the sending side this fee applies to. Only `USD` is accepted today; other currencies return a `NOT_IMPLEMENTED` error.
    - `variableFeeBps` integer, required — Variable fee in basis points (1 bps = 0.01%) to apply to a transaction's source-currency amount.
    - `fixedFee` object, required — Fixed fee charged per transaction.
      - `amount` integer, required — Fee amount in the smallest unit of the fixed fee's `currency` (e.g., cents for USD).
      - `currency` string, required — Three-letter currency code (ISO 4217) the fixed fee is denominated in. Some cryptocurrencies may use their own ticker symbols (e.g. "BTC" for Bitcoin, "USDC" for USDC, etc.)
  - `createdAt` string, date-time — Creation timestamp
  - `updatedAt` string, date-time — Last update timestamp

## Other responses

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

---

[API](https://skmtc.net/stainless-api/apis/grid-api.md) · [All operations](https://skmtc.net/stainless-api/apis/grid-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stainless-api/grid-api/revisions/151f2d9bad9c/schema)