The Binding API from Cover Whale — 1 operation(s) for binding.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/coverwhaleinsurancesolutions:coverwhaleinsurancesolutions-binding-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Coverwhaleinsurancesolutions Binding API
version: '1.0'
contact:
name: Cover Whale API Team
description: 'Operations tagged Binding across 2 of this provider''s published API definitions: coverwhaleinsurancesolutions-openapi.json, coverwhaleinsurancesolutions-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.coverwhale.dev/v1
security:
- AccessToken: []
tags:
- name: Binding
paths:
/bind/{displayId}:
put:
tags:
- Binding
summary: Bind a Quoted Submission
description: Submit a bind request for a quoted submission. The submission must be in 'Quoted' status.
operationId: bindRequest
parameters:
- name: Content-Type
in: header
required: true
schema:
type: string
example: application/json
- name: Accept
in: header
required: true
schema:
type: string
example: application/json
- name: AccessToken
in: header
required: true
schema:
type: string
example: eyJraWQiOiJnRk5oTTh2RnRKWXVDVXU1S........
- name: displayId
in: path
description: The submission display ID
required: true
schema:
type: string
example: '2261310'
requestBody:
required: true
content:
application/json:
schema:
properties:
coverage:
properties:
includeAPD:
description: Include Auto Physical Damage coverage
type: string
example: Y
includeAL:
description: Include Auto Liability coverage
type: string
example: Y
includeTGL:
description: Include Truckers General Liability coverage
type: string
example: Y
includeNTL:
description: Include Non-Trucking Liability coverage
type: string
example: Y
includeMTC:
description: Include Motor Truck Cargo coverage
type: string
example: Y
brokerFeeAL:
description: Broker fee for Auto Liability coverage. Rejected when the linked company's preferred financing company is set to "Other", and rejected when the carrier placed for AL is admitted.
type: number
example: 10
brokerFeeAPD:
description: Broker fee for Auto Physical Damage coverage. Rejected when the linked company's preferred financing company is set to "Other", and rejected when the carrier placed for APD is admitted.
type: number
example: 10
brokerFeeMTC:
description: Broker fee for Motor Truck Cargo coverage. Rejected when the linked company's preferred financing company is set to "Other", and rejected when the carrier placed for MTC is admitted.
type: number
example: 10
brokerFeeTGL:
description: Broker fee for Truckers General Liability coverage. Rejected when the linked company's preferred financing company is set to "Other", and rejected when the carrier placed for TGL is admitted.
type: number
example: 10
brokerFeeNTL:
description: Broker fee for Non-Trucking Liability coverage. Rejected when the linked company's preferred financing company is set to "Other", and rejected when the carrier placed for NTL is admitted.
type: number
example: 10
optInCWFinancing:
description: Opt into Cover Whale financing
type: string
example: Y
electTRIA:
description: Elect TRIA coverage
type: string
example: N
effectiveDate:
description: Policy effective date (mm/dd/yyyy)
type: string
example: 02/25/2026
type: object
bindingMethod:
properties:
signFirst:
description: Whether insured signs before binding
type: string
example: N
retailAgentEmail:
type: string
example: agent@example.com
insuredEmail:
type: string
example: insured@example.com
insuredFullName:
type: string
example: John Doe
electronicSignature:
description: Use electronic signature
type: string
example: Y
acknowledgeMissingOwnerDriverWarning:
description: Acknowledges the missing owner-driver warning returned as a 422. Accepted here or at the top level of the request body; either location has the same effect.
type: boolean
example: true
type: object
shippingAddress:
properties:
dashcam_shipping_address:
description: Ship dashcam to insured or other address
type: string
example: insured
street:
type: string
example: 4310 W Jefferson Blvd
city:
type: string
example: Los Angeles
state:
type: string
example: CA
zip:
type: string
example: '90016'
county:
type: string
example: Los Angeles
type: object
diligentSearch:
description: California diligent-search declarations for the surplus lines SL-2 form. Required only when the submission needs that form for California and Auto Liability is being bound. All three insurer names must be supplied and different from one another, all three NAIC codes must be supplied and different from one another, and each name and code must match the California admitted-insurers list. Ignored when those conditions do not apply.
properties:
insurer1Name:
description: Name of admitted insurer 1 that declined the risk.
type: string
example: Progressive Commercial
insurer1Naic:
description: NAIC code for admitted insurer 1.
type: string
example: '24260'
insurer1OnlineDeclination:
description: Whether the declination for insurer 1 was obtained online.
type: string
enum:
- Y
- N
example: N
insurer1Website:
description: Website used to obtain the declination for insurer 1.
type: string
example: https://www.progressivecommercial.com
insurer1ContactName:
description: Contact name at insurer 1.
type: string
example: Jane Underwriter
insurer1ContactPhoneEmail:
description: Contact phone number or email address at insurer 1.
type: string
example: jane@example.com / 555-123-4567
insurer2Name:
description: Name of admitted insurer 2 that declined the risk.
type: string
example: Great West Casualty
insurer2Naic:
description: NAIC code for admitted insurer 2.
type: string
example: '11371'
insurer2OnlineDeclination:
description: Whether the declination for insurer 2 was obtained online.
type: string
enum:
- Y
- N
example: Y
insurer2Website:
description: Website used to obtain the declination for insurer 2.
type: string
example: https://www.gwccnet.com
insurer2ContactName:
description: Contact name at insurer 2.
type: string
example: Bob Broker
insurer2ContactPhoneEmail:
description: Contact phone number or email address at insurer 2.
type: string
example: bob@example.com / 555-987-6543
insurer3Name:
description: Name of admitted insurer 3 that declined the risk.
type: string
example: Canal Insurance
insurer3Naic:
description: NAIC code for admitted insurer 3.
type: string
example: '10464'
insurer3OnlineDeclination:
description: Whether the declination for insurer 3 was obtained online.
type: string
enum:
- Y
- N
example: N
insurer3Website:
description: Website used to obtain the declination for insurer 3.
type: string
example: https://www.canalinsurance.com
insurer3ContactName:
description: Contact name at insurer 3.
type: string
example: Sam Producer
insurer3ContactPhoneEmail:
description: Contact phone number or email address at insurer 3.
type: string
example: sam@example.com / 555-555-0100
type: object
acknowledgeMissingOwnerDriverWarning:
description: Acknowledges the missing owner-driver warning returned as a 422. Accepted here or inside bindingMethod; either location has the same effect.
type: boolean
example: true
acknowledgeQuoteRevision:
description: Required after an effective-date quote refresh, once the caller has displayed and accepted the returned quote revision differences.
type: boolean
example: true
quoteRevisionKey:
description: The current quote revision identity returned by the refresh response.
type: string
format: uuid
example: aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa
type: object
responses:
'200':
description: Bind request submitted successfully. When the submission has Cover Whale financing, the response also includes a premium_finance block describing the loan terms.
content:
application/json:
schema:
properties:
status:
type: string
example: bind requested
submission_number:
type: string
example: '264206519582'
coverages:
type: object
premium_finance:
description: Premium finance terms. Present only when the submission has an active premium-finance flow with persisted terms; omitted otherwise.
properties:
provider:
description: One of capital, fif, national_partners, honor
type: string
example: capital
down_payment:
type: number
format: float
example: 4250.0
monthly_payment:
type: number
format: float
example: 1583.33
effective_apr:
description: Effective annual percentage rate as a decimal (0.0925 = 9.25%)
type: number
format: float
example: 0.0925
number_of_payments:
type: integer
example: 9
total_of_payments:
description: Null for Capital and National Partners, which do not populate this field
type:
- number
- 'null'
format: float
example: 14250.0
type: object
type: object
'202':
description: The effective date changed. Binding stopped and the complete rating and quote-document workflow started. Re-send the bind request with acknowledgeQuoteRevision and quoteRevisionKey once the returned differences have been shown and accepted.
content:
application/json:
schema:
properties:
status:
type: string
example: quote refresh started
reason_code:
type: string
example: quote_refresh_started
error:
type: string
example: The effective date changed, so a complete refreshed quote and document set is being generated.
quote_refresh:
properties:
revision_key:
type: string
format: uuid
batch_id:
type: string
effective_date_before:
type: string
format: date
effective_date_after:
type: string
format: date
years_business_before:
type: integer
months_business_before:
type: integer
years_business_after:
type: integer
months_business_after:
type: integer
type: object
type: object
'401':
description: Unauthorized – missing or invalid AccessToken
'404':
description: Validation error or submission not in quoted status
content:
application/json:
schema:
properties:
status:
type: string
example: failed
error:
type: string
example: Submission status must be quoted
type: object
'422':
description: 'Binding was stopped by a pre-bind check. One such case is a missing owner-driver: retry the same request with acknowledgeMissingOwnerDriverWarning set to true. Other cases carry a reason_code naming the condition.'
content:
application/json:
schema:
properties:
status:
type: string
example: failed
error:
type: string
example: An owner who is also a driver was not found on this submission.
warning_type:
description: Present on the missing owner-driver case.
type: string
example: missing_owner_driver
acknowledgement_required:
description: Present on the missing owner-driver case. When true, retry with acknowledgeMissingOwnerDriverWarning.
type: boolean
example: true
type: object
servers:
- url: https://api.coverwhale.dev/v1
components:
securitySchemes:
AccessToken:
type: apiKey
description: JWT returned as AccessToken by the /authentication endpoint (the Cognito ID token carrying the email claim). It expires after 3600 seconds.
name: AccessToken
in: header
x-refined-from:
- coverwhaleinsurancesolutions-openapi.json
- coverwhaleinsurancesolutions-openapi.json