Droplinked API

openapi: 3.1.0
info:
  title: Droplinked API
  version: '2026-11-06'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-06: 18 operation(s) read from 10 public documentation page(s) (each
    operation names its page in x-source). This is not the provider''s published contract; Droplinked has published no machine-readable contract
    that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 18
    documentation: 0
    pages-with-code: 9
    pages-read: 10
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-06'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.droplinked.com/developers/lending-application-api/endpoints.md
  - https://docs.droplinked.com/developers/inventory-os-api/subscriptions.md
  - https://docs.droplinked.com/developers/lending-application-api/overview.md
  - https://docs.droplinked.com/developers/inventory-os-api/overview.md
  - https://docs.droplinked.com/developers/inventory-os-api/streams/catalog.md
  - https://docs.droplinked.com/developers/inventory-os-api/streams/provenance.md
  - https://docs.droplinked.com/developers/inventory-os-api/streams/settlement.md
  - https://docs.droplinked.com/developers/inventory-os-api/streams/attribution.md
  - https://docs.droplinked.com/developers/inventory-os-api/streams/return-rate.md
  - https://docs.droplinked.com/developers/inventory-os-api/streams/sell-through.md
servers:
- url: https://apiv3.droplinked.com
paths:
  /admin/lending-application:
    get:
      operationId: get_admin_lending_application
      tags:
      - Admin
      summary: GET /admin/lending-application
      x-source: https://docs.droplinked.com/developers/lending-application-api/endpoints.md
      parameters:
      - name: partner
        in: query
        required: false
        schema:
          type: string
      - name: status
        in: query
        required: false
        schema:
          type: string
      - name: tier
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl "https://apiv3.droplinked.com/admin/lending-application?status=SUBMITTED&tier=TIER_1_REFERRAL&partner=CredibleX"  -H "Authorization:
          Bearer <super-admin-jwt>"

          ```'
  /admin/lending-application/{id}:
    get:
      operationId: get_admin_lending_application_id
      tags:
      - Admin
      summary: Get application
      x-source: https://docs.droplinked.com/developers/lending-application-api/endpoints.md
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /admin/lending-application/{id}/decision:
    post:
      operationId: post_admin_lending_application_id_decision
      tags:
      - Admin
      summary: Post decision
      x-source: https://docs.droplinked.com/developers/lending-application-api/endpoints.md
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostAdminLendingApplicationIdDecisionRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /admin/lending-application/credit-tier/preview:
    post:
      operationId: post_admin_lending_application_credit_tier_preview
      tags:
      - Admin
      summary: POST /admin/lending-application/credit-tier/preview
      x-source: https://docs.droplinked.com/developers/lending-application-api/endpoints.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostAdminLendingApplicationCreditTierPreviewRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://apiv3.droplinked.com/admin/lending-application/credit-tier/preview  -H \"Authorization: Bearer <super-admin-jwt>\"\
          \  -H \"Content-Type: application/json\"  -d '{\n    \"cohort\": \"A_CONNECT_STRIPE\",\n    \"monthlyAvgRevenueUsd\": 8000,\n    \"\
          verifiedCollateralUsd\": 31777,\n    \"operationalRisk\": \"LOW\"\n  }'\n```"
  /admin/lending-application/credit-tier/upgrade-eligibility/{merchantid}:
    get:
      operationId: get_admin_lending_application_credit_tier_upgrade_eligibility_merchantid
      tags:
      - Admin
      summary: Upgrade eligibility
      x-source: https://docs.droplinked.com/developers/lending-application-api/endpoints.md
      parameters:
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      - name: baseTier
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /lending-application:
    get:
      operationId: get_lending_application
      tags:
      - Lending Application
      summary: List my applications
      x-source: https://docs.droplinked.com/developers/lending-application-api/endpoints.md
      parameters:
      - name: merchantId
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_lending_application
      tags:
      - Lending Application
      summary: POST /lending-application
      x-source: https://docs.droplinked.com/developers/lending-application-api/endpoints.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostLendingApplicationResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X POST https://apiv3.droplinked.com/lending-application  -H "Authorization: Bearer <merchant-jwt>"  -H "Content-Type:
          application/json"  -d ''{}''

          ```'
  /lending-application/{id}:
    get:
      operationId: get_lending_application_id
      tags:
      - Lending Application
      summary: Get application
      x-source: https://docs.droplinked.com/developers/lending-application-api/endpoints.md
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    patch:
      operationId: patch_lending_application_id
      tags:
      - Lending Application
      summary: Update application
      x-source: https://docs.droplinked.com/developers/lending-application-api/endpoints.md
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchLendingApplicationIdRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /lending-application/{id}/checklist:
    get:
      operationId: get_lending_application_id_checklist
      tags:
      - Lending Application
      summary: Get document checklist
      x-source: https://docs.droplinked.com/developers/lending-application-api/endpoints.md
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLendingApplicationIdChecklistResponse'
      x-evidence:
        kind: documentation
  /lending-application/{id}/submit:
    post:
      operationId: post_lending_application_id_submit
      tags:
      - Lending Application
      summary: Submit application
      x-source: https://docs.droplinked.com/developers/lending-application-api/endpoints.md
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /lending-application/{id}/withdraw:
    post:
      operationId: post_lending_application_id_withdraw
      tags:
      - Lending Application
      summary: Withdraw application
      x-source: https://docs.droplinked.com/developers/lending-application-api/endpoints.md
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostLendingApplicationIdWithdrawRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/api/inventory-os/manifest:
    get:
      operationId: get_v1_api_inventory_os_manifest
      tags:
      - Api
      summary: GET /v1/api/inventory-os/manifest
      x-source: https://docs.droplinked.com/developers/inventory-os-api/overview.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl https://apiv3.droplinked.com/v1/api/inventory-os/manifest

          ```'
  /v1/api/inventory-os/streams/{streamtype}:
    get:
      operationId: get_v1_api_inventory_os_streams_streamtype
      tags:
      - Api
      summary: Read a stream (paginated)
      x-source: https://docs.droplinked.com/developers/inventory-os-api/overview.md
      parameters:
      - name: streamtype
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/api/inventory-os/streams/{streamtype}/snapshot:
    get:
      operationId: get_v1_api_inventory_os_streams_streamtype_snapshot
      tags:
      - Api
      summary: Cached snapshot (first 200 rows)
      x-source: https://docs.droplinked.com/developers/inventory-os-api/overview.md
      parameters:
      - name: streamtype
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/api/inventory-os/streams/{streamtype}/subscribe:
    post:
      operationId: post_v1_api_inventory_os_streams_streamtype_subscribe
      tags:
      - Api
      summary: Create subscription
      x-source: https://docs.droplinked.com/developers/inventory-os-api/subscriptions.md
      parameters:
      - name: streamtype
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1ApiInventoryOsStreamsStreamtypeSubscribeRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1ApiInventoryOsStreamsStreamtypeSubscribeResponse'
      x-evidence:
        kind: documentation
  /v1/api/inventory-os/streams/{streamtype}/subscriptions:
    get:
      operationId: get_v1_api_inventory_os_streams_streamtype_subscriptions
      tags:
      - Api
      summary: List subscriptions
      description: Each subscription object includes id, apiKeyId, merchantId, streamType, webhookUrl, events, status, and failureCount. The hmacSecret
        is never returned.
      x-source: https://docs.droplinked.com/developers/inventory-os-api/subscriptions.md
      parameters:
      - name: streamtype
        in: path
        required: true
        schema:
          type: string
      - name: status
        in: query
        required: false
        schema:
          type: string
        description: 'Optional filter: ACTIVE, PAUSED, or EXPIRED'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1ApiInventoryOsStreamsStreamtypeSubscriptionsResponse'
      x-evidence:
        kind: documentation
  /v1/api/inventory-os/streams/{streamtype}/subscriptions/{id}:
    delete:
      operationId: delete_v1_api_inventory_os_streams_streamtype_subscriptions_id
      tags:
      - Api
      summary: Delete subscription
      x-source: https://docs.droplinked.com/developers/inventory-os-api/subscriptions.md
      parameters:
      - name: streamtype
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteV1ApiInventoryOsStreamsStreamtypeSubscriptionsIdRespon'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostAdminLendingApplicationIdDecisionRequest:
      type: object
      properties:
        decision:
          type: string
          description: APPROVED | REJECTED | UNDER_REVIEW
        reason:
          type: string
        partnerExternalRef:
          type: string
      required:
      - decision
    PostAdminLendingApplicationCreditTierPreviewRequest:
      type: object
      properties:
        cohort:
          type: string
        monthlyAvgRevenueUsd:
          type: integer
        verifiedCollateralUsd:
          type: integer
        operationalRisk:
          type: string
    PostLendingApplicationResponse:
      type: object
      properties:
        cohort:
          type: string
        partner:
          type: string
        items:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
              label:
                type: string
              description:
                type: string
              required:
                type: boolean
              acceptedMimeTypes:
                type: array
                items:
                  type: string
              maxSizeMb:
                type: integer
    PatchLendingApplicationIdRequest:
      type: object
      properties:
        requestedAmountUsd:
          type: number
          description: 1000 – 10,000,000
        requestedTermMonths:
          type: integer
          description: 1 – 60
        purposeCode:
          type: string
          description: 'enum: INVENTORY, WORKING_CAPITAL, EXPANSION, EQUIPMENT'
        selectedTier1Partner:
          type: string
          description: 'enum: CredibleX, CBI, RAKBank, Mbank'
        selectedTier2Partner:
          type: string
          description: Free-form Tier-2 partner id
        documentationCompleted:
          type: object
          description: Free-form per-document upload acknowledgement
    GetLendingApplicationIdChecklistResponse:
      type: object
      properties:
        cohort:
          type: string
        partner:
          type: string
        items:
          type: array
          description: List of checklist items
    PostLendingApplicationIdWithdrawRequest:
      type: object
      properties:
        reason:
          type: string
          description: Optional reason for withdrawal
    PostV1ApiInventoryOsStreamsStreamtypeSubscribeRequest:
      type: object
      properties:
        webhookUrl:
          type: string
          description: HTTPS endpoint (plain HTTP is rejected). 8–2048 chars.
        events:
          type: array
          description: Subset of the stream's event vocabulary. Defaults to all events.
        description:
          type: string
          description: Human‑readable label (0–200 chars).
      required:
      - webhookUrl
    PostV1ApiInventoryOsStreamsStreamtypeSubscribeResponse:
      type: object
      properties:
        id:
          type: string
        apiKeyId:
          type: string
        merchantId:
          type: string
        streamType:
          type: string
        webhookUrl:
          type: string
        events:
          type: array
        description:
          type: string
        status:
          type: string
        failureCount:
          type: integer
        hmacSecret:
          type: string
    GetV1ApiInventoryOsStreamsStreamtypeSubscriptionsResponse:
      type: object
      properties:
        data:
          type: array
          description: Array of subscription objects
        total:
          type: integer
          description: Total number of subscriptions returned
    DeleteV1ApiInventoryOsStreamsStreamtypeSubscriptionsIdRespon:
      type: object
      properties:
        ok:
          type: boolean
        deletedId:
          type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: Authorization
security:
- apiKey: []
tags:
- name: Admin
- name: Api
- name: Lending Application