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

# Store recovery rates.

> Use this operation to publish dated recovery rates for service issuer and reference-bond identifiers to a
non-Derivitec provider that the caller may edit. Rates are dimensionless decimals from 0 through 1 inclusive.
Validation is all-or-nothing: a missing issuer/reference-bond identifier or out-of-range rate stops the
request before any rows are accepted. Accepted rows are available before the response is returned.



## OpenAPI

````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /api/MarketData/UploadRecoveryRates
openapi: 3.0.4
info:
  title: Derivitec Api 1.0
  version: '1.0'
servers:
  - url: https://api.riskportal.activeviam.com
security:
  - oauth2: []
  - apikey: []
tags:
  - name: AdminUser
  - name: AtotiReport
  - name: AtotiSession
  - name: BloombergOAuth
  - name: Bond
  - name: BondYieldCurvePage
  - name: BookAccess
  - name: Books
  - name: Commodity
  - name: Counterparties
  - name: Currencies
  - name: Equity
  - name: EquityDividend
  - name: EquityPage
  - name: FeatureFlag
  - name: Fx
  - name: FxPage
  - name: GroupAccess
  - name: Home
  - name: LegacyPosition
  - name: MarketData
  - name: MarketDataProvider
  - name: MarketDataProviderAccess
  - name: Meta
  - name: Notification
  - name: Organisation
  - name: PnLReport
  - name: PortfolioAccess
  - name: Portfolios
  - name: Position
  - name: PositionFilter
  - name: PricingEnvironment
  - name: PricingEnvironmentAccess
  - name: RateAsset
  - name: RateAssetPage
  - name: Report
  - name: ReportDefinition
  - name: ReportHistoryLauncherQuery
  - name: ReportLauncher
  - name: ReportQuery
  - name: ReportQueryViewUser
  - name: ReportRestriction
  - name: ReportView
  - name: RiskReport
  - name: Tradable
  - name: TradeBooking
  - name: User
  - name: VarReport
  - name: VarReportQuery
  - name: YieldCurvePage
paths:
  /api/MarketData/UploadRecoveryRates:
    post:
      tags:
        - MarketData
      summary: Store recovery rates.
      description: >-
        Use this operation to publish dated recovery rates for service issuer
        and reference-bond identifiers to a

        non-Derivitec provider that the caller may edit. Rates are dimensionless
        decimals from 0 through 1 inclusive.

        Validation is all-or-nothing: a missing issuer/reference-bond identifier
        or out-of-range rate stops the

        request before any rows are accepted. Accepted rows are available before
        the response is returned.
      operationId: UploadRecoveryRates
      requestBody:
        description: >-
          The upload payload. Provide either `ProviderId` or
          `MarketDataEnvironmentName`, not both; omitting both selects the
          caller's organisation scope. `RecoveryRateData` must be non-empty and
          each row supplies service `IssuerId` and `ReferenceBondId` values, a
          date-only market date, and decimal `Rate` in the range [0, 1].
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ApiUploadRecoveryRatesRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/ApiUploadRecoveryRatesRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ApiUploadRecoveryRatesRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ApiUploadRecoveryRatesRequest'
      responses:
        '200':
          description: >-
            Returns whether all recovery rates were stored and errors for
            invalid providers, missing identifiers, out-of-range rates, or write
            failures.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiUploadRecoveryRatesResponse'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
        - oauth2: []
        - apikey: []
components:
  schemas:
    ApiUploadRecoveryRatesRequest:
      required:
        - $type
      type: object
      properties:
        market_data_environment_name:
          type: string
          description: >-
            Name of the market-data environment to use. Supply either this name
            or `provider_id`, not both.
          nullable: true
          example: Example market data
        provider_id:
          type: string
          description: >-
            Opaque identifier of the market-data provider to use. Supply either
            this identifier or `market_data_environment_name`, not both.
          nullable: true
        recovery_rate_data:
          type: array
          items:
            $ref: '#/components/schemas/RecoveryRateData'
          description: Dated recovery-rate observations to upload.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.ApiUploadRecoveryRatesRequest,
              Derivitec.Web.Core
      additionalProperties: false
      description: Submits dated recovery-rate observations.
    ApiUploadRecoveryRatesResponse:
      required:
        - $type
      type: object
      additionalProperties: false
      description: Returns the success flag and error messages from a recovery-rate upload.
      properties:
        is_success:
          type: boolean
          description: >-
            Whether the operation completed successfully. The default is `true`;
            error outcomes set it to `false`.
          example: true
        error_messages:
          type: array
          items:
            type: string
          description: >-
            Messages explaining operation-level failures. The collection is
            empty by default.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.ApiUploadRecoveryRatesResponse,
              Derivitec.Web.Core
    RecoveryRateData:
      required:
        - $type
      type: object
      properties:
        provider_id:
          type: string
          description: >-
            Market-data provider code recorded as the source of the
            contribution. Defaults to Derivitec.
          nullable: true
        derivitec_created:
          type: string
          description: Timestamp at which the market-data record was created.
        derivitec_modified:
          type: string
          description: Optional timestamp of the record's latest modification.
          nullable: true
        uploaded_date_time:
          type: string
          description: >-
            Optional timestamp at which the contribution was uploaded.
            UploadRateAssets ignores the supplied value on each rate asset and
            stores the current UTC time.
          nullable: true
        derivitec_modified_by:
          type: string
          description: >-
            Principal recorded as the latest modifier. UploadRateAssets ignores
            the supplied value on each rate asset and stores the authenticated
            user identifier.
          nullable: true
        uploaded_by:
          type: string
          description: >-
            Principal recorded as the uploader. UploadRateAssets ignores the
            supplied value on each rate asset and stores the authenticated user
            identifier.
          nullable: true
        rolled:
          type: boolean
          description: Whether the contribution has been rolled.
          example: false
        rate:
          type: number
          description: Recovery rate supplied as a decimal from zero through one inclusive.
          format: double
        issuer_id:
          type: string
          description: Non-empty issuer identifier to which the rate applies.
          nullable: true
        reference_bond_id:
          type: string
          description: Non-empty reference-bond identifier used for the contribution.
          nullable: true
        date:
          type: string
          description: Market date of the recovery-rate contribution.
          format: date-time
        $type:
          type: string
          enum:
            - Derivitec.Web.Core.MarketData.RecoveryRateData, Derivitec.Web.Core
      additionalProperties: false
      description: Dated recovery-rate contribution for an issuer and reference bond.
  securitySchemes:
    oauth2:
      type: oauth2
      description: >-
        OAuth2 access-token requested from AWS Cognito and provided as a Auth
        Bearer header
      flows:
        implicit:
          authorizationUrl: https://auth.riskportal.derivitec.com/oauth2/authorize
          scopes: {}
    apikey:
      type: apiKey
      description: API-Key requested via the site and provided as a header
      name: x-api-key
      in: header

````