Bold Penguin Tenants API

openapi: 3.2.0
info:
  title: Bold Penguin Tenants 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: Tenants
paths:
  /tenants:
    post:
      operationId: post_tenants
      tags:
      - Tenants
      summary: POST /tenants
      x-source: https://developers.boldpenguin.com/docs/api/create_application_form
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostTenantsRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostTenantsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl --request POST \ --url https://partner-engine.boldpenguin.com/tenants/ < tenant_id > /application_forms \ --header ''Authorization: Bearer <access-token>'' \ --header ''Content-Type: application/json'' \ --data ''{ "application_form": { "create_guest_user": true, "mark_in_progress": true, "autocomplete": true, "storefront_code": "<string>", "answer_values": [ { "code": "[tenant-code]_zipcode", "an'
  /tenants/{tenantId}/application_forms/{applicationFormId}/clones:
    post:
      operationId: post_tenants_tenantId_application_forms_applicationFormId_clones
      tags:
      - Tenants
      summary: Clone a previously created application form to the Bold Penguin tenant
      x-source: https://developers.boldpenguin.com/docs/api/clone_application_form
      parameters:
      - name: tenantId
        in: path
        required: true
        schema:
          type: string
      - name: applicationFormId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostTenantsTenantidApplicationFormsApplicationformidClonesRe'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostTenantsTenantidApplicationFormsApplicationformidClonesRe2'
      x-evidence:
        kind: documentation
  /tenants/{tenantId}/application_forms/search:
    post:
      operationId: post_tenants_tenantId_application_forms_search
      tags:
      - Tenants
      summary: Get Consumer Application Form (Consumer Flow)
      x-source: https://developers.boldpenguin.com/docs/api/get_consumer_application_form
      parameters:
      - name: tenantId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostTenantsTenantidApplicationFormsSearchRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostTenantsTenantidApplicationFormsSearchResponse'
      x-evidence:
        kind: documentation
  /tenants/{tenantId}/lent_application_forms:
    post:
      operationId: post_tenants_tenantId_lent_application_forms
      tags:
      - Tenants
      summary: Lend Application Form (Exchange)
      x-source: https://developers.boldpenguin.com/docs/api/lend_app_form
      parameters:
      - name: tenantId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostTenantsTenantidLentApplicationFormsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostTenantsTenantidLentApplicationFormsResponse'
      x-evidence:
        kind: documentation
  /tenants/{tenantid}:
    patch:
      operationId: patch_tenants_tenantid
      tags:
      - Tenants
      summary: PATCH /tenants/{tenantId}
      x-source: https://developers.boldpenguin.com/docs/api/update_application_form
      parameters:
      - name: tenantid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchTenantsTenantidRequest'
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchTenantsTenantidResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl --request PATCH \ --url https://partner-engine.boldpenguin.com/tenants/<tenant_id>/application_forms/<application_form_id> \ --header ''Authorization: Bearer <access-token>'' \ --header ''Content-Type: application/json'' \ --data ''{ "application_form": { "answer_values": [ { "code": "[tenant-code]_zipcode", "answer": "43215" }, { "code": "[tenant-code]_coverage_types", "answer": "Business Owners '
    post:
      operationId: post_tenants_tenantid
      tags:
      - Tenants
      summary: POST /tenants/{tenantId}
      x-source: https://developers.boldpenguin.com/docs/api/get_consumer_application_form
      parameters:
      - name: tenantid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostTenantsTenantidRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostTenantsTenantidResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl --request POST \ --url https://partner-engine.boldpenguin.com/tenants/<tenant_id>/application_forms/search \ --header ''Authorization: Bearer <access-token>'' \ --header ''Content-Type: application/json'' \ --data ''{ "application_form": { "create_guest_token": true, "reference_id": "XXX-XXX-XXX", "answer_values": [ { "code": "mqs_zipcode", "answer": "XXXXX" }, { "code": "mqs_last_name", "answer":'
components:
  schemas:
    PostTenantsTenantidLentApplicationFormsRequest:
      type: object
      properties:
        application_form:
          type: object
          description: Your JSON payload may contain an application_form object.
        application_form.answer_values:
          type: array
          description: One or more questions and answers to prepopulate in the form.
        application_form.answer_values[].code:
          type: string
          description: Question code from the Master Question Set.
        application_form.answer_values[].answer:
          type: string
          description: Answer string for the corresponding question code.
    PatchTenantsTenantidResponse:
      type: object
      properties:
        id:
          type: string
        reference_id:
          type: string
        redirect_url:
          type:
          - string
          - 'null'
    PostTenantsTenantidResponse:
      type: object
      properties:
        id:
          type: string
        redirect_url:
          type: string
        reference_id:
          type: string
    PostTenantsRequest:
      type: object
      properties:
        application_form:
          type: object
          properties:
            create_guest_user:
              type: boolean
            mark_in_progress:
              type: boolean
            autocomplete:
              type: boolean
            storefront_code:
              type: string
            answer_values:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  answer:
                    type: string
    PostTenantsResponse:
      type: object
      properties:
        id:
          type: string
        reference_id:
          type: string
        redirect_url:
          type:
          - string
          - 'null'
    PatchTenantsTenantidRequest:
      type: object
      properties:
        application_form:
          type: object
          properties:
            answer_values:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  answer:
                    type: string
    PostTenantsTenantidApplicationFormsSearchRequest:
      type: object
      properties:
        application_form:
          type: object
          description: Object containing the search criteria.
        application_form.create_guest_token:
          type: boolean
          description: Set this to true to generate a redirect URL for consumers.
        application_form.reference_id:
          type: string
          description: 'A unique ID visible to the consumer in the Consumer Portal (format: XXX-XXX-XXX).'
        application_form.answer_values:
          type: array
          description: Array containing the mqs_zipcode and mqs_last_name question codes with answers.
        application_form.answer_values[].code:
          type: string
          description: Question code (e.g., mqs_zipcode, mqs_last_name).
        application_form.answer_values[].answer:
          type: string
          description: Answer supplied in the original form.
      required:
      - application_form
      - application_form.reference_id
      - application_form.answer_values[].code
      - application_form.answer_values[].answer
    PostTenantsTenantidApplicationFormsSearchResponse:
      type: object
      properties:
        id:
          type: string
          description: The unique ID for this application form within the tenant.
        redirect_url:
          type: string
          description: A one-time-use URL for displaying the form to the consumer (populated if create_guest_user was true).
        reference_id:
          type: string
          description: A unique ID visible to the consumer in the Consumer Portal.
    PostTenantsTenantidApplicationFormsApplicationformidClonesRe:
      type: object
      properties:
        application_form:
          type: object
          description: A JSON structure referencing the destination tenant_id for the application form.
        application_form.tenant_id:
          type: string
          description: For Bold Penguin, the tenant_id is 76fe7443-2629-494c-b645-9c4d14d780e2.
      required:
      - application_form
      - application_form.tenant_id
    PostTenantsTenantidLentApplicationFormsResponse:
      type: object
      properties:
        id:
          type: string
          description: A globally unique ID for this instance of the application form within the tenant.
        reference_id:
          type: string
          description: This ID will remain constant throughout the life of the application form.
        redirect_url:
          type: string
          description: Not used in this context.
    PostTenantsTenantidApplicationFormsApplicationformidClonesRe2:
      type: object
      properties:
        id:
          type: string
          description: The unique ID for the cloned application form in the Bold Penguin tenancy.
        redirect_url:
          type: string
          description: Not used in this context.
    PostTenantsTenantidRequest:
      type: object
      properties:
        application_form:
          type: object
          properties:
            create_guest_token:
              type: boolean
            reference_id:
              type: string
            answer_values:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  answer:
                    type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer