> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blips.network/llms.txt
> Use this file to discover all available pages before exploring further.

# Get your current platform configuration

> Read your current platform configuration. Basic Auth binds this request to your platform. Platform identity remains outside this public config contract.



## OpenAPI

````yaml /openapi/blips-public-reference.yaml get /config
openapi: 3.1.0
info:
  title: BLIPS Public Reference API
  version: '2026-04-08'
  description: >-
    Public OpenAPI 3.1 subset for the first BLIPS Mintlify API Reference and
    Playground release. This document is bound to the confirmed Public Test
    Backend at https://public-test.blips.network, includes only the approved
    first-release public endpoints, uses only internal `$ref` values, and
    excludes callback-only webhook documentation and operator-only surfaces.
servers:
  - url: https://public-test.blips.network
    description: >-
      Confirmed Public Test Backend ingress target for public BLIPS API
      Reference, Playground, and internet-testable Try It flows.
security:
  - BasicAuth: []
tags:
  - name: Platform Setup
    description: >-
      Bootstrap and platform configuration surfaces for establishing the public
      BLIPS integration context.
  - name: Sandbox API
    description: >-
      Sandbox-only externally displayed helper surfaces. These routes either
      adjust quote inputs or create incoming-payment review cases, but they
      always feed the existing quote or transaction families and never become
      second outward API families.
  - name: Tokens
    description: >-
      Platform-scoped API credential create, list, detail, and revoke
      operations.
  - name: Customers
    description: >-
      Customer onboarding, profile lifecycle, and PPV payment-address issuance
      surfaces.
  - name: Accounts
    description: >-
      Customer-bound internal-account and external-account surfaces kept in the
      first-layer public contract.
  - name: Same-Currency Transfers
    description: >-
      Same-currency receiver lookup plus incoming and outgoing transfer
      primitives.
  - name: Cross-Currency Transfers
    description: >-
      PPV-first receiver lookup, quote creation/readback, and quote execution
      for cross-currency flows.
  - name: Transactions
    description: Transaction readback plus bounded incoming-review decision operations.
  - name: Webhooks
    description: >-
      Webhook connectivity verification surface for the public BLIPS
      integration.
paths:
  /config:
    get:
      tags:
        - Platform Setup
      summary: Get your current platform configuration
      description: >-
        Read your current platform configuration. Basic Auth binds this request
        to your platform. Platform identity remains outside this public config
        contract.
      operationId: getPlatformConfiguration
      responses:
        '200':
          description: Current platform configuration returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigGetMvpResponse'
              examples:
                default:
                  value:
                    id: PlatformConfig:019542f5-b3e7-1d02-0000-000000000003
                    umaDomain: uma.example.blips
                    ppvDomain: pay.example.blips
                    webhookEndpoint: https://api.demo-bank.com/webhooks/blips
                    quoteFeePolicy:
                      senderServiceFeeBps: 15
                      receiverServiceFeeBps: 15
                    supportedCurrencies:
                      - currencyCode: USD
                        minAmount: 100
                        maxAmount: 1000000
                        enabledTransactionTypes:
                          - OUTGOING
                          - INCOMING
                        requiredCounterpartyFields:
                          - profile: FULL_NAME
                            mandatory: true
                          - profile: BIRTH_DATE
                            mandatory: true
                          - profile: NATIONALITY
                            mandatory: true
                    createdAt: '2025-06-15T12:30:45Z'
                    updatedAt: '2025-06-15T12:30:45Z'
        '401':
          description: Invalid or missing API credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
              examples:
                unauthorized:
                  value:
                    status: 401
                    code: UNAUTHORIZED
                    message: Invalid or missing API credentials
                    details: {}
        '500':
          description: Internal service error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
              examples:
                internalServiceError:
                  value:
                    status: 500
                    code: INTERNAL_ERROR
                    message: Internal service error
                    details: {}
      security:
        - BasicAuth: []
components:
  schemas:
    ConfigGetMvpResponse:
      type: object
      additionalProperties: false
      description: Frozen MVP platform configuration response.
      required:
        - id
        - umaDomain
        - ppvDomain
        - webhookEndpoint
        - quoteFeePolicy
        - supportedCurrencies
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
          description: Stable platform configuration identifier.
        umaDomain:
          type: string
          nullable: true
          description: >-
            Bounded readback of the compatibility-oriented, future-facing UMA
            domain for this configuration context.
        ppvDomain:
          type: string
          nullable: true
          description: >-
            Bounded readback of the active public-facing PPV domain for this
            configuration context. Proxy and routing remain operator-managed and
            out of scope for the public contract.
        webhookEndpoint:
          type: string
          nullable: true
          description: Configured webhook endpoint for payment-status delivery.
        quoteFeePolicy:
          $ref: '#/components/schemas/ConfigQuoteFeePolicy'
          description: >-
            Platform-level sender and receiver service-fee policy inputs used
            for newly created quotes.
        supportedCurrencies:
          type: array
          items:
            $ref: '#/components/schemas/ConfigGetMvpSupportedCurrency'
        createdAt:
          type: string
          format: date-time
          description: Configuration creation timestamp.
        updatedAt:
          type: string
          format: date-time
          description: Most recent configuration update timestamp.
    PublicErrorResponse:
      type: object
      description: >-
        Standard public error envelope for first-layer BLIPS public REST
        operations.
      additionalProperties: false
      required:
        - status
        - code
        - message
        - details
      properties:
        status:
          type: integer
          description: HTTP status code returned for the failed request.
        code:
          type: string
          description: Stable public error code for the failed request.
        message:
          type: string
          description: Human-readable summary of the request failure.
        details:
          type: object
          nullable: true
          additionalProperties: true
          description: Additional structured error context when present.
    ConfigQuoteFeePolicy:
      type: object
      additionalProperties: false
      description: >-
        Platform-level sender and receiver service-fee policy inputs, expressed
        in basis points and applied to newly created quotes.
      required:
        - senderServiceFeeBps
        - receiverServiceFeeBps
      properties:
        senderServiceFeeBps:
          type: integer
          minimum: 0
          maximum: 10000
          description: Sender-side service fee policy in basis points.
        receiverServiceFeeBps:
          type: integer
          minimum: 0
          maximum: 10000
          description: Receiver-side service fee policy in basis points.
    ConfigGetMvpSupportedCurrency:
      type: object
      additionalProperties: false
      required:
        - currencyCode
        - minAmount
        - maxAmount
        - enabledTransactionTypes
        - requiredCounterpartyFields
      properties:
        currencyCode:
          type: string
          description: Supported fiat ISO 4217 currency code.
        minAmount:
          type: integer
          description: Minimum supported amount in minor units.
        maxAmount:
          type: integer
          description: Maximum supported amount in minor units.
        enabledTransactionTypes:
          type: array
          description: >-
            Frozen MVP transaction directions BLIPS currently allows for this
            currency in the public config surface. The MVP default is the full
            `OUTGOING` + `INCOMING` pair on every supported currency item;
            subset direction configuration is not part of the active MVP
            contract.
          minItems: 2
          maxItems: 2
          uniqueItems: true
          items:
            type: string
            enum:
              - OUTGOING
              - INCOMING
        requiredCounterpartyFields:
          type: array
          description: >-
            Counterparty profile fields configured for supported flows in this
            currency. In the current MVP every supported currency item must
            repeat the same `requiredCounterpartyFields` template; BLIPS
            persists one shared public template and mirrors it across currencies
            in readback.
          items:
            $ref: '#/components/schemas/ConfigRequiredCounterpartyField'
    ConfigRequiredCounterpartyField:
      type: object
      additionalProperties: false
      required:
        - profile
        - mandatory
      properties:
        profile:
          type: string
          enum:
            - FULL_NAME
            - BIRTH_DATE
            - NATIONALITY
            - EMAIL
            - PHONE_NUMBER
            - POSTAL_ADDRESS
            - TAX_ID
          description: >-
            Counterparty profile field required for supported flows in this
            configuration.
        mandatory:
          type: boolean
          description: >-
            Whether this counterparty profile field must be supplied before
            execution can proceed. `false` means the field is optional metadata
            in the frozen MVP contract.
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: >-
        Integration-key Basic Auth (`clientId:clientSecret`) as documented in
        docs/public/AUTHENTICATION.md.

````