openapi: 3.2.0
info:
  title: Bold Penguin Leads API
  version: '2026-10-02'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-02: 20 operation(s) read from 16 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Bold Penguin has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 11
    documentation: 9
    pages-with-code: 13
    pages-read: 16
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-02'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://developers.boldpenguin.com/docs/api/create_application_form
  - https://developers.boldpenguin.com/docs/api/get_latest_application_form
  - https://developers.boldpenguin.com/docs/api/get_consumer_application_form
  - https://developers.boldpenguin.com/docs/terminal/quote_start/authentication
  - https://developers.boldpenguin.com/docs/exchange/send_side/ss_authentication
  - https://developers.boldpenguin.com/docs/insurance_intelligence/market_intelligence
  - https://developers.boldpenguin.com/docs/api/authenticate
  - https://developers.boldpenguin.com/docs/api/clone_application_form
  - https://developers.boldpenguin.com/docs/api/get_attachments
  - https://developers.boldpenguin.com/docs/api/create_disposition
  - https://developers.boldpenguin.com/docs/api/receive_prospect
  - https://developers.boldpenguin.com/docs/api/update_quote_request
  - https://developers.boldpenguin.com/docs/api/send_prospect
  - https://developers.boldpenguin.com/docs/api/get_dispositions
  - https://developers.boldpenguin.com/docs/api/lend_app_form
  - https://developers.boldpenguin.com/docs/api/update_application_form
servers:
- url: https://partner-engine.boldpenguin.com
security:
- bearer: []
tags:
- name: Leads
paths:
  /leads:
    post:
      operationId: post_leads
      tags:
      - Leads
      summary: POST /leads
      x-source: https://developers.boldpenguin.com/docs/api/create_disposition
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostLeadsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -v -X POST \ --header "Authorization: Bearer <access_token>" --header "Content-Type: application/json" \ -d @quoted_data.json \ https://api-staging.boldpenguin.com/leads/ < lead_id > /lead_attributes Sold disposition ​ $ cat sold_data.json { "carrier" : "Insurance Carrier" , "coverage_type_id" : 5 , "history" : "This prospect was sold to Insurance Carrier" "premium" : "100.00" , "rate" : "5.0'
  /leads/{leadId}/lead_attributes:
    get:
      operationId: get_leads_leadId_lead_attributes
      tags:
      - Leads
      summary: Get Disposition Records
      x-source: https://developers.boldpenguin.com/docs/api/get_dispositions
      parameters:
      - name: leadId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLeadsLeadidLeadAttributesResponse'
      x-evidence:
        kind: documentation
  /leads/{leadid}:
    get:
      operationId: get_leads_leadid
      tags:
      - Leads
      summary: GET /leads/{leadId}
      x-source: https://developers.boldpenguin.com/docs/api/get_dispositions
      parameters:
      - name: leadid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLeadsLeadidResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -v -X GET \ --header "Authorization: Bearer <access_token>" --header "Content-Type: application/json" \ https://api-staging.boldpenguin.com/leads/<lead_id>/lead_attributes Example Response ​ [ { "id" : 263035 , "status" : "Active" , "premium" : null , "rate" : null , "history" : null , "carrier" : null , "lead_id" : 6075388 , "external_id" : null , "quoted_at" : null , "sold_at" : null , "cov'
components:
  schemas:
    GetLeadsLeadidResponse:
      type: object
      properties:
        id:
          type: integer
        status:
          type: string
        premium:
          type:
          - string
          - 'null'
        rate:
          type:
          - string
          - 'null'
        history:
          type:
          - string
          - 'null'
        carrier:
          type:
          - string
          - 'null'
        lead_id:
          type: integer
        external_id:
          type:
          - string
          - 'null'
        quoted_at:
          type:
          - string
          - 'null'
        sold_at:
          type:
          - string
          - 'null'
        coverage_type_id:
          type: integer
        coverage_types:
          type: array
          items: {}
    PostLeadsResponse:
      type: object
      properties:
        id:
          type: integer
        status:
          type: string
        premium:
          type: string
        rate:
          type: string
        history:
          type: string
        carrier:
          type: string
        lead_id:
          type: integer
        external_id:
          type:
          - string
          - 'null'
        quoted_at:
          type: string
          format: date
        sold_at:
          type: string
          format: date
        coverage_type_id:
          type: integer
        coverage_types:
          type: array
          items: {}
    GetLeadsLeadidLeadAttributesResponse:
      type: object
      properties:
        carrier:
          type: string
          description: The name of the carrier through which the policy was sold.
        coverage_type_id:
          type: integer
          description: The integer ID of the coverage type for the policy.
        coverage_types:
          type: array
          description: Unused Empty array.
        external_id:
          type: integer
          description: Unused Empty array.
        history:
          type: string
          description: A field for text notes, history of prospect.
        id:
          type: integer
          description: Unique ID for this disposition record.
        lead_id:
          type: integer
          description: Unique ID for the lead associated with this disposition record.
        premium:
          type: number
          description: The yearly premium for the policy.
        quoted_at:
          type: string
          description: Date quoted (YYYY-MM-DD).
        rate:
          type: number
          description: The commission rate on the policy.
        sold_at:
          type: string
          description: Date sold (YYYY-MM-DD).
        status:
          type: string
          description: Current status of the prospect.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer