> ## 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 equity-to-dividend correlations.

> Use this operation to publish correlations between equities and dividend indexes for one date-only market
date in a non-default provider that the caller may edit. Each row supplies recognisable equity and dividend
identifier codes and a unitless coefficient from -1 through 1. `UseBestEffort` defaults to false; when
true, valid pairs can be stored despite unknown identifiers or invalid coefficients. An accepted coefficient
replaces the value for the same provider, pair, and market date before the response returns.



## OpenAPI

````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /api/MarketData/UploadEquityDividendCorrelation
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/UploadEquityDividendCorrelation:
    post:
      tags:
        - MarketData
      summary: Store equity-to-dividend correlations.
      description: >-
        Use this operation to publish correlations between equities and dividend
        indexes for one date-only market

        date in a non-default provider that the caller may edit. Each row
        supplies recognisable equity and dividend

        identifier codes and a unitless coefficient from -1 through 1.
        `UseBestEffort` defaults to false; when

        true, valid pairs can be stored despite unknown identifiers or invalid
        coefficients. An accepted coefficient

        replaces the value for the same provider, pair, and market date before
        the response returns.
      operationId: UploadEquityDividendCorrelation
      requestBody:
        description: >-
          The upload payload. Provide either `ProviderId` or
          `MarketDataEnvironmentName`, not both; omitting both selects the
          caller's organisation scope. Supply a non-empty
          `CorrelationByEquityIdAndDividendId` collection, a shared date-only
          `MarketDate`, and the partial-processing flag.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ApiUploadEquityDividendCorrelationRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/ApiUploadEquityDividendCorrelationRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ApiUploadEquityDividendCorrelationRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ApiUploadEquityDividendCorrelationRequest'
      responses:
        '200':
          description: >-
            Returns whether correlations were stored and errors for invalid
            providers, unknown identifiers, out-of-range coefficients, empty
            input, or save failures.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ApiUploadEquityDividendCorrelationResponse
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
        - oauth2: []
        - apikey: []
components:
  schemas:
    ApiUploadEquityDividendCorrelationRequest:
      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
        correlation_by_equity_id_and_dividend_id:
          type: array
          items:
            $ref: '#/components/schemas/EquityDividendCorrelationData'
          description: Correlation values keyed by equity and dividend-index identifiers.
          nullable: true
        market_date:
          type: string
          description: Market date for the equity dividend correlation operation.
          format: date-time
        use_best_effort:
          type: boolean
          description: >-
            Requests independent handling of input records when one cannot be
            processed; defaults to `false`.
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.ApiUploadEquityDividendCorrelationRequest,
              Derivitec.Web.Core
      additionalProperties: false
      description: Submits dated equity-to-dividend-index correlations.
    ApiUploadEquityDividendCorrelationResponse:
      required:
        - $type
      type: object
      additionalProperties: false
      description: >-
        Returns the success flag and error messages from an
        equity-to-dividend-index correlation 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.ApiUploadEquityDividendCorrelationResponse,
              Derivitec.Web.Core
    EquityDividendCorrelationData:
      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
        equity_asset_identifier:
          $ref: '#/components/schemas/InstrumentIdentifier'
        dividend_asset_identifier:
          $ref: '#/components/schemas/InstrumentIdentifier'
        correlation:
          type: number
          description: >-
            Unitless correlation coefficient from -1 through 1 inclusive for the
            equity and dividend-asset pair.
          format: double
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.EquityDividendCorrelationData,
              Derivitec.Web.Core
      additionalProperties: false
      description: Dated correlation between an equity and its dividend asset.
    InstrumentIdentifier:
      description: >-
        Instrument code qualified by an identifier namespace and optional market
        code.
      discriminator:
        propertyName: $type
        mapping:
          Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core: '#/components/schemas/InstrumentIdentifierMintlifyShape'
          Derivitec.Web.Core.MarketData.InstrumentInfo, Derivitec.Web.Core: '#/components/schemas/InstrumentInfo'
      oneOf:
        - $ref: '#/components/schemas/InstrumentIdentifierMintlifyShape'
        - $ref: '#/components/schemas/InstrumentInfo'
    InstrumentIdentifierMintlifyShape:
      required:
        - $type
      type: object
      properties:
        code:
          type: string
          description: Instrument code interpreted in the selected identifier namespace.
          nullable: true
        identifier_type:
          enum:
            - Derivitec
            - Ric
            - Bloomberg
            - Isin
            - Figi
            - Sedol
            - RedCode
            - RedPairCode
            - BloombergYellow
            - XIgniteCode
            - CBondsId
            - EdiSecId
            - EdiSymbol
            - Cusip
            - NotSet
          type: string
          description: Namespace that determines how the instrument code is interpreted.
        market_identification_code:
          type: string
          description: >-
            Optional market identification code that further qualifies the
            instrument code.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.InstrumentIdentifier,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Instrument code qualified by an identifier namespace and optional market
        code.
    InstrumentInfo:
      required:
        - $type
      type: object
      properties:
        code:
          type: string
          description: Instrument code interpreted in the selected identifier namespace.
          nullable: true
        identifier_type:
          enum:
            - Derivitec
            - Ric
            - Bloomberg
            - Isin
            - Figi
            - Sedol
            - RedCode
            - RedPairCode
            - BloombergYellow
            - XIgniteCode
            - CBondsId
            - EdiSecId
            - EdiSymbol
            - Cusip
            - NotSet
          type: string
          description: Namespace that determines how the instrument code is interpreted.
        market_identification_code:
          type: string
          description: >-
            Optional market identification code that further qualifies the
            instrument code.
          nullable: true
        name:
          type: string
          description: Human-readable name of the identified instrument.
          nullable: true
        $type:
          type: string
          enum:
            - Derivitec.Web.Core.MarketData.InstrumentInfo, Derivitec.Web.Core
      additionalProperties: false
      description: Instrument identifier with a human-readable instrument name.
  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

````