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

# List offers

> Returns the offers on a referral. Real offers from lenders have `binding: true` and name the lender. For
programs that publish sizing rules, O.J. can also compute indicative terms before any lender has replied;
those have `binding: false` so they are never mistaken for a real offer.




## OpenAPI

````yaml /api-reference/openapi.yaml get /referrals/{referral_id}/offers
openapi: 3.1.0
info:
  title: O.J. Agent Development Kit (ADK)
  version: 0.5.1
  summary: >-
    Send O.J. a business. Get back named lender matches, what's needed, offers
    and funding status.
  description: >
    The O.J. ADK lets platforms with small-business customers offer financing
    without becoming a lender or a

    broker. You send a business as a **referral**. O.J. matches it to lender
    programs, collects documents,

    submits to lenders and tracks the deal to funding. You earn a share of the
    commission on every funded loan.


    Integrate with **O.J. Embed** (drop-in screens), the **REST API** with
    webhooks, or **MCP** for agents. All

    three read and write the same referral.


    Conventions: OAuth 2.0 client credentials, amounts in cents, prefixed ids,
    cursor pagination, an

    `Idempotency-Key` on every POST, RFC 9457 errors, and Standard Webhooks
    signatures.
  license:
    name: Proprietary — O.J. partner terms
    identifier: LicenseRef-OJ-Partner
  contact:
    name: O.J. Developer Support
    email: developers@meet-oj.com
servers:
  - url: https://sandbox.api.meet-oj.com/partner/v0
    description: Sandbox
  - url: https://api.meet-oj.com/partner/v0
    description: Production
security:
  - oauth2: []
tags:
  - name: Referrals
    description: >-
      A referral is one business you sent to O.J. Every other resource belongs
      to a referral.
  - name: Matches
    description: >-
      The lenders a business matches, named, with estimated limits. `POST
      /match_checks` screens raw numbers without creating a referral. A match is
      not a credit decision; the lender decides.
  - name: Documents
    description: >-
      Documents O.J. still needs, and uploads by API. Most integrations show the
      `next_action` button instead.
  - name: Offers
    description: >-
      Offers returned by lenders. Indicative terms computed before a lender
      replies are marked `binding: false`.
  - name: Sessions
    description: >-
      Create a session to open an O.J. screen: a `client_token` for Embed, or a
      hosted `url` to redirect to.
  - name: Events
    description: >-
      Every change to a referral is an event, delivered by webhook, streamed
      over SSE, and kept for 30 days at `GET /events`.
  - name: Payouts
    description: >-
      Your share of the commission on each funded referral. Match rows to your
      bank statement with `statement_descriptor`. Payout destinations are set
      during onboarding and cannot be changed by API.
  - name: Conversation
    description: >-
      The message thread between O.J., the borrower and your team on a referral,
      across every channel.
  - name: Channels
    description: >-
      Channel connectors let O.J. reach your borrowers through channels you own
      (in-app inbox, SMS, Apple Business Messages, email), in your brand.
  - name: Policy
    description: >-
      Account-level rules: send approval, allowed Embed origins, contact
      channels, default intent and reminder cadence.
  - name: Programs
    description: >-
      For lenders running a program on O.J.: receive submissions, record
      decisions and report funding.
  - name: Webhooks
    description: >-
      Register endpoints that receive signed events. Deliveries follow Standard
      Webhooks.
paths:
  /referrals/{referral_id}/offers:
    get:
      tags:
        - Offers
      summary: List offers
      description: >
        Returns the offers on a referral. Real offers from lenders have
        `binding: true` and name the lender. For

        programs that publish sizing rules, O.J. can also compute indicative
        terms before any lender has replied;

        those have `binding: false` so they are never mistaken for a real offer.
      operationId: listOffers
      parameters:
        - $ref: '#/components/parameters/ReferralId'
      responses:
        '200':
          description: Offers
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Offer'
        '404':
          $ref: '#/components/responses/Error'
components:
  parameters:
    ReferralId:
      name: referral_id
      in: path
      required: true
      schema:
        type: string
        examples:
          - ref_01K5X3K7Q2
  schemas:
    Offer:
      type: object
      description: >
        Terms a lender is willing to fund, or (when `binding` is false) terms
        O.J. estimated from a program's limits.

        `conditions` lists what the lender still needs before it will fund,
        usually `funding_account_auth`. `partner_share_estimate` is what you
        would earn

        if this offer funds. Offers expire; check `expires_at`.
      required:
        - id
        - referral_id
        - lender
        - product
        - binding
        - status
        - items
        - received_at
      properties:
        id:
          type: string
          examples:
            - ofr_01K5X3M1A4
        object:
          type: string
          const: offer
        referral_id:
          type: string
        lender:
          type: string
          examples:
            - Example Capital
        product:
          $ref: '#/components/schemas/Product'
        binding:
          type: boolean
          description: >-
            True when a lender issued it. False for indicative terms O.J.
            computed from a program's sizing rules.
        status:
          type: string
          enum:
            - available
            - accepted
            - withdrawn
            - expired
        items:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/OfferItem'
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/DocumentType'
          description: What must clear before funding if accepted.
        partner_share_estimate:
          $ref: '#/components/schemas/Money'
          description: >-
            Partner's estimated share if this offer funds, under the partner's
            fee schedule.
        expires_at:
          type: string
          format: date-time
        received_at:
          type: string
          format: date-time
        accepted_at:
          type: string
          format: date-time
    Product:
      type: string
      description: >
        A kind of financing. When you pass one as `product_hint`, O.J. still
        checks every product it can place, but

        lists the hinted one first. `revenue_based_financing` is repaid as a
        share of sales; `term_loan` is a fixed

        amount repaid over a fixed period; `business_line_of_credit` can be
        drawn and repaid repeatedly; `sba_7a` is a

        government-guaranteed bank loan; `invoice_factoring` advances money
        against unpaid invoices;

        `asset_based_lending` is secured by inventory or equipment;
        `hard_money_lending` is secured by real estate.
      enum:
        - revenue_based_financing
        - term_loan
        - business_line_of_credit
        - sba_7a
        - invoice_factoring
        - asset_based_lending
        - hard_money_lending
    OfferItem:
      type: object
      description: >
        One set of terms inside an offer; most offers have one item, some
        lenders send two or three options. `rate`

        is read with `rate_type`: an `interest` rate is an annual percentage
        (11.5 means 11.5%), while a `factor` rate

        is a multiplier on the amount (1.28 means the business repays $1.28 for
        every $1.00 advanced), which is how

        revenue-based financing is priced. `total_payback` is the full amount
        the business will repay.
      required:
        - amount
        - rate
        - rate_type
        - term_months
        - payment_frequency
      properties:
        amount:
          $ref: '#/components/schemas/Money'
        rate:
          type: number
          description: Interest rate (e.g. 11.5) or factor (e.g. 1.28) per rate_type.
        rate_type:
          type: string
          enum:
            - interest
            - factor
        term_months:
          type: integer
        payment_frequency:
          type: string
          enum:
            - daily
            - weekly
            - monthly
        number_of_payments:
          type: integer
        payment_amount:
          $ref: '#/components/schemas/Money'
        total_payback:
          $ref: '#/components/schemas/Money'
        origination_fee:
          $ref: '#/components/schemas/Money'
        notes:
          type: string
    DocumentType:
      type: string
      description: >-
        The kinds of documents O.J. can request or accept. `cim` is a
        confidential information memorandum, the summary document a business
        broker prepares for a sale. `quality_of_earnings` is an accountant's
        review of reported earnings, required by the SBA for acquisitions of $3M
        or more. `funding_account_auth` is the funding account verified through
        Plaid; `voided_check` is the fallback when the bank can't be verified.
      enum:
        - bank_statement
        - processing_statement
        - voided_check
        - funding_account_auth
        - tax_return
        - profit_and_loss
        - balance_sheet
        - ar_aging
        - ap_aging
        - debt_schedule
        - business_license
        - government_id
        - lease
        - ownership_document
        - cim
        - purchase_agreement
        - quality_of_earnings
        - other
    Money:
      type: integer
      description: >-
        A dollar amount expressed in whole US cents, so $85,000.00 is `8500000`.
        Cents avoid rounding errors that decimals cause in some languages.
    Error:
      type: object
      description: >
        RFC 9457 Problem Details, returned as `application/problem+json` with
        any 4xx or 5xx status. `type` is a

        URI that identifies the kind of problem and doubles as a link to its
        documentation; `title` is the short

        human name for that kind; `status` repeats the HTTP status; `detail`
        explains this occurrence for a

        developer; `instance` is the request path. Three extension members:
        `code`, a stable snake_case reason to

        branch on; `param`, the offending field when the request was invalid;
        `request_id`, to quote to support.

        One code deserves a note: `awaiting_approval` (HTTP 409) is not a
        failure. It means the action you asked

        for needs a person at your company to confirm it first, and the referral
        shows `needs_partner` until they do.
      required:
        - type
        - title
        - status
        - code
        - request_id
      properties:
        type:
          type: string
          format: uri
          examples:
            - https://api.meet-oj.com/problems/duplicate-external-id
        title:
          type: string
          examples:
            - Referral already exists
        status:
          type: integer
          examples:
            - 409
        detail:
          type: string
          examples:
            - >-
              A referral with external_id cust_8842 was created on 2026-09-20 as
              ref_01K5X3K7Q2.
        instance:
          type: string
          examples:
            - /partner/v0/referrals
        code:
          type: string
          description: >-
            Stable machine-readable reason. Categories are the prefixes;
            specific codes follow.
          examples:
            - invalid_request
            - authentication_failed
            - permission_denied
            - not_found
            - duplicate_external_id
            - business_already_referred
            - missing_consent
            - required_documents_missing
            - idempotency_key_reused
            - rate_limited
            - awaiting_approval
            - internal_error
        param:
          type: string
          description: The field that caused an invalid_request, in dot notation.
        request_id:
          type: string
          examples:
            - req_01K5X4A9M2
  responses:
    Error:
      description: Problem Details (RFC 9457)
      headers:
        OJ-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Error'
  headers:
    RequestId:
      description: >-
        Unique id for this request. Quote it to support; it is also in Problem
        Details as `request_id` and in O.J.'s traces.
      schema:
        type: string
        examples:
          - req_01K5X4A9M2
  securitySchemes:
    oauth2:
      type: oauth2
      description: >-
        One client per partner per environment. Access tokens expire after 15
        minutes. Scopes are granted per client. Sandbox clients use
        https://sandbox.api.meet-oj.com/oauth/token.
      flows:
        clientCredentials:
          tokenUrl: https://api.meet-oj.com/oauth/token
          scopes:
            referrals:write: Create referrals and upload documents
            referrals:read: Read referrals, matches, document requests, offers, events
            match_checks:write: Run identity-free match checks
            sessions:write: Mint hosted-session links
            webhooks:manage: Register and list webhook endpoints
            payouts:read: >-
              Read payouts (your statement). There is no payouts:write;
              destinations are managed in hosted onboarding by a person.
            messages:read: Read a referral's conversation
            messages:write: >-
              Send messages into a referral's conversation on behalf of the
              partner or the borrower
            channels:manage: Register and remove channel connectors
            policy:manage: Read and change the partner policy
            submissions:read: >-
              For banks running a program. List and read submissions awaiting
              review
            submissions:write: For banks running a program. Record decisions and report funding

````