openapi: 3.2.0
info:
  title: Automated Spreading and Analysis Tenant Settings API
  version: 1.3.1
  description: This REST API allows you to interact with the Automated Spreading processing and insights engine.
  x-logo:
    url: https://manual-public-web-static-resources.s3.amazonaws.com/public-api/Moodys-icon.svg
  contact:
    name: Moody's Automated Spreading Customer Support
    email: MA_NMR_Support@moodys.com
security:
- API_Key: []
tags:
- name: Tenant Settings
paths:
  /v1/tenant-settings/read:
    get:
      operationId: readTenantSettings
      description: Read Tenant Settings
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantSettings'
          description: ''
      tags:
      - Tenant Settings
      summary: Get Tenant Settings
components:
  schemas:
    TenantSettings:
      type: object
      properties:
        portal_domain:
          type: string
          readOnly: true
          description: Whitelabled domain for borrower portal
          maxLength: 255
        webhook_signing_key:
          type: string
          format: uuid
          readOnly: true
          description: 32 character hexadecimal string
  securitySchemes:
    API_Key:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-tagGroups:
- name: Tenant
  tags:
  - Api-Key
  - TenantSettings
- name: Templates
  tags:
  - SpreadingTemplate
  - DscrTemplate
  - GlobalCashflowTemplate
- name: Borrower
  tags:
  - Borrowers
  - Files
  - Loans
  - Requirements
  - Portfolios
- name: Normalized Data
  tags:
  - DataViews
  - Templates
- name: Analysis
  tags:
  - DscrAnalysis
  - GlobalCashflowAnalysis
- name: Events
  tags:
  - Webhooks
- name: Embedded UI
  tags:
  - EmbeddedDocument
  - EmbeddedFinancials
  - EmbeddedDscrAnalysis
  - EmbeddedGlobalCashflowAnalysis