---
title: "Update platform configuration"
method: PATCH
path: "/config"
tags: ["Platform Configuration"]
---

# Update platform configuration

`PATCH /config`

Update the platform configuration settings

## Request body

- object
  - `umaDomain` string
  - `webhookEndpoint` string
  - `supportedCurrencies` PlatformCurrencyConfig[]
    - `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 users. 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', required — Name of a type of field containing info about a platform's user or counterparty user.
      - `mandatory` boolean, required — Whether the field is mandatory
    - `umaProviderRequiredUserFields` UserInfoFieldName[] — List of user info field names that are required by the underlying UMA provider when creating a user for this currency. These fields must be supplied when creating or updating a user if this currency is intended to be used by that user. If no fields are required, this field is omitted.
    - `umaProviderRequiredCounterpartyUserFields` UserInfoFieldName[] — 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.

## Response `200`

Configuration updated successfully

- PlatformConfig
  - `id` string — System-generated unique identifier
  - `umaDomain` string — UMA domain for this platform
  - `proxyUmaaasSubdomain` 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
    - `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 users. 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', required — Name of a type of field containing info about a platform's user or counterparty user.
      - `mandatory` boolean, required — Whether the field is mandatory
    - `umaProviderRequiredUserFields` UserInfoFieldName[] — List of user info field names that are required by the underlying UMA provider when creating a user for this currency. These fields must be supplied when creating or updating a user if this currency is intended to be used by that user. If no fields are required, this field is omitted.
    - `umaProviderRequiredCounterpartyUserFields` UserInfoFieldName[] — 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.
  - `createdAt` string, date-time — Creation timestamp
  - `updatedAt` string, date-time — Last update timestamp

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `500` — Internal service error
- `501` — Not implemented

---

[API](https://skmtc.net/lightsparkdev/apis/uma-as-a-service-umaaas-api.md) · [All operations](https://skmtc.net/lightsparkdev/apis/uma-as-a-service-umaaas-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightsparkdev/uma-as-a-service-umaaas-api/revisions/2e2b5ba6d69b/schema)