Bold Penguin Prospects API

openapi: 3.2.0
info:
  title: Bold Penguin Prospects 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: Prospects
paths:
  /prospects:
    post:
      operationId: post_prospects
      tags:
      - Prospects
      summary: Receive prospects from the Bold Penguin Exchange by providing an HTTP endpoint…
      x-source: https://developers.boldpenguin.com/docs/api/receive_prospect
      parameters:
      - name: coverage_type_ids
        in: query
        required: true
        schema:
          type: array
        description: An array of integer IDs of the coverage type for the policy
      - name: lead_id
        in: query
        required: true
        schema:
          type: string
        description: Record locator used to retrieve disposition records for this prospect.
      - name: legal_entity_id
        in: query
        required: true
        schema:
          type: integer
        description: Current status of the prospect
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostProspectsRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostProspectsResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostProspectsResponse:
      type: object
      properties:
        response.status:
          type: string
          description: Indicates that you have successfully received the prospect. Value must be Success
    PostProspectsRequest:
      type: object
      properties:
        actual_years_in_business:
          type: integer
        address:
          type: string
        alt_phone_number:
          type: string
        business_name:
          type: string
        city:
          type: string
        completed_at:
          type: string
        coverage_type_ids:
          type: array
        currently_insured:
          type: boolean
        duns:
          type: string
        ein:
          type: string
          description: DEPRECATED FIELD
        email:
          type: string
          description: DEPRECATED FIELD
        estimated_annual_payroll:
          type: integer
        estimated_annual_revenue:
          type: integer
        external_id:
          type: string
        first_name:
          type: string
          description: DEPRECATED FIELD
        full_time_employees:
          type: integer
        key:
          type: string
        last_name:
          type: string
          description: DEPRECATED FIELD
        lead_id:
          type: string
        legal_entity_id:
          type: integer
        naic_id:
          type: integer
        naics_code:
          type: string
        naics_description:
          type: string
        name:
          type: string
        part_time_employees:
          type: integer
        phone_number:
          type: string
        source:
          type: string
        state:
          type: string
          description: DEPRECATED FIELD
        website:
          type: string
        years_of_experience:
          type: integer
          description: DEPRECATED FIELD
        zip:
          type: string
      required:
      - coverage_type_ids
      - lead_id
      - legal_entity_id
  securitySchemes:
    bearer:
      type: http
      scheme: bearer