name: optimal-blue-pricing
title: Optimal Blue Product & Pricing + Rate Lock Capability
description: >-
  Shared Naftiko capability for the Optimal Blue PPE search-and-lock surface.
  Optimal Blue was Black Knight's secondary-marketing acquisition (2020) and was
  divested to Constellation Software's Perseus Operating Group in Sept 2023 as a
  condition of the ICE / Black Knight FTC clearance. APIs now live under
  digitalmarketplace.optimalblue.com.
version: '0.1.0'
created: '2026-05-23'
provider:
  name: Optimal Blue (Constellation Software / Perseus Operating Group)
  url: https://digitalmarketplace.optimalblue.com
authentication:
  type: oauth2
  description: OAuth 2.0 with token-based access; partner-gated production credentials.

operations:
  - id: search-pricing
    summary: Search Eligible Products And Pricing
    description: >-
      Run a borrower / loan scenario through the PPE; returns eligible products
      with rate/price grids.
    method: POST
    path: /ppe/v1/search
    inputs:
      - loanAmount
      - propertyValue
      - creditScore
      - occupancy
      - propertyType
      - loanPurpose
      - lockDays

  - id: create-lock
    summary: Create Rate Lock
    description: Lock a chosen pricing scenario for a loan.
    method: POST
    path: /ppe/v1/locks

  - id: get-lock
    summary: Get Rate Lock By Id
    method: GET
    path: /ppe/v1/locks/{lockId}

  - id: extend-lock
    summary: Extend Existing Lock
    method: POST
    path: /ppe/v1/locks/{lockId}/extensions

  - id: cancel-lock
    summary: Cancel Rate Lock
    method: DELETE
    path: /ppe/v1/locks/{lockId}

  - id: list-rate-indices
    summary: List Mortgage Market Rate Indices
    description: Sixteen Optimal Blue indices derived from real-time PPE flow.
    method: GET
    path: /bi/v1/rate-indices

governance:
  - All pricing scenarios timestamped for audit
  - Lock extensions priced per published lock-policy matrix
  - Rate-lock changes require originator scope