account_history-def
idAccount History ID
revisionIdRevision ID
policyTermIdPolicy Term ID
transactionDateTimeTransaction Date Time. It is returned as a datetime python object in Jinja.
transactionTypepaymentAmountdebitPremiumFullyBilleddebitPremiumFullyEarneddebitPremiumProRatadebitCustomFeeFullyBilleddebitCustomFeeFullyEarneddebitCustomFeeProRatadebitSystemFeepaidInFullaccountBalancedeletedvoideddirtydateAddedDate Added. It is returned as a date python object in Jinja.
dateAddedMicrodateUpdatedDate Updated. It is returned as a date python object in Jinja.
fileIdFile ID
paymentIdPayment ID
waiveIdWaive ID
creditTransferIddebitTransferIdgeneratedByUsername of the contact that generated the transaction.
descriptiondueDateDue Date. It is returned as a date python object in Jinja.
cancelDateCancel Date. It is returned as a date python object in Jinja.
dayZeroDateDay Zero Date. It is returned as a date python object in Jinja.
backCancelDateBack Cancel Date. It is returned as a datetime python object in Jinja.
dateDeletedDate Deleted. It is returned as a date python object in Jinja.
dateVoidedDate Voided. It is returned as a date python object in Jinja.
cancellationRevisionIdadditional_interest-def
idAdditional interest ID
contact_idID of the contact associated with this interest
quote_idID of the quote/revision this interest belongs to (revision-level only)
vehicle_idID of the vehicle this interest belongs to (risk-level only)
risk_idID of the risk/property this interest belongs to (risk-level only)
interest_typeInterest type label resolved from ADDITIONAL_INTEREST_TYPES QuickCode at response-serialization time (e.g. 'Loss Payee'). Read-only surface: writes go through interest.
loan_numberLoan number associated with the interest (risk-level only)
notesFree-text additional notes for the interest
interestADDITIONAL_INTEREST_TYPES codeValueType stored on the row (e.g. 'LOSS_PAYEE', 'ADDITIONAL_INTEREST'). Codes are stable; labels are derived at read time on interest_type.
nameContact name
typeContact type
ssnSocial Security Number (masked in responses: xxx-xx-LAST4)
date_of_birthDate of birth (masked in responses: xx-xx-YEAR)
fein_tax_idFederal EIN/Tax ID for organizations
legal_entity_typeLegal entity type for organizations
Contact phone numbers
Contact addresses
Contact email addresses
can_editWhether the contact can be edited; false when the contact appears on another active policy. Null when context is insufficient to determine.
address-def
citystreetstatezipcodeis_preferredcountyline2typeadjuster_assignment-def
idcontact_idactivehour_assign_fromhour_assign_tomondaytuesdaywednesdaythursdayfridaysaturdaysundaymax_claims_per_daymax_claims_per_weekmax_claims_per_monthbusiness_location_idszip_codesperil_idscatastrophe_idstotal_assignments_todaytotal_assignments_weektotal_assignments_monthcontact_group_namelast_assignment_dateis_internal_adjusteris_external_adjusteragency-def
purchase_dateDate of purchase
agency_inception_dateAgency inception date
fein_tax_idFederal Employer Identification Number
websitewebsite
agency_numberAgency number
dbaagency_termination_dateAgency termination date
company_idCompany ID
date_business_startedDate business started
commission_structuredate_of_birthssnssn_grouptypeprimary_email_idprimary_phone_idconfirmation_emailusernameidhicn_numberlegal_entity_typenameprimary_address_idsource_update_datelast_synched_dateexternal_system_referenceExternal system reference
agency_group-def
purchase_dateDate of purchase
agency_inception_dateAgency inception date
fein_tax_idFederal Employer Identification Number
websitewebsite
agency_group_numberAgency Group number
dbaagency_termination_dateAgency termination date
company_idCompany ID
date_business_startedDate business started
commission_structuredate_of_birthssnssn_grouptypeprimary_email_idprimary_phone_idconfirmation_emailusernameidhicn_numberlegal_entity_typenameprimary_address_idsource_update_datelast_synched_dateexternal_system_referenceExternal system reference
agent-def
genderpositiondate_of_deathlicense_statecommission_structureadded_bydate_of_birthssnexternal_system_referencessn_grouptypeprimary_email_iddrivers_licenseprimary_phone_idconfirmation_emailusernameidhicn_numberdriver_license_datelegal_entity_typenameprimary_address_idproducer_numbersource_update_datelast_synched_dateapplicable_form-def
form_idFile.id of the form. The wizard frontend builds the preview URL itself as /gateway?file=core.uploads&method=getAttachment&id=<form_id> -- the same shape every other File download uses. The applicability gate stays server-side: only ids returned in this response are previewable.
form_numberForm code / number (e.g. HO-3, FL-5)
form_titleDisplay title pulled from the underlying File
form_typeFile sub_type (e.g. New Policy, Renewal, Endorsement)
applicabilityHuman-readable scope: 'Policy-wide' for policy-level forms or the coverage name (e.g. 'Dwelling') for coverage-specific forms.
has_previewTrue iff the underlying File has a usable URL. UI must disable the Preview action when false.
edition_numberEdition / version of the form
descriptionForm description
mime_typeMIME type of the form file (e.g. application/pdf)
billing_schedule-def
idnamelife_cycle_idordercustom_termnine_months_termeighteen_months_termsix_months_termthree_months_termone_year_termthree_years_termbill_to_insuredbill_to_agencybill_to_mortgageebill_to_add_intinitial_invoiceinitial_duemid_term_invoicemid_term_duerenewal_invoicerenewal_duetrans_new_businesstrans_renewaltrans_mid_term_chargestrans_cancellationtrans_reinstatementdefault_scheduleshow_on_invoicesshow_in_public_gatewayshow_in_payment_sweepautomatic_payment_remindermin_amount_dueMinimum amount due (decimal as string)
migrate_on_renewalSchedule ID to migrate to on renewal
use_initial_ach_installment_feeinitial_ach_installment_fee_amountuse_recurring_ach_installment_feerecurring_ach_installment_fee_amountuse_initial_credit_card_installment_feeinitial_credit_card_installment_fee_amountuse_recurring_credit_card_installment_feerecurring_credit_card_installment_fee_amountInstallment definitions for this billing schedule
billing_schedule_installment-def
idbill_sched_idinstallment_feeFee amount (decimal as string)
months_after_eff_dateis_renewalPayment instrument allocations for this installment
brand-def
idUnique identifier for the brand
nameBrand name
logo_file_idFile ID for the brand logo
signature_file_idFile ID for the brand signature
header_line_1Header line 1
header_line_2Header line 2
header_line_3Header line 3
header_line_4Header line 4
activeWhether the brand is active
date_createdDate the brand was created
date_updatedDate the brand was last updated
brand_association-def
idUnique identifier for the brand association
brand_idBrand identifier
location_idBusiness location identifier
policy_type_definition_idPolicy type definition identifier
date_createdDate the association was created
date_updatedDate the association was last updated
bulk_create_dispute_date_item-def
dateDate value (YYYY-MM-DD)
typeCLAIM_DATE_TYPE quick code value (e.g. assigned, suitOpened)
idID of the claim_date row
claim_idOptional. Overwritten by the top-level bulk_create_disputes claim_id.
dispute_idID of the parent dispute
date_updatedLast update timestamp (YYYY-MM-DDTHH:MM:SS)
bulk_create_dispute_item-def
nameFree-text name of the dispute
typeDispute classification
idID of the dispute
claim_idOptional. Overwritten by the top-level bulk_create_disputes claim_id.
handling_claims_adjuster_idID of the handling claims adjuster contact
handling_claims_adjuster_nameDisplay name of the handling claims adjuster
handling_external_legal_staffContact IDs assigned as external legal staff for this dispute
is_codefendantis_structured_settlementis_appraisal_requestedis_bad_faithis_economic_damageis_excess_policylawsuit_namelawsuit_statelawsuit_typeLAWSUIT_TYPE quick code value
docket_numbercase_numberdefendant_firm_iddefendant_attorney_idcourt_typeCLAIMS_COURT_TYPE quick code value (e.g. FEDERAL_COURT, STATE_COURT, MEDIATION, OTHER). The set of allowed values is configurable through the Lookups UI.
judge_idplaintiff_firm_idplaintiff_attorney_idremarksbulk_create_disputes-def
claim_idID of the owning claim. Applied to every dispute item (and nested dispute_dates) before validation.
List of disputes to create. Nested claim_id may be omitted.
calculated_field-def
idUnique identifier
field_name^[a-zA-Z_][a-zA-Z0-9… · requiredValid Python identifier used as calculated.field_name
expressionRestrictedPython expression to evaluate
sort_orderEvaluation order within scope (lower = evaluated first)
field_typeComputed field: 'global' if x_report_location_id is null, 'template' otherwise
x_report_location_idTemplate deliverable ID. Null for global fields.
pathDot-notation path where the field is evaluated (e.g. 'drivers', 'coverages.deductibles'). Empty string for root.
descriptionOptional description of what the field computes
cancellation_reason-def
idreasonpolicy_life_cycle_idprint_descriptioncategoryis_modifiableclaim_estimation-def
claim_ididxact_assignment_idassignment_typexact_analysis_statussent_datesent_byassignment_dateinspection_datecontact_dateestimate_dateappointment_dateestimate_approval_datebuilding_estimate_amountcontents_estimate_amounticc_estimate_amountstatuscanceled_bycanceled_dateis_canceledclaim_exposure_payment-def
exposure_idID of the exposure this payment is for
payee_idsList of payee contact IDs
dateDate of the payment
idUnique identifier for the payment
deductible_amountDeductible amount for the payment
display_on_checkText to display on the check
payment_classificationClassification of the payment
payment_methodPayment method used
address_idAddress ID for the payment (if applicable)
loss_paidLoss paid amount
adjusting_paidAdjusting paid amount
legal_paidLegal paid amount
memoMemo for the payment
system_tagsSystem tags for the payment (key-value pairs)
claim_multi_exposure_payment-def
payee_idsList of payee contact IDs
dateDate of the payment
idUnique identifier for the payment
List of payments for exposures
deductible_amountDeductible amount for the payment
display_on_checkText to display on the check
payment_classificationClassification of the payment
payment_methodPayment method used
address_idAddress ID for the payment (if applicable)
memoMemo for the payment
system_tagsSystem tags for the payment (key-value pairs)
claim_transaction-def
idUnique identifier for the transaction
transaction_typeType of accounting transaction
transaction_categoryCategory of the transaction
amountTransaction amount
transaction_datetimeDate and time of the transaction
new_amountNew amount after transaction
previous_amountPrevious amount before transaction
exportedWhether the transaction has been exported
exported_datetimeDate and time when transaction was exported
voidedWhether the transaction has been voided
voided_datetimeDate and time when transaction was voided
modified_by_usernameUsername of the person who modified the transaction
descriptionDescription of the transaction
memoMemo associated with the transaction
recovery_categoryCategory of recovery (only for recovery transactions)
contact_idID of the contact associated with the transaction
address_idID of the address associated with the transaction
exposure_idID of the claim exposure associated with the transaction
payee_idsList of payee IDs associated with the transaction
payment_classificationClassification of the payment
payment_method_account_nameName of the payment method account
payment_method_masked_numberMasked payment method number
payment_methodMethod of payment used
check_numberCheck number assigned to the payment
List of payees associated with the transaction
modified_byName of the person who modified the transaction
claim_level_transactionWhether this is a claim-level transaction (affects multiple exposures)
Details about the claim exposure associated with this transaction
copilot_skill-def
idUnique identifier for the skill
nameDisplay name of the skill
bodyMarkdown instruction body consumed by agents
statusLifecycle status of the skill
applicable_copilotsCopilot identifiers this skill applies to. Empty means all copilots.
date_addedISO 8601 creation timestamp
date_updatedISO 8601 last-update timestamp
descriptionShort summary of the skill
added_byUser ID of the creator
updated_byUser ID of the last modifier
updated_by_usernameResolved username of the last modifier
create_full_quote_async_request-def
effective_dateQuote Effective Date
term_typeTerm Type
Optional async-creation toggles.
external_system_referenceExternal ID of the Quote
policy_type_idPolicy Type ID
policy_type_external_system_referenceExternal ID of the Policy Type
agent_idThe UUID of the Agent
agent_external_system_referenceExternal ID of the Agent
agency_idThe UUID of the Agency
agency_external_system_referenceExternal ID of the Agency
transaction_typeList of Risks, required if require_risk_address line configuration is true
Optional list of auto vehicles to create and associate with the quote
Optional list of drivers to create and associate with the quote
policy_term_external_referenceExternal Reference of the Policy Term
numberPolicy Number
number_originOrigin of the Policy Number
copy_template_risksWhether to copy risks from template if available. Defaults to false.
renewal_statusRenewal status for the policy. If not provided, uses the default from policy lifecycle settings.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: effective_date, term_type, underwriting_questions | |
| type = object · requires: effective_date, term_type, underwriting_questions |
effective_dateQuote Effective Date
term_typeTerm Type
Optional async-creation toggles.
external_system_referenceExternal ID of the Quote
policy_type_idPolicy Type ID
policy_type_external_system_referenceExternal ID of the Policy Type
agent_idThe UUID of the Agent
agent_external_system_referenceExternal ID of the Agent
agency_idThe UUID of the Agency
agency_external_system_referenceExternal ID of the Agency
transaction_typeList of Risks, required if require_risk_address line configuration is true
Optional list of auto vehicles to create and associate with the quote
Optional list of drivers to create and associate with the quote
policy_term_external_referenceExternal Reference of the Policy Term
numberPolicy Number
number_originOrigin of the Policy Number
copy_template_risksWhether to copy risks from template if available. Defaults to false.
renewal_statusRenewal status for the policy. If not provided, uses the default from policy lifecycle settings.
create_full_quote_request-def
effective_dateQuote Effective Date
term_typeTerm Type
external_system_referenceExternal ID of the Quote
policy_type_idPolicy Type ID
policy_type_external_system_referenceExternal ID of the Policy Type
agent_idThe UUID of the Agent
agent_external_system_referenceExternal ID of the Agent
agency_idThe UUID of the Agency
agency_external_system_referenceExternal ID of the Agency
transaction_typeList of Risks, required if require_risk_address line configuration is true
Optional list of auto vehicles to create and associate with the quote
Optional list of drivers to create and associate with the quote
policy_term_external_referenceExternal Reference of the Policy Term
numberPolicy Number
number_originOrigin of the Policy Number
copy_template_risksWhether to copy risks from template if available. Defaults to false.
renewal_statusRenewal status for the policy. If not provided, uses the default from policy lifecycle settings.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: effective_date, term_type, underwriting_questions | |
| type = object · requires: effective_date, term_type, underwriting_questions |
effective_dateQuote Effective Date
term_typeTerm Type
external_system_referenceExternal ID of the Quote
policy_type_idPolicy Type ID
policy_type_external_system_referenceExternal ID of the Policy Type
agent_idThe UUID of the Agent
agent_external_system_referenceExternal ID of the Agent
agency_idThe UUID of the Agency
agency_external_system_referenceExternal ID of the Agency
transaction_typeList of Risks, required if require_risk_address line configuration is true
Optional list of auto vehicles to create and associate with the quote
Optional list of drivers to create and associate with the quote
policy_term_external_referenceExternal Reference of the Policy Term
numberPolicy Number
number_originOrigin of the Policy Number
copy_template_risksWhether to copy risks from template if available. Defaults to false.
renewal_statusRenewal status for the policy. If not provided, uses the default from policy lifecycle settings.
disbursement_attempt-def
idDisbursement attempt ID.
transaction_typeThe source obligation type.
transaction_idThe source obligation id (for a Commission Payment, == commission_payments.id).
railDisbursement rail.
stateLifecycle state (disbursementState).
amountDisbursement amount (USD, 2 decimal places).
direct_payee_contact_idContact the disbursement is paid to.
date_addedCreation timestamp.
date_updatedLast update timestamp.
initiated_by_contact_idOperator who initiated the attempt.
Payment method used (ACH rail), if any.
ACH_ISSUANCE integration instance the attempt dispatches through (null for manual).
The IS/vendor handle for the operation (set-once after the vendor accepts).
Check number (check / manual rails).
Populated when state == 'failed'.
Failure code (populated when failed).
ACH return code (populated when failed via a recipient return).
Derived (never stored): the short operator-facing phrase for ach_return_code, e.g. 'no account' for R03. Null when there is no return code OR when the code is not one BriteCore has a phrase for -- an unrecognised code is not an error, and clients render ach_return_code on its own in that case. Source of truth is DISBURSEMENT_ACH_RETURN_CODE_LABELS in lib/domain/constants.py (BC-24977).
Human-readable failure detail.
When the attempt entered in_transit.
When the attempt settled.
When the attempt failed.
retry_countNumber of retry rounds for this attempt.
Redacted point-in-time audit snapshot of the source rows the attempt was built from, discriminated by rail. Present on the full/action responses (get_detail, cancel, admin_terminate, record_manual, and the issue IssuanceResult); the lean list / obligation_history / needs_attention responses OMIT it (this property is optional here for that reason). SECURITY: the ACH vendor-vault tokens customer_profile_id and vendor_payment_method_id are intentionally REDACTED and never appear in any API response or the request/result log (see the DisbursementAttemptModel post_dump scrub); the engine reads them only from the in-memory row when building the ACH_ISSUANCE dispatch payload.
Folded single-row source enrichment returned by get_detail (payee_name, obligation_has_live_successor, source block).
disbursement_funding_account-def
idBriteCore anchor id.
integration_instance_idThe funding integration instance the anchor is bound to.
vendor_reference_idThe vendor's financial-account handle.
deleted_atSet when the anchor is archived; null while active.
date_addedWhen the anchor was created.
date_updatedWhen the anchor was last written.
disbursement_funding_request-def
idThe request id. Caller-supplied for a manual top-up, and ALSO the vendor Idempotency-Key, which is what makes a double submit dedupe to one row and one pull.
financial_account_idThe BriteCore financial-account anchor the money was pulled into.
funding_source_idThe BriteCore funding-source row the money was pulled from.
amountAmount in DOLLARS, serialized. Whole cents only; a zero-amount request is never persisted. Emitted as a JSON NUMBER: the schema dumps a Decimal and simplejson renders it natively (and parses it back to Decimal). The string form is accepted for clients that stringify money.
triggerWhat caused the pull. 'manual' is an operator using Add money; 'min_balance' is the auto top-up rule, which is not part of the MVP UI.
outcomeWhat became of the request, and the only field the console's status column reads. 'succeeded' renders as Submitted: the bank accepted the pull, arrival not yet known. 'settled' renders as Funded: the settlement sweep saw the money arrive. 'returned' renders as Returned: the bank sent the money back, before or after settlement; error_code / error carry the return code and reason. 'vendor_rejected' renders as Declined and means the pull definitively did NOT happen. 'transport_failed' renders as Needs review: the response was lost, the outcome is UNKNOWN, and MONEY MAY HAVE MOVED -- it must never be shown as a clean failure. 'succeeded' becomes 'settled' or 'returned' when the sweep sees the transfer's fate; 'settled' can still become 'returned' inside the return window; 'transport_failed' changes when a retry resolves it. 'returned' and 'vendor_rejected' are terminal.
error_codeMachine-readable code behind a non-success outcome: the vendor error on a rejection, the bank return code (e.g. R01) on a return; null otherwise.
errorHuman-readable context behind a non-success outcome: the vendor error on a rejection, the return reason on a return; null otherwise.
noteFree-text operator note carried on the row.
vendor_reference_idThe vendor's handle for the resulting transfer, set on success so the row can be correlated against the live feed. Null until then.
initiated_by_contact_idWho initiated a manual top-up. Always set for trigger 'manual' and always null for an auto trigger, where there is no human in the loop. Pinned server-side to the authenticated session, never taken from the request.
date_addedWhen the row was appended -- the 'When' column, and the sort key of the log (newest first).
date_updatedWhen the row was last written. A 'succeeded' row is written again when the settlement sweep flips it to 'settled' or 'returned', so on a 'settled' row this is when BriteCore saw the money arrive; a 'transport_failed' row changes when a retry or reconciliation resolves it.
disbursement_funding_source-def
idBriteCore funding-source row id.
integration_instance_idThe funding integration instance the row is bound to.
vendor_reference_idThe vendor's funding-source handle.
priorityWaterfall position; 1 is tried first.
deleted_atSet when the row is archived; null while active.
date_addedWhen the row was created.
date_updatedWhen the row was last written.
disbursement_funding_vendor_account-def
vendor_reference_idThe vendor's financial-account handle.
vendor_displayVendor-provided label for the account.
vendor_statusVendor-provided status string.
vendor_featuresFree-form feature labels composed by the integration system.
vendor_requirementsFree-form outstanding-requirement labels; empty when nothing is outstanding.
ready_stateNeutral readiness badge computed by the integration system.
dispute-def
claim_idID of the owning claim
nameFree-text name of the dispute
typeDispute classification
idID of the dispute
handling_claims_adjuster_idID of the handling claims adjuster contact
handling_claims_adjuster_nameDisplay name of the handling claims adjuster
handling_external_legal_staffContact IDs assigned as external legal staff for this dispute
is_codefendantis_structured_settlementis_appraisal_requestedis_bad_faithis_economic_damageis_excess_policylawsuit_namelawsuit_statelawsuit_typeLAWSUIT_TYPE quick code value
docket_numbercase_numberdefendant_firm_iddefendant_attorney_idcourt_typeCLAIMS_COURT_TYPE quick code value (e.g. FEDERAL_COURT, STATE_COURT, MEDIATION, OTHER). The set of allowed values is configurable through the Lookups UI.
judge_idplaintiff_firm_idplaintiff_attorney_idremarksdispute_date-def
claim_idID of the owning claim
dateDate value (YYYY-MM-DD)
typeCLAIM_DATE_TYPE quick code value (e.g. assigned, suitOpened)
idID of the claim_date row
dispute_idID of the parent dispute
date_updatedLast update timestamp (YYYY-MM-DDTHH:MM:SS)
dispute_settlement-def
typeSETTLEMENT_TYPE quick code value
amountSettlement amount (decimal)
dateSettlement date (YYYY-MM-DD)
idID of the dispute settlement
dispute_idID of the parent dispute
driver-def
idquote_idcontact_idUUID or $named_insured[N] placeholder
full_namedate_of_birthmarital_statuslicense_numberlicense_stateissuing_countrydate_licenseddriver_license_statusforeign_licensesocial_security_numbereducation_leveldriver_trainingdriver_training_completion_dategood_studentstudent_over_100_milescurrent_occupationcurrent_employeryears_with_current_employergovt_employeeaddress_ownedrelation_to_applicantnon_inclusion_reasonincluded_in_policyis_primary_named_insureddriver_template-def
full_nameDriver's full name (required)
typeContact type
date_of_birthDriver's date of birth in YYYY-MM-DD format
genderDriver's gender
license_state^[A-Z]{2}$State where driver's license was issued (2-letter code)
license_numberDriver's license number
marital_statusDriver's marital status
relation_to_applicantRelationship to policy applicant
included_in_policyWhether driver is included in policy
dynamic_field-def
field_typefield_labelfield_keyidPresent when updating an existing field; absent/omitted when adding a new one.
default_valueoption_sourceRequired when field_type is 'dropdown'.
optionsRequired (non-empty) when option_source is 'static'.
source_keyRequired when option_source is 'dynamic'. Context array to resolve options from, e.g. 'vehicles', 'parties' (dotted paths supported).
display_fieldFor a dynamic dropdown: the field on each resolved item to use as the option label (defaults to 'name').
email-def
emailtypeis_preferrederp_item-def
idUnique identifier for the ERP item record
revision_idThe revision ID this ERP item belongs to
item_idThe line item ID (revision_item or property_item)
item_nameName of the line item
categoryCategory of the item: 'policy' for revision items, 'property' for property items
erp_durationERP duration in days
erp_start_dateERP start date (YYYY-MM-DD)
erp_end_dateERP end date (YYYY-MM-DD)
property_idProperty ID for property-level items (null for policy-level items)
property_nameProperty name for property-level items (null for policy-level items)
file-def
idFile / attachment UUID
titleDisplay title / file name
descriptionAttachment description
code_value_typeTag code (FK to quick_code_values.codeValueType)
quick_codeParent tag category (FK to quick_code_values.quickCode). Defaults to CLAIMS_FILE_TAG when tag is supplied without code_value_type.
tagRequest-only alias for code_value_type. On edit_attachment, copied onto code_value_type when code_value_type is omitted.
mime_typeMIME type
sizeFile size in bytes
reference_idOwning entity UUID (claim, policy, or contact)
typeOwning entity type, e.g. claims, policies, contacts
activeprivateread_onlyisdirTrue when this row is a folder, not a file
folder_privateTrue when the parent folder is private
labeldate_addedfull_quote-def
idQuote ID
external_system_referenceExternal ID of the Quote
policy_type_idPolicy Type ID
policy_type_external_system_referenceExternal ID of the Policy Type
effective_dateQuote Effective Date
agent_idThe UUID of the Agent
agent_external_system_referenceExternal ID of the Agent
agency_idThe UUID of the Agency
agency_external_system_referenceExternal ID of the Agency
policy_idPolicy ID
policy_numberPolicy Number
transaction_typeTransaction Type
statusQuote Status
written_feeWritten Fee
written_premiumWritten Premium
annual_premiumAnnual Premium
written_premium_pro_rataWritten Premium Pro Rata
annual_premium_pro_rataAnnual Premium Pro Rata
annual_feeAnnual Fee
primary_property_idID of the revision's primary property. Null when the revision has no primary property. One of the identifiers callers can chain on after quote operations.
cancellation_dateDate on which the policy was cancelled
renewal_statusRenewal status for the policy
full_quote_async_status-def
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: status, reference_id, result +3 more | |
| type = object · requires: status, reference_id, result +3 more | |
| type = object · requires: status, reference_id, result +3 more | |
| type = object · requires: status, reference_id, result +3 more |
statusreference_idIdentifier used to poll for the status of the async quote creation job.
resultCreated or recovered quote envelope, or null when result_available is false. 'response' is the summary shape (id, policy_id, policy_number, created_date, updated_date) emitted identically by the worker success path and the duplicate-recovery path. The full quote's policy_status/status/state/items/sub_lines/risks and request-echo fields are intentionally omitted — fetch the full quote separately if needed.
result_availableFalse when the stored results BLOB was corrupt or truncated and could not be unpickled, in which case result is null. The recovery path is to re-submit with the same external_system_reference, which is idempotent.
policy_idUUID of the policy, copied from result.response.policy_id (a required UUID on CreateFullQuoteResponseSummaryModel). Populated on a normal success; null when result_available is false.
policy_urlURL to the created policy information page. Null when web.ctx.homedomain is unset or when result_available is false; a full URL otherwise.
html_deliverable-def
idUnique identifier
report_typeReport type name (e.g. Custom Deliverable, Declaration)
moduleModule this deliverable belongs to
location_idBusiness location ID
policy_type_namePolicy type name (null for global deliverables)
custom_nameDisplay name of the deliverable
include_mortgageeinclude_insuredinclude_addt_intinclude_agentinclude_primary_insuredeligible_for_insured_edeliverydec_footerdec_signaturedec_signature_imagedec_blurbshow_fixed_dec_sigprint_on_initial_decprint_on_renewal_decprint_on_non_autopaycertified_mailbuilt_in_htmlwkhtmltopdf_optionsPer-document wkhtmltopdf options
requires_user_inputuse_dynamic_fieldssend_decoverwrite_stockesign_enabledallow_britequote_creationbritedocs_idproduct_namehtml_templateLinked HTML template (matched by name)
Business location mappings for the HTML template
Dynamic fields for user input on this deliverable
insight-def
idServer-assigned insight UUID
reference_typeType of resource the insight is attached to
reference_idUUID of the owning claim or policy
insight_typeInsight category (immutable after create)
insight_severityUrgency level (immutable after create)
titleShort headline
descriptionAdjuster-readable narrative
product_areaProduct-area placement; null means reference-wide. Valid values depend on reference_type. CLAIM: INFORMATION, PARTIES, VEHICLES, DAMAGED_PROPERTIES, INJURIES, ESTIMATIONS, ACCOUNTING, DISPUTES, NOTES, ATTACHMENTS. POLICY: INFORMATION, UNDERWRITING, SUBJECTIVITIES, CONTACTS, PROPERTY, VEHICLES, DRIVERS, COVERAGES, RATING, NOTES, ATTACHMENTS, RENEWAL.
first_seen_atlast_evaluated_atdate_addeddate_updatedreshowAcknowledge re-show policy (settable on create; defaults to UNTIL_RESOLVED)
snooze_daysPer-insight snooze-window override in days; null falls back to the severity default (settable on create)
last_acknowledged_atlast_acknowledged_bysnoozed_untildismissedselectorOptional card-level deep-link within product_area. Requires a non-null product_area. CLAIM selectors are per product area (e.g. INFORMATION: CLAIM_INFORMATION, POLICY_INFORMATION, ADDITIONAL_INFORMATION, CLAIM_ASSIGNMENTS, CLAIMS_HISTORY, LOSS_ADDRESS, CATASTROPHE, REINSURANCE_CONTRACTS, DATES, REPORTS, PHOTOS; ACCOUNTING: ACCOUNTING_OVERVIEW, RECOVERIES, EXPOSURE_INFORMATION; PARTIES: PARTIES_LIST; VEHICLES: VEHICLES_LIST; DAMAGED_PROPERTIES: DAMAGED_PROPERTIES_LIST; INJURIES: INJURIES_LIST; ESTIMATIONS: ESTIMATIONS_LIST; DISPUTES: DISPUTES_LIST, LITIGATION_DETAILS; NOTES: NOTES_LIST; ATTACHMENTS: ATTACHMENTS_LIST). POLICY selectors are per product area (INFORMATION: EFFECTIVE_DATES, POLICY_STATUS, REVISION, PREMIUM_TOTALS; UNDERWRITING: STP_STATUS, UW_RULES, UW_QUESTIONS, UW_CONTACT; SUBJECTIVITIES: SUBJECTIVITIES_LIST, ESIGNATURE; CONTACTS: NAMED_INSURED, ADDITIONAL_INTERESTS, AGENT, PREMIUM_FINANCE, SURPLUS_LINE_PRODUCER, CONTACTS_SECTION; PROPERTY: PROPERTIES_LIST; VEHICLES: VEHICLES_LIST; DRIVERS: DRIVERS_LIST; COVERAGES: PRIMARY_EXPOSURES, POLICY_WIDE; RATING: PREMIUM_TOTALS, COMMISSION_RATE, CREDIT_SCORE; NOTES: NOTES_LIST; ATTACHMENTS: ATTACHMENTS_LIST; RENEWAL: RENEWAL_STATUS, POLICY_STATUS).
item-def
item_idPolicy Type Item ID
item_external_system_referenceExternal ID of the Policy Type Item
manual_premiumWhether the premium is set manually
limitLimit of the Policy Type Item
item_premiumAnnual Premium of the Item, if manual_premium is true
item_feeAnnual fee for the item
pro_rated_premiumPro-rated premium for the item. This is calculated based on the original premium and the duration the change/endorsement is effective for.
pro_rated_feePro-rated fee for the item
deductibleDeductible of the Policy Type Item
erp_durationExtended Reporting Period (ERP) duration in days
erp_limit_reinstatementWhether ERP limits are reinstated for this coverage item
Builder Object for the Item
item_update-def
item_idPolicy Type Item ID
manual_premiumWhether the premium is set manually
limitLimit of the Policy Type Item
item_premiumAnnual Premium of the Item, if manual_premium is true
item_feeAnnual fee for the item
pro_rated_premiumPro-rated premium for the item
pro_rated_feePro-rated fee for the item
deductibleDeductible of the Policy Type Item
erp_durationExtended Reporting Period (ERP) duration in days
erp_limit_reinstatementWhether ERP limits are reinstated for this coverage item
Builder Object for the Item
ivans_dbcs_agency-def
contact_idcontacts.id of the agency.
namecontacts.name. Null when the column is null.
agency_numbercontacts.agencyNumber, in its stored casing. The column collates case-insensitively, so two agencies whose numbers differ only in case are the same number as far as a generated DBCS file is concerned.
selectedTrue when this agency is in the stored selection.
agency_number_conflictTrue when another eligible agency anywhere in the roster -- not only on this page -- carries the same agency number, compared case-insensitively. A display warning: selecting one of a conflicting pair is allowed, selecting both is refused on save because a generated DBCS file could not tell them apart.
ivans_dbcs_resolved_agency-def
contact_idcontacts.id of the agency.
namecontacts.name. Null when the column is null.
agency_numbercontacts.agencyNumber, in its stored casing. The column collates case-insensitively, so two agencies whose numbers differ only in case are the same number as far as a generated DBCS file is concerned.
eligibleTrue when the contact may be selected for IVANS DBCS. Equivalent to failed_reasons being empty.
failed_reasonsEvery eligibility axis this contact fails, not just the first. Empty when eligible is true. A contact id with no contacts row at all never becomes a row here -- it is reported in unknown_contact_ids instead, which is why there is no not-found token in this list.
messages-def
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = array | |
| type = object |
Any messages or errors related to the request
minimum_earned_premium_calendar_entry-def
idpolicy_life_cycle_idinitial_datefinal_datepercentagePercentage (decimal as string)
mortgagee-def
idUnique identifier for the mortgagee
confirmation_email^[a-zA-Z0-9_.+-]+@[a…date_of_birthdrivers_licenseexternal_system_referenceExternal ID of the Named Insured
last_synched_datesource_update_datefein_tax_idlegal_entity_typedate_business_starteddbanameNamed Insured Name
added_bypurchase_datepositionwebsitessn_groupssnagency_inception_dateagency_termination_datetypeusernamegenderdriver_license_datelicense_state^[A-Z]{2}$date_of_deathhicn_numbercompany_idis_primaryIndicates if this is the primary named insured
contact_idID of the contact to be added as named insured
descriptionDescription of the mortgagee
loan_numberLoan number associated with this mortgagee
mortgagee_typeType of mortgagee (e.g., primary, secondary)
mortgagee_statementStatement to be included on declarations for this mortgagee
named_insured-def
confirmation_email^[a-zA-Z0-9_.+-]+@[a…date_of_birthdrivers_licenseexternal_system_referenceExternal ID of the Named Insured
last_synched_datesource_update_datefein_tax_idlegal_entity_typedate_business_starteddbanameNamed Insured Name
added_bypurchase_datepositionwebsitessn_groupssnagency_inception_dateagency_termination_datetypeusernamegenderdriver_license_datelicense_state^[A-Z]{2}$date_of_deathhicn_numberphone_numberOptional scalar phone. When BriteQuote required contact fields include phone number, integrators may send this field or a non-empty phones entry (number and type) on create_quote_extended; either satisfies the requirement.
company_idis_primaryIndicates if this is the primary named insured
contact_idID of the contact to be added as named insured
nonrenewal_reason-def
idpolicy_life_cycle_idreasondescriptionis_modifiablepayment-def
idPayment ID.
nsfWhether the payment is marked as NSF.
account_nameName on the payment account.
authorization_stateCurrent authorization state of the payment.
commission_paymentWhether this is a commission payment.
committerEntity that committed the payment.
completeWhether the payment is complete.
confirmation_numberPayment confirmation number.
date_updatedLast update timestamp.
deletedWhether the payment is deleted.
entry_date_timePayment entry timestamp.
file_idsList of associated file IDs.
invoices_paidList of invoice IDs that were paid by this payment.
is_auto_paymentWhether this is an automatic payment.
masked_numberMasked payment method number.
payment_instrumentType of payment instrument used.
payment_interfacePayment interface used.
printed_to_depositWhether payment was printed to deposit.
remote_ipRemote IP address of payment origin.
selected_on_depositWhether payment was selected on deposit.
sweepWhether this is a sweep payment.
transaction_amountPayment transaction amount.
transaction_date_timeTransaction timestamp.
transaction_typeType of transaction.
vendor_messageMessage from payment vendor.
vendor_stage_successWhether vendor stage was successful.
Check number if applicable.
Commission payment ID.
Payment distribution information as a JSON object or null.
Invoice number if applicable.
Payment method ID.
payor_idPayor contact ID.
payor_nameName of the payor from payment gateway billing details (e.g., Stripe).
payor_emailEmail address of the payor from payment gateway billing details (e.g., Stripe).
Current vendor processing stage.
payment_instrument_installment-def
idbilling_schedule_installment_idpayment_instrumentfactor_total_premPremium factor (decimal as string)
phone-def
phonetypeis_preferredpolicy_life_cycle-def
idUnique identifier for the policy life cycle
location_idBusiness location ID this life cycle belongs to
policy_type_namePolicy type name this life cycle is associated with (null for global/shared lifecycle)
endorsement_invoice_feeFee charged for endorsement invoices
nsf_feeNon-sufficient funds fee
non_pay_feeNon-payment fee
continuation_feeContinuation fee
non_pay_cancel_feeNon-payment cancellation fee
bill_less_than_amountMinimum billing threshold amount
bill_less_than_checkedWhether the bill-less-than threshold is enabled
billing_endorsementsEndorsement billing mode (e.g. 'endorse_invoice')
auto_change_billing_schedulesAuto-change billing schedule configuration (JSON)
always_bill_auto_payWhether to always bill for auto-pay policies
waive_installment_fees_for_pre_paid_invoicesWhether to waive installment fees for pre-paid invoices
send_negative_endorsement_invoiceWhether to send invoices for negative endorsements
disallow_nsf_duplicate_non_payWhether to disallow duplicate NSF non-pay fees
length_of_cancellation_pending_noticeDays of cancellation pending notice
length_of_cancellation_pending_new_businessDays of cancellation pending notice for new business (JSON, may be null)
length_of_cancellation_pending_renewalDays of cancellation pending notice for renewals
length_of_non_pay_cancellationDays before non-pay cancellation
length_of_cancellation_category_overridesCategory-specific cancellation period overrides (JSON)
cancel_on_due_dateWhether to cancel on the due date
print_during_cancelWhether to print during cancellation
print_confirmation_of_cancellationWhether to print cancellation confirmation
suppress_confirmation_of_cancellationWhether to suppress cancellation confirmation
print_cancellation_invoicesWhether to print cancellation invoices
enforce_underwriting_cancellationWhether to enforce underwriting cancellation rules
non_renew_notify_januaryNon-renewal notification days for January
non_renew_notify_februaryNon-renewal notification days for February
non_renew_notify_marchNon-renewal notification days for March
non_renew_notify_aprilNon-renewal notification days for April
non_renew_notify_mayNon-renewal notification days for May
non_renew_notify_juneNon-renewal notification days for June
non_renew_notify_julyNon-renewal notification days for July
non_renew_notify_augustNon-renewal notification days for August
non_renew_notify_septemberNon-renewal notification days for September
non_renew_notify_octoberNon-renewal notification days for October
non_renew_notify_novemberNon-renewal notification days for November
non_renew_notify_decemberNon-renewal notification days for December
default_renewal_statusDefault renewal status (e.g. 'Renew')
renewal_reminder_overrideWhether to override renewal reminders
reinstatement_feeReinstatement fee amount
reinstatement_expired_feeReinstatement fee for expired policies
reinstatement_promptCustom reinstatement prompt text
reinstate_expiredWhether to allow reinstatement of expired policies
send_notice_on_reinstatementWhether to send notice on reinstatement
send_declaration_on_reinstatementWhether to send declaration on reinstatement
enforce_min_max_payment_publicEnforce min/max payment for public portal
enforce_min_max_payment_underwriterEnforce min/max payment for underwriters
enforce_min_max_payment_agentEnforce min/max payment for agents
enforce_min_max_agent_sweep_paymentEnforce min/max for agent sweep payments
minimum_thresholdMinimum payment threshold amount
minimum_threshold_premium_factorPremium factor for minimum threshold calculation
allow_recurring_paymentsRecurring payment mode (e.g. 'all')
allow_bypass_thresholdWhether to allow bypassing the payment threshold
disallow_payments_scopeScope for disallowed payments (e.g. 'external')
disallow_external_payments_non_payDisallow external payments for non-pay
disallow_external_payments_non_pay_poor_payorDisallow external payments for poor payor non-pay
disallow_external_payments_underwritingDisallow external payments for underwriting cancellation
disallow_schedule_changes_mid_termDisallow billing schedule changes mid-term
min_return_premiumMinimum return premium amount
minimum_earned_premiumMinimum earned premium amount
minimum_earned_premium_start_dateStart date for minimum earned premium
always_print_initialAlways print initial policy documents
always_print_renewalAlways print renewal documents
silence_non_paySilence non-pay notifications
silence_non_pay_renewalSilence non-pay notifications for renewals
print_for_bill_whom_onlyOnly print for bill-to party
allow_mortgagee_extensionAllow mortgagee extension
allow_mortgagee_extension_daysNumber of days for mortgagee extension
continuation_notificationEnable continuation notifications
zero_dollar_nonpay_and_continuation_renewal_invoicesAllow zero-dollar non-pay and continuation renewal invoices
rewrite_transfer_rpTransfer return premium on policy rewrite
rewrite_sync_bill_dates_on_commitSync billing dates on commit for rewrites
carry_over_cp_to_future_termsCarry over credit premium to future terms
report_due_date_minus_xReport due date offset in days
always_process_as_non_renewalAlways process as non-renewal (deprecated)
Billing schedules for this life cycle
Cancellation reasons for this life cycle
Non-renewal reasons for this life cycle
Reinstatement reasons for this life cycle
Minimum earned premium calendar entries for this life cycle
policy_type_def-def
nameName of the Policy Type
idID to be set for the Policy Type (optional)
external_system_referenceExternal System Reference for the Policy Type
descriptionDescription of the Policy Type
renewal_effective_dateThe renewal effective date for this policy type
underwriting_textUnderwriting text for the Policy Type
application_form_numberApplication Form Number
sort_orderSort order of the Policy Type
allow_multiple_risksWhether multiple risks are allowed
require_credit_scoreWhether credit score is required
credit_score_permission_promptPrompt for credit score permission
term_credit_score_combination_strategyStrategy for combining term credit scores
term_credit_score_fallbackFallback value for term credit score
terms_credit_score_validNumber of policy terms the rated credit score stays locked (0 = always rate on the most recent score)
terms_credit_score_pull_intervalNumber of policy terms that must elapse before ordering a new credit report on the renewal schedule (0 = no scheduled ordering; the global contacts/auto-fetch-credit-score setting can still order a report when an insured is edited)
always_display_wizard_credit_score_buttonWhether to always display the credit score button in the wizard
open_to_quotingWhether the Policy Type is open to quoting
quote_termsAvailable quote terms
Terms and their factors
dec_sectionsDeclaration sections
separate_dec_sectionsWhether to separate declaration sections
system_tagsSystem tags
protection_classProtection class type
limit_thresholdLimit threshold
limit_breach_warningWarning message for limit breach
requires_approvalWhether approval is required
use_rating_v1Whether to use rating v1
trust_risk_premiumsWhether to trust risk premiums
rating_info_titleTitle for rating information
show_optional_builder_items_inlineWhether to show optional builder items inline
skip_insured_quoting_stepWhether to skip the insured quoting step
sequence_idSequence ID
claim_sequence_idClaim sequence ID
allow_risk_valuationWhether to allow risk valuation
maximum_risk_countMaximum number of risks allowed
require_risk_addressWhether risk address is required
require_insured_nameWhether insured name is required
allow_motor_vehicle_reportsWhether to allow motor vehicle reports
britelines_product_nameBriteLines product name
acres_visibilityVisibility setting for acres
legal_description_visibilityVisibility setting for legal description
commission_calculation_item_idCommission calculation item ID
typeType of the policy
months_mvr_validNumber of months MVR is valid
mid_term_quotingWhether mid-term quoting is allowed
billing_schedule_in_ratingWhether billing schedule is included in rating
edelivery_enabledWhether e-delivery is enabled
allow_zero_risksWhether zero risks are allowed
last_synched_dateDate of last synchronization
policy_type_item-def
nameName of the Line Item
categoryCategory of the Line Item (Policy or Risk)
typeType of the Line Item
requirement_typeRequirement type of the Line Item
idID to be set for the Line Item (optional)
external_system_referenceExternal System Reference for the Line Item
descriptionDescription of the Line Item
system_tagsSystem-specific tags associated with the Line Item
has_limitIndicates if the Line Item has a limit
has_rate_or_deductibleIndicates if the Line Item has a rate or deductible
has_loss_payeeIndicates if the Line Item has a loss payee
allow_multiplesIndicates if multiple instances of this Line Item are allowed
premium_fully_billedIndicates if the premium is fully billed
premium_fully_earned_at_inceptionIndicates if the premium is fully earned at inception
premium_added_to_other_itemIndicates if the premium is added to another item
disallow_submit_boundIndicates if submitting bound is disallowed
display_on_dec_asHow the item should be displayed on declaration
dec_font_sizeFont size for declaration
dec_font_boldIndicates if the font should be bold in declaration
dec_font_italicIndicates if the font should be italic in declaration
dec_aliasesAliases for declarations display
do_not_display_in_dec_rating_informationIndicates if the item should not be displayed in declaration rating information
do_not_display_in_dec_when_zero_premiumIndicates if the item should not be displayed in declaration when premium is zero
display_in_dec_as_incl_when_zero_premiumIndicates if the item should be displayed as included in declaration when premium is zero
show_limit_and_premium_on_decIndicates if limit and premium should be shown on declaration
dividend_factorDividend factor for the Line Item
show_in_builderSpecifies where the item should be shown in the builder
hide_in_britequoteIndicates if the item should be hidden in BriteQuote
limit_availabilitySpecifies the limit availability for the Line Item
loss_exposureIndicates if the item represents a loss exposure
loss_free_creditDetails about loss-free credit
no_commission_paid_on_line_itemIndicates if no commission is paid on this Line Item
override_limitIndicates if the limit can be overridden
not_applicable_for_agency_billingIndicates if the item is not applicable for agency billing
prevent_from_being_deletedIndicates if the item should be prevented from being deleted
display_user_inputs_above_rate_categoriesIndicates if user inputs should be displayed above rate categories
renewal_amountRenewal amount for the Line Item
default_loss_reserveDefault loss reserve amount
default_adjusting_reserveDefault adjusting reserve amount
default_legal_reserveDefault legal reserve amount
modifies_other_items_on_renewalIndicates if this item modifies other items on renewal
not_rated_by_prorata_and_factorIndicates if the item is not rated by pro-rata and factor
Rate chain for the Line Item
renewal_split_bySpecifies how renewal is split
Zip code factors for renewal
renewal_factor_item_idsLine item IDs whose limit this item inflates at renewal (inflation guard targets)
round_methodRounding method for calculations
round_toSpecifies to what decimal place to round
round_pro_rataIndicates if pro-rata should be rounded
scheduled_itemDetails about scheduled item
skip_persistent_builder_when_added_mandatorilyIndicates if persistent builder should be skipped when added mandatorily
skip_persistent_builder_when_new_category_addedIndicates if persistent builder should be skipped when new category is added
disallow_submit_bound_if_limit_exceedsIndicates if submitting bound should be disallowed if limit exceeds
submit_bound_upper_limitUpper limit for submitting bound
pro_rate_feeIndicates if fee should be pro-rated
sort_orderSort order for the Line Item
claim_coverage_party_typeSpecifies the claim coverage party type
calculate_item_commission_rateIndicates if item commission rate should be calculated
commission_rate_evalCommission rate evaluation
erp_enabledIndicates if Extended Reporting Period (ERP) is enabled for this Line Item
default_erp_duration_daysDefault duration in days for the Extended Reporting Period (ERP)
erp_line_item_idReference to the Line Item used for ERP calculations
property_template-def
address_cityProperty city
address_countyProperty county
address_line1Property address line 1
address_line2Property address line 2
address_stateProperty state
address_zipProperty ZIP code
year_builtYear the property was built
storiesNumber of stories
square_footageSquare footage of the property
quote_wizard_plugin-def
embed_urlURL to embed in an iframe to display the quote wizard plugin
rate_chain-def
typedescriptionA description of the rate chain object
var_nameThe variable name of the rate chain object
omit_from_totalWhether or not to omit this rate chain object from the total
Decision Table
| Variant | Matching Criteria |
|---|---|
| requires: categories | |
| type = object · requires: categories, rates | |
| type = object | |
| type = object | |
| type = object | |
| type = object | |
| type = object · requires: minimum_premium_type, categories, rates | |
| type = object · requires: maximum_premium_type, categories, rates | |
| type = object · requires: eval_code, assignment, final | |
| type = object | |
| type = object |
An array of category objects
typereinstatement_reason-def
idpolicy_life_cycle_idreasonrequest-activate_copilot_skill
idUUID of the copilot skill to activate
request-add_brand
nameBrand name
logo_file_idFile ID for the brand logo
signature_file_idFile ID for the brand signature
header_line_1Header line 1
header_line_2Header line 2
header_line_3Header line 3
header_line_4Header line 4
activeWhether the brand is active
request-add_contact_to_role
role_nameThe name of the role to add the contact to
contact_idThe unique identifier of the contact
request-add_recovery
api_keyAPI key for authentication
The recovery object ClaimExposureRecoveryModel
request-add_recovery_reserve
api_keyAPI key for authentication
The recovery reserve object ClaimExposureRecoveryReserveModel
request-add_template_to_policy_type
policy_type_idThe ID of the policy type
quick_quote_template_idThe ID of the Quick Quote Template to associate
request-agents_agent_config
agentFrontend chat-mode key identifying the target agent (mapped server-side to the internal agent name).
request-agents_agent_create_job
agentFrontend chat-mode key identifying the target agent. Only agents that expose async jobs are valid.
job_nameType of job to execute.
promptUser instructions for the job.
Additional context parameters. For the Rules agent, policy_type_id is required (enforced server-side); for the Lines agent it is optional.
File attachments for processing.
request-agents_agent_delete_session
agentFrontend chat-mode key identifying the target agent (mapped server-side to the internal agent name).
session_idSession identifier to delete.
request-agents_agent_get_job
agentFrontend chat-mode key identifying the target agent. Only agents that expose async jobs are valid.
job_idUUID of the job to retrieve.
request-agents_agent_list_jobs
agentFrontend chat-mode key identifying the target agent. Only agents that expose async jobs are valid.
statusFilter by job status.
limitMaximum number of jobs to return.
request-agents_agent_resume_job
agentFrontend chat-mode key identifying the target agent. Only agents that expose async jobs are valid.
job_idUUID of the paused job to resume.
messageFree text response (for free_text input type).
selected_optionID of selected option (for form_selection input type).
Freeform data (for missing_data input type).
request-agents_agent_session_messages
agentFrontend chat-mode key identifying the target agent (mapped server-side to the internal agent name).
session_idSession identifier whose messages should be returned.
request-agents_agent_sessions
agentFrontend chat-mode key identifying the target agent (mapped server-side to the internal agent name).
limitMaximum number of sessions to return (defaults to 100).
request-agents_agent_status
agentFrontend chat-mode key identifying the target agent (mapped server-side to the internal agent name).
request-agents_report_copilot_attach_entity
session_idSession identifier of the conversation to attach to.
entity_typeOpaque external entity type owned by the calling agent (e.g. 'report' for the Report Copilot saved-report use case). Max 64 chars.
entity_idOpaque external entity id (e.g. the BriteCore report uuid). Max 128 chars.
request-agents_report_copilot_capabilities
request-agents_report_copilot_client_error
error_classWhich user-visible error site this was. Any value is accepted: one outside the recognised set below is recorded as 'other' rather than rejected, so a frontend that adds a site before the backend knows about it still counts. Recognised values: agent_frame, stream_connection, request_failed, file_too_large, file_read_failed, migration_response_invalid, other.
failure_classOnly read for 'agent_frame', where the browser echoes back the class the proxy put on the error frame. Same key and closed set as the proxy turn metric's failure_class, so the two series join. Anything else is bounded to 'other', an unparseable value to 'invalid'.
upstream_failure_classOnly read for 'agent_frame', where the browser echoes back the class the agent assigned. Present only when the failure originated upstream rather than in the proxy. Bounded to the agent's own closed set.
request-agents_report_copilot_delete_session
session_idSession identifier to delete.
request-agents_report_copilot_session_messages
session_idSession identifier whose messages should be returned.
request-agents_report_copilot_session_state
session_idSession identifier whose state snapshot should be returned.
request-agents_report_copilot_sessions
limitMaximum number of sessions to return (defaults to 100).
entity_typeOptional opaque entity type to filter by (e.g. 'report'). Must be supplied with entity_id.
entity_idOptional opaque entity id to filter by, paired with entity_type.
request-approve_pending_payment
integration_instance_external_idExternal ID of the integration instance.
payment_idUnique identifier for the payment to approve. Exactly one of payment_id or reference_id must be provided.
reference_idExternal reference identifier for the payment to approve. Exactly one of payment_id or reference_id must be provided.
set_reference_idOptional reference ID to set on the payment.
settlement_date_timeDate and time when the payment was settled.
vendor_processing_fee_in_centsOptional processing fee charged by the vendor in cents.
request-archive_copilot_skill
idUUID of the copilot skill to archive
request-assign_business_location
brand_idBrand identifier
location_idBusiness location identifier
request-assign_policy_contact
policy_idThe policy ID to assign the contact to
contact_idThe contact ID to assign to the policy
roleThe role of the contact in the policy
request-assign_policy_type_definition
brand_idBrand identifier
location_idBusiness location identifier
policy_type_definition_idPolicy type definition identifier
request-assign_quote_contact
quote_idThe quote ID to assign the contact to.
contact_idThe contact ID to assign to the quote
roleThe role of the contact in the quote. Additional Interest roles are configured on Settings > Policies page.
request-assign_risk_contact
risk_idThe risk ID to assign the contact to
contact_idThe contact ID to assign to the risk
roleThe role of the contact in the risk
request-attach_file
entity_idEntity ID to attach the file to. The id must be for an entity of the type specified in entity_type.
entity_typeDefines the entity type to attach the file to. If revisions is used, the File will be linked to the entity_id.
folder_nameFolder name to attach file to. The folder will be created under the policy if it does not exist.
attachmentBase64 encoded file content
titleFile name.
mime_typeFile MIME type. Example: application/pdf
set_file_privateIf true, set the file to private. Defaults to False.
set_folder_private_if_newIf true, set the folder to private if the folder does not already exist. Defaults to False.
date_addedSet when the file was added. Defaults to now. Format: YYYY-mm-ddTHH:MM:SSZ (e.g. 2020-01-01T12:00:00Z). This is UTC time.
request-attach_file_to_brand
brand_idBrand ID to attach the file to
attachmentBase64 encoded file content
file_typeType of file to attach
mime_typeMIME type of the file
request-attach_form_to_policy_type
policy_type_idPolicy Type to attach the form to.
file_nameFile name, stored as the File record's title.
file_base64Base64 encoded file content. Limited to 10MB decoded.
mime_typeFile MIME type. Defaults to application/pdf.
Print-flag metadata. Only the 7 policy-type-level fields are accepted (PolicyTypeFormMetadataSchema) - item-only fields are not declared on this schema and are dropped, not persisted.
request-attach_form_to_policy_type_item
policy_type_item_idPolicy Type Item to attach the form to.
file_nameFile name, stored as the File record's title.
file_base64Base64 encoded file content. Limited to 10MB decoded.
mime_typeFile MIME type. Defaults to application/pdf.
Print-flag metadata. All 14 fields are accepted (PolicyTypeItemFormMetadataSchema).
request-auth_session
api_keyThe caller's api key. Optional when the key is sent in the Authorization header or a minted session cookie is presented.
request-auto_assign_claim
claim_idClaim ID
request-batch_export_payments
The export selection. Exactly the string "all" (Process All Eligible, scoped by the sibling filters) OR a non-empty list of commission-payment id (UUID) strings. Any other value (a non-"all" scalar, an object, an empty list, or a non-UUID element) is rejected with success=false before any money moves.
api_keyAPI key for the caller (consumed by the gateway for authentication). Optional here; the endpoint authorizes the session operator via permissions.
is_electronic_paymentGrid filter; only applied when commission_payment_ids == "all". Ignored for an explicit id list.
commission_month^\d{4}-(0[1-9]|1[0-2…YYYY-MM report month (month 01-12); only applied when commission_payment_ids == "all". Ignored for an explicit id list.
Grid status filter; only applied when commission_payment_ids == "all". Ignored for an explicit id list.
searchGrid search filter; only applied when commission_payment_ids == "all". Ignored for an explicit id list.
request-bifurcate_claim
claim_idClaim ID
request-bind_full_quote
idThe quote ID to bind
external_system_referenceReference to the quote in an external system
submit_boundWhether to submit the quote as bound or not
request-bulk_create_disputes
claim_idID of the owning claim. Applied to every dispute item (and nested dispute_dates) before validation.
List of disputes to create. Nested claim_id may be omitted.
request-bulk_modify_tasks
task_idsIds of the tasks to act on. Duplicates are collapsed, so a task reached both by a policy header checkbox and by its own row counts once. Capped at 500: each task in a batch costs a read, its own history rows, an update and an event inside one transaction, and the queue can only select a single page.
actionreassign moves the tasks to assignee_id. archive moves the tasks to Canceled, which is what places them in the archived lifecycle bucket. set_priority sets priority. set_status sets status. mark_complete sets Completed and emits TaskCompletedEvent per task. link_to_policy attaches unattached triage tasks to policy_id - attach only, so a task that already has a parent fails individually.
assignee_idContact to reassign to. Required for reassign, rejected for every other action. An unknown id fails the whole request rather than every task individually.
priorityRequired for set_priority, rejected for every other action.
statusRequired for set_status, rejected for every other action. Terminal targets are validated per task by the FSM, which forbids modifying a task that is already terminal.
policy_idRequired for link_to_policy, rejected for every other action. An unknown id fails the whole request rather than every task individually.
request-bulk_upsert
code_system.*\S.* · requiredCode system this batch belongs to (e.g. 'ICD10')
source_version.*\S.* · requiredRelease version stamped on every row in this batch; used later by finalize_sync
Batch of codes to upsert (max 1000 rows per request)
request-cancel_claim_estimation
estimation_idEstimation ID
request-cancel_policy_v2
policy_idThe UUID of the policy to cancel
cancellation_date^\d{4}-\d{2}-\d{2}$ · requiredThe cancellation date in YYYY-MM-DD format. Must not be in the future.
policy_term_idThe UUID of the policy term to cancel
policy_term_external_system_referenceThe external system reference for the policy term
cancellation_reason_idThe UUID of the cancellation reason from the cancellation_reasons table
cancellation_reasonThe cancellation reason text
cancellation_pending_date^\d{4}-\d{2}-\d{2}$The cancellation pending date in YYYY-MM-DD format. Takes precedence over cancel_date.
print_descriptionOptional print description for the cancellation. Used in cancellation documents and notices.
additional_descriptionOptional additional description or notes for the cancellation. For internal use and documentation.
apply_mepWhether to apply minimum earned premium (MEP) when calculating cancellation refund. When true, ensures the earned premium meets the minimum earned premium requirement configured in the policy lifecycle. Defaults to false.
request-change_with_remap
claim_idID of the claim
loss_dateLoss date to persist (ISO 8601 or MM/DD/YYYY[ hh:mm A])
Per-exposure decisions. Exposures already on the target revision can be omitted.
api_keyAPI key for authentication
request-claims
api_keyAPI key for BriteCore authentication
promptThe user's message/question
Session ID for conversation continuity
Additional context information
request-claims_analytics
api_keyAPI key for BriteCore authentication
promptThe user's message/question about claims data
session_idSession ID for conversation continuity
contextContext data (JSON string with metrics, filters, claims data, etc.)
request-claims_analytics_stream
api_keyAPI key for BriteCore authentication
promptThe user's message/question about claims data
session_idSession ID for conversation continuity
contextContext data (JSON string with metrics, filters, claims data, etc.)
request-claims_stream
api_keyAPI key for authentication
promptThe user's message/question
Session ID for conversation continuity
Additional context information
request-claimsearch_sso_data
claim_idUUID of the claim
vendor_reference_idISO file number for deep-linking to a specific match report. If omitted, lands on the ClaimSearch home page.
request-create_additional_interest
request-create_adjuster_assignment_config
request-create_adjuster_license
contact_idUUID of the contact
business_location_idUUID of the business location (state)
license_numberLicense number
effective_dateEffective date in YYYY-MM-DD format
expiration_dateExpiration date in YYYY-MM-DD format
request-create_adjustment
adjustment_amountThe adjustment amount (USD, 2 decimal places). Required on both the source-ful and source-less paths. Negative values are chargebacks (money taken back from the agency). Accepted as a JSON number or as a decimal string; a string form is coerced server-side.
source_accounting_idThe ID of the source commission_accounting row to copy the policy, agency and agent from. OMIT this field to use the source-less path (policy-free agency chargeback), which instead requires agency_id, agent_id, adjustment_amount, period_start and period_end.
adjustment_reasonFree-text cause for the adjustment. Stored in commission_accounting.why. On the SOURCE-LESS path it is REQUIRED: it must be present, non-blank, and 150 characters or fewer. Non-blankness is evaluated AFTER server-side sanitization, so a markup-only value such as '' (which sanitizes to an empty string) is rejected; the 150-character limit is measured on the submitted value, and a longer value is rejected with a validation error rather than truncated. On the SOURCE-FUL path it remains optional, and an omitted value defaults to the literal 'User generated manual adjustment'. The 150-character limit is source-less-only, which is why it is described here in prose instead of as a JSON-Schema maxLength keyword. For MVR chargebacks the orchestrator supplies a human-readable cause built from the quote number, named insured and MVR pull date.
reason_codeCategorization code for the adjustment. Validated dynamically against the COMMISSION_ADJUSTMENT_REASONS quick code rather than a fixed enum, so the accepted values are whatever that quick code contains for the site. Seeded values are CORRECTION (the system default), BONUS and CHARGEBACK. When omitted on the source-less path the quick-code default (CORRECTION) is applied.
agency_idThe ID of the agency the adjustment is booked against (the payee). Required on the source-less path. Must be a contact holding the Agency role. The check verifies role membership only -- it does not verify the contact is active. Ignored on the source-ful path, where the agency is copied from the source commission_accounting row.
agent_idThe ID of the crediting agent for the adjustment. Required on the source-less path. Must be a contact holding the Agent role. The check verifies role membership only -- it does not verify the contact is active. Ignored on the source-ful path, where the agent is copied from the source commission_accounting row.
period_startStart of the commission period the adjustment covers. Required on the source-less path. Format: YYYY-mm-ddTHH:MM:SSZ (e.g. 2020-01-01T12:00:00Z). This is UTC time.
period_endEnd of the commission period the adjustment covers. Required on the source-less path. This value is snapped to the end of its month (last day, 23:59:59) and the snapped value is stored as the row's transaction date, so it determines which monthly commission payment period the chargeback rolls up into. The month is chosen AFTER the value is converted to America/Chicago, so a UTC instant just past midnight on the 1st (e.g. 2026-08-01T00:00:00Z) lands in the PREVIOUS month (July 31, not August 31). Policy-free rows are not yet rendered on the monthly commission statement document (BC-23074): the chargeback changes the agency's commission payment amount but does not appear as a statement detail line. Format: YYYY-mm-ddTHH:MM:SSZ (e.g. 2020-01-01T12:00:00Z). This is UTC time.
request-create_and_rate_endorsement_quote
The endorsement request data
rate_quoteFlag indicating whether to rate the endorsement after creation
Optional quote data to apply to the endorsement (items, risks, named_insureds, vehicles, drivers, sub_lines, billing_information). Uses definition IDs (item_id, sub_line_id) - instance IDs are resolved automatically from the endorsement revision.
statelessFlag indicating whether the operation should be stateless (do not store any data)
request-create_and_rate_full_quote
The full quote request data
statelessFlag indicating whether the operation should be stateless (do not store any data)
rate_quoteFlag indicating whether to rate the quote after creation
request-create_calculated_field
field_name^[a-zA-Z_][a-zA-Z0-9… · requiredValid Python identifier for the calculated field
expressionRestrictedPython expression to evaluate
pathDot-notation path (e.g. 'drivers', 'coverages.deductibles'). Empty for root.
descriptionOptional description
x_report_location_idTemplate deliverable ID. Null for global fields.
request-create_carbone_custom_deliverable
location_idpolicy_type_namecustom_nameThe deliverable name.
moduleoverwrite_stockprint_on_initial_decprint_on_renewal_decprint_on_non_autopayallow_britequote_creationgenerated_percarbone_template_idsource_file_namedraft_carbone_template_iddraft_source_file_namelast_preview_entity_numberuse_dynamic_fieldsOptional list of dynamic fields to associate with this template. Validated (and, for a dropdown field, its option_source-specific requirements) before the deliverable row is created.
request-create_configuration_import
file_idA configuration package already stored on this site. Must be active and of the configuration package file type.
urlPresigned Amazon S3 https link to the package. Only Amazon S3 hosts are accepted and redirects are refused, because the fetch is made from inside the cluster.
request-create_contact
nametypeconfirmation_email^[a-zA-Z0-9_.+-]+@[a…date_of_birthdrivers_licenseexternal_system_referencelast_synched_datesource_update_datefein_tax_idlegal_entity_typedate_business_starteddbaadded_bypurchase_datepositionwebsitessn_groupssnagency_inception_dateagency_termination_datefollow_agency_quoting_restrictionusernamegenderdriver_license_datelicense_state^[A-Z]{2}$date_of_deathhicn_numbercompany_idagency_group_numberagency_numberproducer_numberagency_group_idagency_idagent_idscommission_structurerequest-create_copilot_skill
nameDisplay name of the skill
bodyMarkdown instruction body consumed by agents
descriptionShort summary of the skill
statusInitial status. Defaults to DRAFT if omitted.
applicable_copilotsCopilot identifiers this skill applies to. Empty means all copilots.
request-create_custom_error_code
The custom error code to create
request-create_dispute
A claim Dispute, including litigation details, settlements, and dates.
request-create_effective_date
effective_dateThe effective date
idThe id of the effective date
descriptionThe description of the effective date
policy_type_idsThe policy type ids
policy_type_external_system_referencesThe policy type external system references
forceWhen true, skips all validations during effective date creation
request-create_endorsement_quote
quote_idThe ID of the Quote to endorse
quote_external_system_referenceThe external system reference of the Quote to endorse
endorsement_dateThe date of the endorsement
request-create_exposures
List of exposure objects to create
api_keyAPI key for authentication
request-create_full_quote
effective_dateQuote Effective Date
term_typeTerm Type
external_system_referenceExternal ID of the Quote
policy_type_idPolicy Type ID
policy_type_external_system_referenceExternal ID of the Policy Type
agent_idThe UUID of the Agent
agent_external_system_referenceExternal ID of the Agent
agency_idThe UUID of the Agency
agency_external_system_referenceExternal ID of the Agency
transaction_typeList of Risks, required if require_risk_address line configuration is true
Optional list of auto vehicles to create and associate with the quote
Optional list of drivers to create and associate with the quote
policy_term_external_referenceExternal Reference of the Policy Term
numberPolicy Number
number_originOrigin of the Policy Number
copy_template_risksWhether to copy risks from template if available. Defaults to false.
renewal_statusRenewal status for the policy. If not provided, uses the default from policy lifecycle settings.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: effective_date, term_type, underwriting_questions | |
| type = object · requires: effective_date, term_type, underwriting_questions |
effective_dateQuote Effective Date
term_typeTerm Type
external_system_referenceExternal ID of the Quote
policy_type_idPolicy Type ID
policy_type_external_system_referenceExternal ID of the Policy Type
agent_idThe UUID of the Agent
agent_external_system_referenceExternal ID of the Agent
agency_idThe UUID of the Agency
agency_external_system_referenceExternal ID of the Agency
transaction_typeList of Risks, required if require_risk_address line configuration is true
Optional list of auto vehicles to create and associate with the quote
Optional list of drivers to create and associate with the quote
policy_term_external_referenceExternal Reference of the Policy Term
numberPolicy Number
number_originOrigin of the Policy Number
copy_template_risksWhether to copy risks from template if available. Defaults to false.
renewal_statusRenewal status for the policy. If not provided, uses the default from policy lifecycle settings.
request-create_full_quote_async
effective_dateQuote Effective Date
term_typeTerm Type
Optional async-creation toggles.
external_system_referenceExternal ID of the Quote
policy_type_idPolicy Type ID
policy_type_external_system_referenceExternal ID of the Policy Type
agent_idThe UUID of the Agent
agent_external_system_referenceExternal ID of the Agent
agency_idThe UUID of the Agency
agency_external_system_referenceExternal ID of the Agency
transaction_typeList of Risks, required if require_risk_address line configuration is true
Optional list of auto vehicles to create and associate with the quote
Optional list of drivers to create and associate with the quote
policy_term_external_referenceExternal Reference of the Policy Term
numberPolicy Number
number_originOrigin of the Policy Number
copy_template_risksWhether to copy risks from template if available. Defaults to false.
renewal_statusRenewal status for the policy. If not provided, uses the default from policy lifecycle settings.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: effective_date, term_type, underwriting_questions | |
| type = object · requires: effective_date, term_type, underwriting_questions |
effective_dateQuote Effective Date
term_typeTerm Type
Optional async-creation toggles.
external_system_referenceExternal ID of the Quote
policy_type_idPolicy Type ID
policy_type_external_system_referenceExternal ID of the Policy Type
agent_idThe UUID of the Agent
agent_external_system_referenceExternal ID of the Agent
agency_idThe UUID of the Agency
agency_external_system_referenceExternal ID of the Agency
transaction_typeList of Risks, required if require_risk_address line configuration is true
Optional list of auto vehicles to create and associate with the quote
Optional list of drivers to create and associate with the quote
policy_term_external_referenceExternal Reference of the Policy Term
numberPolicy Number
number_originOrigin of the Policy Number
copy_template_risksWhether to copy risks from template if available. Defaults to false.
renewal_statusRenewal status for the policy. If not provided, uses the default from policy lifecycle settings.
request-create_insight
reference_typeType of resource to attach the insight to
reference_idUUID of the claim or policy to attach the insight to
insight_typeInsight category
insight_severityUrgency level assigned by the copilot
titleShort headline
descriptionAdjuster-readable narrative
product_areaProduct-area placement; omit or null for reference-wide insights. Valid values depend on reference_type. CLAIM: INFORMATION, PARTIES, VEHICLES, DAMAGED_PROPERTIES, INJURIES, ESTIMATIONS, ACCOUNTING, DISPUTES, NOTES, ATTACHMENTS. POLICY: INFORMATION, UNDERWRITING, SUBJECTIVITIES, CONTACTS, PROPERTY, VEHICLES, DRIVERS, COVERAGES, RATING, NOTES, ATTACHMENTS, RENEWAL.
reshowAcknowledge re-show policy; omit to default to UNTIL_RESOLVED
snooze_daysPer-insight snooze-window override in days; omit or null to fall back to the severity default
selectorOptional card-level deep-link within product_area. Requires a non-null product_area. CLAIM selectors are per product area (e.g. INFORMATION: CLAIM_INFORMATION, POLICY_INFORMATION, ADDITIONAL_INFORMATION, CLAIM_ASSIGNMENTS, CLAIMS_HISTORY, LOSS_ADDRESS, CATASTROPHE, REINSURANCE_CONTRACTS, DATES, REPORTS, PHOTOS; ACCOUNTING: ACCOUNTING_OVERVIEW, RECOVERIES, EXPOSURE_INFORMATION; PARTIES: PARTIES_LIST; VEHICLES: VEHICLES_LIST; DAMAGED_PROPERTIES: DAMAGED_PROPERTIES_LIST; INJURIES: INJURIES_LIST; ESTIMATIONS: ESTIMATIONS_LIST; DISPUTES: DISPUTES_LIST, LITIGATION_DETAILS; NOTES: NOTES_LIST; ATTACHMENTS: ATTACHMENTS_LIST). POLICY selectors are per product area (INFORMATION: EFFECTIVE_DATES, POLICY_STATUS, REVISION, PREMIUM_TOTALS; UNDERWRITING: STP_STATUS, UW_RULES, UW_QUESTIONS, UW_CONTACT; SUBJECTIVITIES: SUBJECTIVITIES_LIST, ESIGNATURE; CONTACTS: NAMED_INSURED, ADDITIONAL_INTERESTS, AGENT, PREMIUM_FINANCE, SURPLUS_LINE_PRODUCER, CONTACTS_SECTION; PROPERTY: PROPERTIES_LIST; VEHICLES: VEHICLES_LIST; DRIVERS: DRIVERS_LIST; COVERAGES: PRIMARY_EXPOSURES, POLICY_WIDE; RATING: PREMIUM_TOTALS, COMMISSION_RATE, CREDIT_SCORE; NOTES: NOTES_LIST; ATTACHMENTS: ATTACHMENTS_LIST; RENEWAL: RENEWAL_STATUS, POLICY_STATUS).
request-create_line
nameThe name of the line to create
business_location_idThe UUID of the business location
request-create_policy_type
effective_date_idUUID of the Effective Date
location_idUUID of the Location (State)
Line of Business. Provide ID to use existing line, or name to create a new line.
request-create_policy_type_item
nameName of the Line Item
categoryCategory of the Line Item (Policy or Risk)
typeType of the Line Item
requirement_typeRequirement type of the Line Item
idID to be set for the Line Item (optional)
external_system_referenceExternal System Reference for the Line Item
descriptionDescription of the Line Item
system_tagsSystem-specific tags associated with the Line Item
has_limitIndicates if the Line Item has a limit
has_rate_or_deductibleIndicates if the Line Item has a rate or deductible
has_loss_payeeIndicates if the Line Item has a loss payee
allow_multiplesIndicates if multiple instances of this Line Item are allowed
premium_fully_billedIndicates if the premium is fully billed
premium_fully_earned_at_inceptionIndicates if the premium is fully earned at inception
premium_added_to_other_itemIndicates if the premium is added to another item
disallow_submit_boundIndicates if submitting bound is disallowed
display_on_dec_asHow the item should be displayed on declaration
dec_font_sizeFont size for declaration
dec_font_boldIndicates if the font should be bold in declaration
dec_font_italicIndicates if the font should be italic in declaration
dec_aliasesAliases for declarations display
do_not_display_in_dec_rating_informationIndicates if the item should not be displayed in declaration rating information
do_not_display_in_dec_when_zero_premiumIndicates if the item should not be displayed in declaration when premium is zero
display_in_dec_as_incl_when_zero_premiumIndicates if the item should be displayed as included in declaration when premium is zero
show_limit_and_premium_on_decIndicates if limit and premium should be shown on declaration
dividend_factorDividend factor for the Line Item
show_in_builderSpecifies where the item should be shown in the builder
hide_in_britequoteIndicates if the item should be hidden in BriteQuote
limit_availabilitySpecifies the limit availability for the Line Item
loss_exposureIndicates if the item represents a loss exposure
loss_free_creditDetails about loss-free credit
no_commission_paid_on_line_itemIndicates if no commission is paid on this Line Item
override_limitIndicates if the limit can be overridden
not_applicable_for_agency_billingIndicates if the item is not applicable for agency billing
prevent_from_being_deletedIndicates if the item should be prevented from being deleted
display_user_inputs_above_rate_categoriesIndicates if user inputs should be displayed above rate categories
renewal_amountRenewal amount for the Line Item
default_loss_reserveDefault loss reserve amount
default_adjusting_reserveDefault adjusting reserve amount
default_legal_reserveDefault legal reserve amount
modifies_other_items_on_renewalIndicates if this item modifies other items on renewal
not_rated_by_prorata_and_factorIndicates if the item is not rated by pro-rata and factor
Rate chain for the Line Item
renewal_split_bySpecifies how renewal is split
Zip code factors for renewal
renewal_factor_item_idsLine item IDs whose limit this item inflates at renewal (inflation guard targets)
round_methodRounding method for calculations
round_toSpecifies to what decimal place to round
round_pro_rataIndicates if pro-rata should be rounded
scheduled_itemDetails about scheduled item
skip_persistent_builder_when_added_mandatorilyIndicates if persistent builder should be skipped when added mandatorily
skip_persistent_builder_when_new_category_addedIndicates if persistent builder should be skipped when new category is added
disallow_submit_bound_if_limit_exceedsIndicates if submitting bound should be disallowed if limit exceeds
submit_bound_upper_limitUpper limit for submitting bound
pro_rate_feeIndicates if fee should be pro-rated
sort_orderSort order for the Line Item
claim_coverage_party_typeSpecifies the claim coverage party type
calculate_item_commission_rateIndicates if item commission rate should be calculated
commission_rate_evalCommission rate evaluation
erp_enabledIndicates if Extended Reporting Period (ERP) is enabled for this Line Item
default_erp_duration_daysDefault duration in days for the Extended Reporting Period (ERP)
erp_line_item_idReference to the Line Item used for ERP calculations
request-create_policy_type_relation
policy_type_idThe ID of the primary policy type
related_policy_type_nameThe name of the related policy type
related_line_nameThe name of the related line
relationship_typeThe type of relationship
request-create_quick_code_value
request-create_quick_quote_template
nameThe name of the Quick Quote Template
Quote-wide data containing coverage items
policy_type_idsList of policy type IDs to associate with this template
request-create_quote_extended
Information about the quote content, or a previously created stateless_quote_id
run_statelessIf true, run the quote in stateless mode. This will create a stateless_quote_id in response. If 'debug', it will run the quote and include execution details, but NOT create a stateless_quote_id. If false (default), the quote will be stored in the database and a policy number/ID is returned.
run_uw_rulesRun Underwriting Rules and calculate limits of Property Items. If run_stateless is set, this will be ignored, as Underwriting Rules are always run in stateless mode.
requoteOnly works when run_stateless is false.
request-create_rating_table_definition
nameName of the rating table definition.
location_idThe ID of the location (state) for this rating table definition.
type The type of the rating table definition.
request-create_renewal_quote
quote_idQuote ID
external_system_referenceExternal ID of the Quote
policy_numberPolicy Number
request-create_rule
policy_type_idUUID of the policy type
nameRule name
categoryRule category (policy, property, vehicle, driver, claim, etc.)
moduleModule the rule applies to (all, bc, bq, events, stp)
descriptionRule description
severitySeverity level for STP rules (critical, high, medium, low)
waiver_behaviorWaiver behavior for STP rules (run_always, waived_for_x_terms)
waiver_termsNumber of terms for waiver (when waiver_behavior is waived_for_x_terms)
enabled_for_renewalWhether rule runs on renewals
enabled_for_endorsementWhether rule runs on endorsements
enabled_for_new_businessWhether rule runs on new business
sort_orderRule sort order
valid_from_dateStart date for rule validity (YYYY-MM-DD)
valid_to_dateEnd date for rule validity (YYYY-MM-DD)
properties_affectedWhich properties are affected (null, primary, non-primary)
exception_typeException type (include, exclude)
exception_agenciesList of agency IDs for exceptions
eventEvent type for events module rules
Array of rule triggers
Array of rule effects
request-create_sub_line
policy_type_idUUID of the parent policy type this subline belongs to
nameName of the Subline
categoryCategory of the Subline (Policy or Risk)
requirement_typeRequirement type of the Subline
typeType of the Subline
idUnique identifier for the Subline
external_system_referenceExternal System Reference for the Line Item
allow_multiplesIndicates if multiple instances of this Subline are allowed
name_edit_allowedIndicates if editing the name of the Subline is allowed
sort_orderSort order for the Subline
descriptionDescription of the Subline
system_tagsSystem tags associated with the Subline
hide_fromSpecifies where the Subline should be hidden from
List of line items associated with this Subline
request-create_subjectivity
subjectivity_definition_idID of the subjectivity definition
statusStatus of the subjectivity
revision_idID of the revision
external_system_referenceReference to the revision in an external system
due_dateDue date for this subjectivity to be met before
assigneeID of the assignee
descriptionDescription of the subjectivity
statementStatement for the subjectivity. Copied from the subjectivity definition if not provided.
request-create_subjectivity_definition
nameName for the subjectivity definition
mandatorytrue for mandatory and false for non-mandatory. Default is false
activetrue for active and false for inactive. Default is true
descriptionDescription for the subjectivity definition
policy_type_idID of the associated policy type
due_within_daysDays the subjectivity definition is due within
due_date_typeType of due date (e.g., Post Bind, Post Issue)
statementStatement for the subjectivity definition
request-create_system_tags
request-create_task
task_definition_idThe ID of the task definition to use when creating this task.
claim_idOptional ID of the claim associated with this task. Mutually exclusive with policy_id.
policy_idOptional ID of the policy associated with this task. Mutually exclusive with claim_id.
descriptionDescription of the task.
priorityPriority level of the task.
due_dateWhen this task is due (must be greater than or equal to today).
assignee_idThe ID of the user to assign this task to.
mandatoryWhether this task is mandatory.
orkes_task_idThe Orkes workflow task ID associated with this task.
request-create_task_definition
nameThe name of the task definition.
scopeThe scope of the task definition (claim or policy).
descriptionDescription of the task definition.
request-create_task_definitions_assignees
task_definition_idThe ID of the task definition to assign roles and user groups to.
role_idsList of role IDs to assign to the task definition.
user_group_idsList of user group IDs to assign to the task definition.
added_byThe ID of the user creating the assignments.
request-create_task_note
task_idThe id of the task the note belongs to.
contentsThe note body.
share_to_policyAlso publish the note to the task's policy, where it appears on the Notes tab. Needs no permission beyond this endpoint's own, but the task must be attached to a policy. Defaults to false and cannot be changed after the note is written.
request-create_template_risk_default_value
quick_quote_template_idThe ID of the Quick Quote Template this risk value belongs to
Risk-specific data structure that varies based on risk_type
risk_typeThe type of risk (Property, Vehicle, Driver, or Watercraft)
versionVersion number for the risk default value
request-create_watercraft
Watercraft definition schema
skip_rulesWhether to skip business rules validation
request-decline_pending_payment
integration_instance_external_idExternal ID of the integration instance.
vendor_messageMessage from the vendor explaining the reason for declining the payment.
payment_idUnique identifier for the payment to decline. Exactly one of payment_id or reference_id must be provided.
reference_idExternal reference identifier for the payment to decline. Exactly one of payment_id or reference_id must be provided.
requester_contact_idOptional. Contact id of the BriteCore user who originated the payment, derived from the authenticated user by request_payment_entry and echoed back via the Stripe PaymentIntent metadata. When provided, the "Payment Declined" policy note is attributed to that user instead of the integration service account (srv_integrations). See BC-19725.
request-delete_additional_interest
idAdditional interest ID to delete
request-delete_adjuster_license
license_idUUID of the license to delete
request-delete_brand
idThe unique identifier of the brand to delete
request-delete_calculated_field
idID of the field to delete
request-delete_config
location_idBusiness-location UUID whose override should be removed.
request-delete_copilot_skill
idUUID of the copilot skill to delete
request-delete_custom_error_code
idThe error code ID to delete
request-delete_dispute
dispute_idID of the dispute to delete
request-delete_full_quote
idQuote ID
external_system_referenceReference to the quote in an external system
request-delete_html_template
nameName of the template to delete.
request-delete_quick_code_value
code_value_typeThe unique code value identifier to delete
quick_codeThe quick code identifier this value belongs to
request-delete_quick_quote_template
template_idThe ID of the Quick Quote Template to delete
request-delete_rule
rule_idUUID of the rule to delete
request-delete_sub_line
idUUID of the subline to delete
request-delete_subjectivity
idID of the subjectivity to delete
request-delete_task_definition
idThe ID of the Task Definition to delete
request-delete_template_risk_default_value
value_idThe ID of the Template Risk Default Value to delete
request-delete_watercraft
idThe ID of the watercraft to delete
request-disbursement_funding_archive_account
financial_account_idThe BriteCore anchor to archive.
request-disbursement_funding_check_source_balance
integration_instance_idThe funding integration instance, from describe_connection.
funding_source_idThe BriteCore funding-source row id, from list_funding_sources. A source the vendor lists but BriteCore has never linked has a null source_id there and cannot be checked until it is linked.
request-disbursement_funding_describe_connection
request-disbursement_funding_get_financial_account_balance
integration_instance_idThe funding integration instance, from describe_connection.
financial_account_idThe BriteCore financial-account anchor to read, from reconcile_view. The stored vendor handle is resolved server-side; a vendor reference is deliberately NOT accepted here.
request-disbursement_funding_link_funding_source
integration_instance_idThe funding integration instance, from describe_connection.
vendor_reference_idThe live vendor source handle to link.
priorityWaterfall position; defaults to 1 when omitted.
request-disbursement_funding_list_financial_account_transactions
integration_instance_idThe funding integration instance, from describe_connection.
financial_account_idThe BriteCore financial-account anchor whose ledger to read, from reconcile_view. The stored vendor handle is resolved server-side.
cursorOpaque vendor pagination cursor. Omit for the first page; pass the previous response's next_pagination_cursor for the next. User-paged ('Load more'), not a background sweep.
request-disbursement_funding_list_funding_requests
financial_account_idThe BriteCore financial-account anchor whose money-IN log to read.
limitPage size, default 25 and capped at 100. Out-of-range and missing values are clamped rather than rejected: a bad page size on a read has an obvious safe answer, unlike a bad id. The cap is what matters -- the log is never pruned.
offsetRows to skip, default 0. Combined with has_more this drives Load more.
request-disbursement_funding_list_funding_sources
integration_instance_idThe funding integration instance, from describe_connection.
request-disbursement_funding_manage_account
integration_instance_idThe funding integration instance, from describe_connection.
vendor_reference_idThe discoverable vendor account handle to onboard.
request-disbursement_funding_reconcile_view
integration_instance_idThe funding integration instance, from describe_connection.
request-disbursement_funding_request_source_entry
integration_instance_idThe funding integration instance, from describe_connection.
request-disbursement_funding_set_source_priority
funding_source_idThe stored BriteCore source row.
priorityNew waterfall position; 1 is tried first.
request-disbursement_funding_top_up
integration_instance_idThe funding integration instance, from describe_connection.
financial_account_idThe BriteCore financial-account anchor to pull money INTO.
funding_source_idThe BriteCore funding-source row to pull money FROM, from list_funding_sources. Must already be linked; a never-linked source has a null source_id there.
amountAmount in DOLLARS. Whole cents only -- a sub-cent value is refused rather than rounded, and zero is refused outright. Validated in the service against the funding schema before any vendor call.
request_idCaller-supplied idempotency key, and ALSO the vendor Idempotency-Key. MINT THIS WHEN THE ADD MONEY MODAL OPENS, not on submit: that is what makes a double-click dedupe to one pull. Re-sending the same id replays the recorded outcome; re-sending it with a DIFFERENT amount, account, or source is rejected, so a client bug cannot masquerade as idempotent success.
request-disbursements_admin_terminate
disbursement_attempt_idThe pending ACH attempt to terminate.
justification\S · requiredOperator justification (required; must not be blank/whitespace).
request-disbursements_aggregates
Filter by transaction type.
Filter by rail.
Filter by integration instance.
added_from^\d{4}-(0[1-9]|1[0-2…Inclusive dateAdded lower bound (ISO date/datetime); mirrors the list grid so a date-filtered view gets a matching aggregate card.
added_to^\d{4}-(0[1-9]|1[0-2…Inclusive dateAdded upper bound (date-only widened to end-of-day).
request-disbursements_cancel
disbursement_attempt_idThe in_transit ACH attempt to cancel.
justification\S · requiredOperator justification (required; must not be blank/whitespace).
request-disbursements_check_vendor
disbursement_attempt_idThe pending ACH attempt to reconcile.
request-disbursements_get_detail
disbursement_attempt_idThe disbursement attempt id.
request-disbursements_issue
integration_instance_idActive ACH_ISSUANCE instance id.
Commission Payment issuance items.
request-disbursements_list_disbursements
Route to by-type when set.
Filter by disbursement state.
Filter by rail.
Filter by integration instance.
added_from^\d{4}-(0[1-9]|1[0-2…Inclusive dateAdded lower bound (ISO date/datetime).
added_to^\d{4}-(0[1-9]|1[0-2…Inclusive dateAdded upper bound (date-only widened to end-of-day).
page1-based page number (>= 1).
page_sizePage size (1..200).
request-disbursements_needs_attention
Filter by transaction type.
Filter by rail (mirrors the list grid). No state filter -- the surface is inherently the terminal failed set.
Filter by integration instance.
added_from^\d{4}-(0[1-9]|1[0-2…Inclusive dateAdded lower bound (ISO date/datetime); mirrors the list grid so a date-filtered view gets a matching worklist total.
added_to^\d{4}-(0[1-9]|1[0-2…Inclusive dateAdded upper bound (date-only widened to end-of-day).
page1-based page number (>= 1).
page_sizePage size (1..200).
request-disbursements_obligation_history
transaction_typeObligation transaction type.
transaction_idObligation transaction id.
request-disbursements_record_manual
transaction_typeObligation transaction type.
transaction_idObligation transaction id.
amountAmount (USD, 2 decimal places), between 0.01 and 90071992547409.91 (DISBURSEMENT_AMOUNT_MIN..DISBURSEMENT_AMOUNT_MAX). For a Commission Payment the server DERIVES the amount from the commission source and ignores this value; it is authoritative only for non-commission obligations. minimum/maximum bind when a JSON number is sent; a string form is coerced and range-checked server-side.
direct_payee_contact_idPayee contact id.
justification\S · requiredOperator justification (required; must not be blank/whitespace).
check_numberOptional check number.
external_referenceOptional external reference (max 255 chars); persisted into the encrypted method_details audit blob.
request-disbursements_source_enrichment
disbursement_attempt_idsAttempt ids to enrich (1 to 200).
request-disbursements_unissued_obligations
Optional. Only Commission Payment is accepted in this build (the one obligation type with an engine-read queue); any other value is a validation error, not an empty page.
page1-based page number (>= 1).
page_sizePage size (1..200).
request-documents_templates
api_keyAPI key for BriteCore authentication
promptThe user's message/question
Session ID for conversation continuity
Template editor context (entity type, policy number, policy type, deliverable ID) - human-readable summary for the LLM.
JSON-encoded structured editor params for the agent state. Document Templates uses keys: deliverable_id, entity_number, entity_type, policy_type_name. Forwarded verbatim to AIAgents' initial_state_params; each agent's merge_initial_params hook decides what to do with it.
request-documents_templates_carbone_context
api_keyAPI key for BriteCore authentication
Policy or claim number. When present, returns the live SQLRunner-derived context for that entity. When absent, returns the canonical example context shipped with BriteCore.
Either 'policy' or 'claim'. Defaults to 'policy'. Authoritative only when entity_number is provided; the MCP server omits it otherwise. In example mode the DELIVERABLE decides which fixture is returned (see deliverable_id), so a claim template is not served the policy example just because the caller defaulted.
XReportLocation id of the deliverable being authored. Drives the calculated-field schema scope: globals only when absent, globals plus template-scoped fields when present. In example mode it also decides which fixture is returned - the deliverable's own module (policies/claims) wins over entity_type.
The Carbone-template page's policy-type dropdown selection. EXAMPLE MODE: this is what makes the returned items this site's rather than the fixture's - they are generated from that policy type's configured policy_type_items, with the real names a [name='...'] filter must match. LIVE MODE: a validator only. Absent, the fixture's own items are returned.
Business location narrowing policy_type_name to one location's configuration. Absent ('All Locations Default') the name may resolve several policy types across locations and their configured items are merged.
request-documents_templates_download
api_keyAPI key for BriteCore authentication
session_idAgent session ID (returned in the SSE start event)
filenameFile to download (e.g., document_template.docx). Must not contain path traversal characters (.. / )
request-documents_templates_stream
api_keyAPI key for authentication
promptThe user's message/question
Session ID for conversation continuity
Template editor context (entity type, policy number, policy type, deliverable ID) - human-readable summary for the LLM.
JSON-encoded structured editor params for the agent state. Document Templates uses keys: deliverable_id, entity_number, entity_type, policy_type_name. Forwarded verbatim to AIAgents' initial_state_params; each agent's merge_initial_params hook decides what to do with it.
request-download_import_schema
schema_typeType of schema to generate. If omitted, returns all fixed schemas.
policy_type_idPolicy type UUID. Required for dynamic schemas like policy_transactions. If provided without schema_type, returns all schemas for that policy type.
request-download_report_file
file_idThe id of the report file to download
as_urlAnswer 200 with the presigned url in the body instead of a 303 to it. Browsers need this, because fetch() follows a redirect as a cross-origin request and the storage buckets carry no CORS configuration. The gateway passes this field through untyped, so strings are coerced: "1", "true", "yes" and "on" are true, anything else is false.
request-edit_attachment
A File / attachment row. Marshmallow FileModel field names (snake_case). extra fields are ignored on deserialize; only title, description, code_value_type, and quick_code are persisted by edit_attachment.
reference_typeExpected owning entity type when hardening the edit. Must match the attachment's type.
reference_idExpected owning entity id when hardening the edit. Must match the attachment's reference_id.
claim_idLegacy claim ownership hint. Same as reference_id when the attachment belongs to a claim; ignored if reference_id is also supplied.
request-enable_business_location_with_all_counties
location_idThe ID of the business location to enable
countryCountry code ('US' or 'CA'), defaults to 'US'
request-enable_disable_contact
contact_idThe unique identifier of the contact
activeThe status of the contact. True to enable, false to disable. Default is false
request-ensure_receipt
payment_idUUID of the payment
policy_numberPolicy number to get the receipt for
request-evaluate_contact_screening
idID of the quote or revision to evaluate contact screening for
skip_integrationsIf true, skip external integration calls and only use existing screening results. Defaults to false.
request-evaluate_convenience_fee_formula
Per-method formula strings. Every key is optional. Empty / omitted values surface as inheritance markers in the response so the admin UI can render (inherits) instead of an error.
disclosure_stylePreview-message style for the returned messages. Defaults to standard; any unrecognized value is treated as standard.
request-execute_dummy_task
messageMessage to pass to the task.
fail_taskIf true, the task will raise an exception intentionally.
hold_transaction_secondsIf > 0, holds the transaction open for this many seconds before committing. This simulates the race condition where a task is queued inside atomic_operation but the BackgroundJob is not yet visible to the worker.
request-export_configuration
policy_type_idUUID of the policy type to export along with its dependencies (effective date, line, forms) and any related/underlying policy types.
skip_formsIf true, skip exporting form files (PDF forms and item forms) from S3
request-export_tasks
querySearch query for tasks. Matches task fields, claim number, policy number (including claim-attached tasks reached through the claim's policy), and named insureds.
viewNamed view applying server-side scoping. submissions = policy tasks whose latest revision is in submission; triage = open, unassigned tasks.
file_index0-based index of the file to build. Omitted or null, the response carries the plan only and builds no CSV. A file_index beyond the current file count is rejected rather than answered with an empty file: it means the filtered set shrank since the plan was made.
filename_timestamp^\d{8}-\d{6}$Site-local timestamp baked into the exported filenames, as YYYYMMDD-HHMMSS. Echo back the value the plan response returned so that every file of one export is named for the same instant and the filenames match the ones the preview listed; stamping per request instead would give a three-file export three different timestamps. Omitted, the service stamps the current time -- so a caller that ignores this field still gets a timestamped filename, it just cannot span files. Validated against exactly the shape the server emits, because it is interpolated into a filename.
group_by_policySend true when the queue is in By Policy mode. Keeps every task of a policy contiguous in the file, with unattached (triage) tasks in a leading bucket, since a CSV cannot express grouping. This is ORDERING ONLY -- unlike retrieve_tasks' group_by, it does not switch to group pagination, which would break the row-based file split. The screen's group ranking (unattached first, then overdue count desc, then top priority desc) is deliberately not reproduced: it would need an aggregate join on every export, and every column it derives from is already in the file. Must match between the plan request and each file request, or the files would be cut from a differently ordered result than the plan measured.
task_scopesWhether to return CLAIM work, POLICY work, or both. Omitted (the default) means both, so existing callers are unaffected. The Underwriting Workbench sends ["policy"]; claim work belongs to the Claims module's own task tab. An explicit list rather than something derived from view, because my_tasks / my_team / all_tasks are shared with the legacy Tasks Workbench, which lists every task on the site. THE RULE: the attachment decides when there is one, and the task's definition decides when there is not. policy = claimId IS NULL AND (policyId IS NOT NULL OR the task's definition is policy-scoped); claim is its exact complement. The two partition the table, so any subset selects a well-defined set of rows, and a task carrying BOTH columns is claim. Why the attachment wins where both could speak: task_definitions.scope was added NOT NULL DEFAULT 'claim' and backfilled every pre-existing definition, so a policy-attached task whose definition says 'claim' is ordinary legacy data and is still policy work. Why the definition decides an UNATTACHED task: it is binding, not advisory -- modify_task refuses to attach a claim-scoped task to a policy, so an unattached claim-scoped task can only ever become a claim task. The scope applies to the rows, to filter_counts / bucket_counts / view_counts and to group_by, so every number describes the rows returned. retrieve_task, modify_task and bulk_modify_tasks are unaffected and still serve both. An empty list is rejected.
Filter criteria for tasks
Sorting parameters, applied server-side over the whole filtered set rather than the returned page. Nullable keys place missing values last regardless of direction; task number is the final tiebreaker, so paging cannot repeat or skip a row. An unrecognised sort_by leaves only that tiebreaker.
request-exposure_remap_preview
claim_idID of the claim
loss_dateLoss date to evaluate the exposures against (ISO 8601 or MM/DD/YYYY[ hh:mm A])
api_keyAPI key for authentication
request-files_generate_upload_url_for_tmp_file
content_typeMIME type the uploaded object will be stored with. Also used to derive the S3 key's file extension. Example: application/pdf
key_suffixRelative sub-path (no leading slash, no '..' segments) appended after the enforced 'uploads/tmp_files/' base. Example: 'carbone/' yields 'uploads/tmp_files/carbone/'.
expires_inPresigned POST TTL in seconds. Defaults to 600; cannot exceed 7 days (604800).
max_sizeMaximum allowed upload size in bytes, enforced via the presigned POST's content-length-range condition. Defaults to 26214400 (25MB).
request-filter_subjectivities
start_dateStart date of the date range to filter subjectivities by
end_dateEnd date of the date range to filter subjectivities by
revision_idsIDs of the revisions to retrieve subjectivities from
external_system_referencesExternal system references to filter subjectivities by
assignee_idsIDs of the assignees to filter subjectivities by
pagePage number
page_sizeNumber of items per page
request-finalize_recovery_candidate
job_idBackgroundJob ID of the completed recovery task.
candidate_idCandidate identifier being finalized, e.g. 'file:uuid'.
request-finalize_sync
code_system.*\S.* · requiredCode system to finalize (e.g. 'ICD10')
source_version.*\S.* · requiredThe just-loaded release version; every active row in the code system NOT at this version is deactivated
request-find_contact_by_params
nameContact name to search for (full or partial). Cannot be empty.
role_nameOptional. Filter contacts by a specific role name (e.g., 'Agent', 'Administrator')
dob^(0[1-9]|1[0-2])/(0[…Optional. Contact's date of birth in mm/dd/yyyy format
exclude_rolesOptional. Array of role names to exclude from results. Mutually exclusive with role_name.
exclude_empty_usernamesOptional. If true, excludes contacts with empty usernames
requires_login_informationOptional. If true, only returns contacts whose roles have the 'loginInformation' aspect
page_sizeOptional. Maximum number of results to return
request-fnol
api_keyAPI key for BriteCore authentication
promptThe user's message/question
session_idSession ID for conversation continuity
contextAdditional context information
request-fnol_stream
api_keyAPI key for authentication
promptThe user's message/question
session_idSession ID for conversation continuity
contextAdditional context information
request-get_accounting_loss_details
api_keyAPI key for authentication
claim_idID of the claim for which to retrieve loss details data
pagePage number for paginated exposures (default: 1)
page_sizeNumber of exposures per page (default: 100)
request-get_accounting_overview
api_keyAPI key for authentication
claim_idID of the claim for which to retrieve accounting overview data
pagePage number for paginated exposures (default: 1)
page_sizeNumber of exposures per page (default: 100)
request-get_accounting_recoveries_data
api_keyAPI key for authentication
claim_idID of the claim for which to retrieve recoveries data
pagePage number for paginated exposures (default: 1)
page_sizeNumber of exposures per page (default: 100)
request-get_additional_interest
idAdditional interest ID
request-get_adjuster_assignment_config
contact_idContact ID
request-get_all_associated_claims_parties
claim_idClaim ID whose associated parties should be returned
request-get_all_claim_transactions
claim_idThe ID of the claim for which to retrieve transactions data
pageThe page number for paginated transactions (default: 1)
page_sizeThe number of transactions per page (default: 100, max: 1000, null for all)
transaction_typesFilter by transaction type(s). If not provided, all types are returned.
categoriesFilter by transaction category(ies). If not provided, all categories are returned.
statusesFilter by transaction status(es). Currently supports 'voided' to show only voided transactions.
payment_methodsFilter by payment method(s). Only applies to payment transactions.
date_fromFilter transactions on or after this date (YYYY-MM-DD format)
date_toFilter transactions on or before this date (YYYY-MM-DD format)
sort_byField to sort results by (default: transaction_datetime)
sort_orderSort order: ascending or descending (default: desc)
request-get_applicable_forms
quote_idRevision id of the in-progress quote
request-get_billing_contact_emails
policy_numberPolicy number to get billing contact emails for
request-get_brand
idThe unique identifier of the brand
request-get_claim_estimation
estimation_idEstimation ID
request-get_claims_tabs_visibility
claim_idClaim ID for retrieving claims tabs visibility
request-get_configuration_export
export_idThe record id returned when the job was queued
request-get_configuration_import
import_idThe configuration import id returned by create_configuration_import
request-get_contact_by_agency
agency_numberAgency number
request-get_contact_by_agency_group
agency_group_numberAgency group number
request-get_contact_by_agent
producer_numberAgent producer number
request-get_contact_screening_status
idRevision id whose screening status should be reported
request-get_copilot_skill
idUUID of the copilot skill to retrieve
request-get_delayed_commission_accounting_entries
request-get_deliverable_preview_json
deliverable_idXReportLocation id of the deliverable being previewed. Optional in both modes. It scopes the calculated- and dynamic-field passes to that template (globals only when absent), and in EXAMPLE mode it also decides which fixture is loaded: the deliverable's own module wins over entity_type, so a claim deliverable gets the claim example even when the caller sends the default 'policy'.
entity_typeThe kind of entity to preview against. Authoritative in LIVE mode. In EXAMPLE mode it only decides the fixture when deliverable_id is absent (a template being authored before it has been saved, where the page's trigger-type select is the only signal); with a deliverable_id the deliverable's module decides. 'revision' resolves to the policy context.
entity_idID of the entity to preview. Optional: with neither entity_id nor entity_number the endpoint returns an EXAMPLE context.
entity_numberPolicy or claim number of the entity to preview. Optional: with neither entity_number nor entity_id the endpoint returns an EXAMPLE context.
location_idBusiness location. In LIVE mode a validator: a resolved entity belonging elsewhere returns a warning instead of a context. In EXAMPLE mode a SELECTOR: it narrows policy_type_name to one location's configuration. Absent ('All Locations Default') the name may resolve several policy types across locations, and their configured items are merged.
policy_type_namePolicy type. In LIVE mode a validator, as location_id is. In EXAMPLE mode a SELECTOR, and the one that decides what the panel shows: with it, the context's line items are generated from that policy type's configured policy_type_items - real names, dec sections, ordering, limits, deductibles and rating categories - instead of the fixture's. Without it the fixture's own items are left in place.
dynamic_field_valuesSimulated dynamic-field values keyed by field_key, used to preview the dynamic namespace (see CarboneDeliverableTemplateService.apply_dynamic_fields).
dynamic_fieldsIn-progress (not yet saved) dynamic-field definitions from Carbone Studio's local form state, used INSTEAD OF the database so an unsaved field still previews.
calc_fieldsIn-progress (not yet saved) calculated-field definitions, used INSTEAD OF the database so an unsaved field still previews.
request-get_dynamic_fields
deliverable_template_idid of the template (x_report_location.id) that has the dynamic_field.
reference_idOptional claim or revision ID. Used to render Jinja templates in default values and, for a dropdown field, to resolve live options (static list directly, dynamic against this entity's context).
request-get_effective_date
effective_date_idrequest-get_erp_items
policy_idThe policy ID to retrieve ERP items for
revision_idOptional revision ID. When supplied, only that revision's ERP items are returned; otherwise all non-archived revisions are included
request-get_estimated_quote
quote_idThe unique identifier (UUID) of the source quote/revision to use for the estimation.
rate_quoteIf true, the underlying quote will be rated to estimate a premium. If false, only a basic quote structure will be created.
statelessIf true, the generated estimated quote is not persisted in the database. If false, a new persistent quote is created.
request-get_event_types
request-get_exposure_edit_status
exposure_idID of the exposure
api_keyAPI key for authentication
request-get_exposure_transactions
exposure_idThe ID of the exposure for which to retrieve transactions data
transaction_typesFilter by transaction type(s). If not provided, all types are returned.
categoriesFilter by transaction category(ies). If not provided, all categories are returned.
statusesFilter by transaction status(es). Currently supports 'voided' to show only voided transactions.
payment_methodsFilter by payment method(s). Only applies to payment transactions.
date_fromFilter transactions on or after this date (YYYY-MM-DD format)
date_toFilter transactions on or before this date (YYYY-MM-DD format)
sort_byField to sort results by (default: transaction_datetime)
sort_orderSort order: ascending or descending (default: desc)
request-get_full_quote_async_status
reference_idReference ID returned by create_full_quote_async.
request-get_html_template
nameName of the template to retrieve.
request-get_installed_integrations
policy_type_idThe policy type ID to retrieve the installed integrations for. If not provided, returns all installed integrations.
integration_point_codeThe integration point code to filter integrations by (e.g., 'PROPERTY_VALUATION'). If not provided, returns all integration types.
request-get_invoices
policy_idThe unique identifier of the policy to retrieve invoices for.
bill_from_date^(0[1-9]|1[0-2])\/(0…Filter for invoices with a bill date on or after this date. Format: MM/DD/YYYY.
bill_to_date^(0[1-9]|1[0-2])\/(0…Filter for invoices with a bill date on or before this date. Format: MM/DD/YYYY.
due_from_date^(0[1-9]|1[0-2])\/(0…Filter for invoices with a due date on or after this date. Format: MM/DD/YYYY.
due_to_date^(0[1-9]|1[0-2])\/(0…Filter for invoices with a due date on or before this date. Format: MM/DD/YYYY.
sorting_orderThe sorting order for the invoices, based on their date.
page_numberThe page number of the result set to retrieve.
page_sizeThe number of invoices to return per page.
request-get_last_prefill_quote_execution_date
policy_idPolicy ID to get the last prefill execution date for
request-get_migration_job_status
job_idSpecific job UUID returned from run_migration. If omitted, returns list of recent jobs (last 24 hours).
include_logsIf true, include ERROR level logs in response (only applies when job_id is provided)
request-get_options
revision_idThe ID of the revision to get credit score options for
request-get_payment
payment_idThe unique identifier of the payment (claim transaction id)
request-get_policies_with_sub_line
sub_line_idUUID of the subline whose affected policies should be returned
limitMaximum number of policies to return. 0 means all.
request-get_policy_applicable_suspensions
policy_idUnique identifier for the policy
suspension_actionsArray of suspension actions to filter applicable suspensions
request-get_policy_number_history
policy_numberThe policy number for search.
request-get_policy_type
idUUID of the Policy Type
request-get_policy_type_item
idUUID of the Policy Type Item (line item)
request-get_policy_type_minimal
idUUID of the Policy Type
request-get_quick_quote_template
template_idThe ID of the Quick Quote Template to retrieve
request-get_quote_schema
policy_type_idUUID of the Policy Type to describe
request-get_quote_wizard_plugin
revision_idThe ID of the policy revision
integration_instance_idThe ID of the integration instance to use
integration_point_codeThe integration point code. Must be one of the supported values.
property_idProperty ID for property-specific content. Required when integration_point_code is QUOTE_WIZARD_PLUGIN_AFTER_RISK_RATING.
request-get_rate_chains
effective_date_idUUID of the effective date. Required unless policy_type_ids is provided. All policy types under this effective date are included.
location_idUUID of a location/state to narrow the effective date scope (optional)
policy_type_idsExplicit policy type UUIDs. When given, effective_date_id and location_id are ignored (optional)
step_typesRate chain step types to include (e.g. ["CATEGORIES"]). Steps of other types are excluded server-side. When omitted, full rate chains are returned (optional)
request-get_regenerate_statements_status
yearFour-digit calendar year of the report month (e.g. 2026). Must be supplied together with month.
monthCalendar month of the report month, 1-12. Must be supplied together with year.
request-get_revision_history
api_keyAPI key for authentication
policy_idPolicy ID to retrieve revision history for
request-get_risks
quote_idThe UUID of the quote to retrieve risks for
request-get_rule
rule_idUUID of the rule to retrieve
request-get_rules_config
request-get_rules_documentation
request-get_screening_history
contact_idThe unique identifier of the contact
request-get_status
task_idThe ID of the background job to retrieve status for.
request-get_underlying_policy_changes
revision_idThe UUID of the current umbrella revision
request-get_underwriting_question_autofill_answers
policy_type_idPolicy Type ID to get auto-fill answers for
request-get_upload_url
schema_typeSchema identifier for the file to be uploaded. For fixed schemas like 'insureds', 'agencies', etc., no policy_type_id is needed. For dynamic schemas like 'policy_transactions', policy_type_id is required.
policy_type_idPolicy type UUID (required for dynamic schemas like 'policy_transactions'). The first 8 characters will be used in the generated filename.
request-get_user_suspensions_with_geometries
date^(0[1-9]|1[0-2])-(0[… · requiredDate to filter suspensions in MM-DD-YYYY format
state^[A-Z]{2}$ · required2-letter state abbreviation to filter suspensions
request-get_watercraft
idThe ID of the watercraft to retrieve
request-get_zip_geometry
zip_code^\d{5}$ · required5-digit zip code to retrieve geometry for
request-grant_report_permission
report_idUUID of the report.
grantee_typeKind of grantee receiving access.
grantee_idIdentifier of the grantee (UUID for contact, role, user_group, permission_level).
accessAccess level to grant (write implies read for resolution; none blocks at this grantee row).
api_keyAPI key for external / programmatic clients.
request-import_configuration
import_idThe configuration import to run against, as returned by create_configuration_import.
dry_runValidate the package without applying it. Default false.
request-import_disclosures
List of disclosure data to be imported
overrideA flag to determine whether to override existing disclosures for the given properties
request-import_loss_report
property_idThe property ID
List of loss report records to be imported
loss_history_report_numberLoss history report number
loss_history_retrieved_dateDate when loss history report was retrieved
loss_history_vendor_statusLoss history report vendor status
cache_keyCache key for the loss history report
created_byContact ID of the user who requested the loss history report
request-import_payment_method
vendor_customer_idVendor Customer ID. This is the ID of the customer in the vendor system.
vendor_payment_method_idVendor Payment Method ID. This is the ID of the payment method in the vendor system.
payment_method_typecontact_idContact ID to which the payment method should be associated with.
contact_external_system_referenceExternal System Reference of the Contact to which the payment method should be associated with.
policy_term_idPolicy Term ID to which the payment method should be associated with.
policy_term_external_system_referenceExternal System Reference of the Policy Term to which the payment method should be associated with.
requester_contact_idContact ID of the BriteCore user who originally requested that this payment method be created. When provided, this user (rather than the integration server's service account) is recorded as the author of the resulting note. The integration server should forward the requester_contact_id it received on the matching request_payment_method_entry call.
request-import_policy_number
policy_idThe unique identifier of the policy to be imported.
policy_numberThe policy number to be imported.
request-import_raiting_table
location_idId of the State
table_definition_idId of the Rating Table Definition
effective_dateEffective date of the rating table
renewal_effective_dateRenewal effective date of the rating table
file_idFile ID of the rating table
request-io_mapping_add_memory_decision
decisionmappingIdThe mapping id.
topicrationalerequest-io_mapping_add_memory_followup
mappingIdThe mapping id.
statustopicrequest-io_mapping_add_memory_ruled_out
approachmappingIdThe mapping id.
reasonrequest-io_mapping_add_note
slugThe mapping slug.
bodyThe note body.
anchorKindanchorRefvariantThe product variant, e.g. an HO-6 overlay. Omit for the base layer.
authorKindreplyTokindThe record kind to filter by.
audiencerequest-io_mapping_ask_insurance_expert
slugThe mapping slug.
questionanchorKindanchorRefvariantThe product variant, e.g. an HO-6 overlay. Omit for the base layer.
authorKindrequest-io_mapping_ask_technical_expert
slugThe mapping slug.
questionanchorKindanchorRefvariantThe product variant, e.g. an HO-6 overlay. Omit for the base layer.
authorKindrequest-io_mapping_assess_variant_fit
slugThe mapping slug.
policyTypeThe policy type name, e.g. HO-3.
stateTwo-letter state abbreviation.
effectiveDateThe effective date the policy type resolves on.
request-io_mapping_call_wrapped_api
slugThe mapping slug.
fixtureIdA fixture id; defaults to the mapping's default fixture.
confirmRequired on a production site, and only with agreement given in this turn.
storeintentOne sentence stating what this call creates and why.
request-io_mapping_capture_reconcile_snapshot
slugThe mapping slug.
policyTypeThe policy type name, e.g. HO-3.
stateTwo-letter state abbreviation.
effectiveDateThe effective date the policy type resolves on.
capturedAtrequest-io_mapping_clear_agent_memory
mappingIdThe mapping id.
mapping_idrequest-io_mapping_compile_analytics_preview
slugThe mapping slug.
specrequest-io_mapping_compile_resolver_preview
slugThe mapping slug.
specvariantThe product variant, e.g. an HO-6 overlay. Omit for the base layer.
policyTypeThe policy type name, e.g. HO-3.
stateTwo-letter state abbreviation.
request-io_mapping_compile_response_preview
slugThe mapping slug.
specrequest-io_mapping_copilot
mappingIdThe mapping id.
promptfixtureIdA fixture id; defaults to the mapping's default fixture.
sessionIdselectionactiveTemplateSideturnIntentrequestTemplateresponseTemplaterequestFixtureresponseFixturerequest-io_mapping_create_fixture
slugThe mapping slug.
nameDisplay name.
contentTypecontentThe document body.
apiResponseContentisDefaultrequest-io_mapping_create_mapping
slugThe mapping slug.
nameDisplay name.
kindThe record kind to filter by.
inputFormatoutputFormatdescriptionFree-text description.
apiCallinputSchemainputSchemaIdanalyticsSchemaIddraftTemplateresponseDraftTemplaterequest-io_mapping_delete_fixture
fixtureIdA fixture id; defaults to the mapping's default fixture.
request-io_mapping_delete_mapping
slugThe mapping slug.
request-io_mapping_delete_schema
forceProceed even when the target is still referenced.
idThe schema-library row id.
specIdA schema-library spec id. spec_id is accepted as well.
spec_idA schema-library spec id. specId is accepted as well.
request-io_mapping_discard_draft_note
noteIdAn existing note id.
request-io_mapping_dismiss_memory_decision
mappingIdThe mapping id.
topicrequest-io_mapping_dismiss_memory_ruled_out
approachmappingIdThe mapping id.
request-io_mapping_export_mapping
slugThe mapping slug.
versionIdA stamped version id; defaults to the active version.
includeInputSchemarequest-io_mapping_find_live_copilot_job
slugThe mapping slug.
request-io_mapping_find_policy_type
effectiveDateThe effective date the policy type resolves on.
effective_datelineNameline_namenameDisplay name.
stateTwo-letter state abbreviation.
request-io_mapping_generate_sample
effectiveDateThe effective date the policy type resolves on.
effective_datenameDisplay name.
schemastateTwo-letter state abbreviation.
validaterequest-io_mapping_get_analytics_slots
slugThe mapping slug.
specrequest-io_mapping_get_copilot_job
jobIdslugThe mapping slug.
variantThe product variant, e.g. an HO-6 overlay. Omit for the base layer.
request-io_mapping_get_endpoint_slots
slugThe mapping slug.
directionWhich side of the mapping to act on: request, response or analytics.
request-io_mapping_get_mapping
slugThe mapping slug.
request-io_mapping_get_policy_type_definition
effectiveDateThe effective date the policy type resolves on.
effective_datejmespathQueryjmespath_querylineNameline_namenameDisplay name.
stateTwo-letter state abbreviation.
request-is_stp_enabled
revision_idRevision ID to check STP enablement for
request-io_mapping_get_policy_type_schema
effectiveDateThe effective date the policy type resolves on.
effective_datenameDisplay name.
stateTwo-letter state abbreviation.
request-io_mapping_get_resolver_constructs
slugThe mapping slug.
request-io_mapping_get_resolver_paths
slugThe mapping slug.
request-io_mapping_get_resolver_spec
slugThe mapping slug.
request-io_mapping_get_review
slugThe mapping slug.
policyTypeThe policy type name, e.g. HO-3.
stateTwo-letter state abbreviation.
versionIdA stamped version id; defaults to the active version.
fixtureIdA fixture id; defaults to the mapping's default fixture.
includeResolvedrequest-io_mapping_get_schema
idThe schema-library row id.
specIdA schema-library spec id. spec_id is accepted as well.
spec_idA schema-library spec id. specId is accepted as well.
request-io_mapping_get_schema_index
idschema_idrequest-io_mapping_get_slotfill_context
slugThe mapping slug.
nameDisplay name.
effectiveDateThe effective date the policy type resolves on.
request-io_mapping_get_source_paths
slugThe mapping slug.
fixtureIdA fixture id; defaults to the mapping's default fixture.
request-io_mapping_get_spec_overview
specIdA schema-library spec id. spec_id is accepted as well.
spec_idA schema-library spec id. specId is accepted as well.
request-io_mapping_get_variant_slots
policyTypeThe policy type name, e.g. HO-3.
stateTwo-letter state abbreviation.
effectiveDateThe effective date the policy type resolves on.
slugThe mapping slug.
variantThe product variant, e.g. an HO-6 overlay. Omit for the base layer.
fixtureIdA fixture id; defaults to the mapping's default fixture.
includeSuggestionsincludeTemplatespecrequest-io_mapping_import_mapping
payloadThe exported mapping document to import.
slugOverriderequest-io_mapping_infer_schema_from_workbook
contentThe document body.
filenamenameDisplay name.
request-io_mapping_introspect_fixture
fixtureIdA fixture id; defaults to the mapping's default fixture.
contentThe document body.
contentTyperequest-io_mapping_list_bruno_examples
apiCallrequest-io_mapping_list_endpoints
refreshrequest-io_mapping_list_fixture_coordinates
slugThe mapping slug.
specrequest-io_mapping_list_fixtures
slugThe mapping slug.
request-io_mapping_list_mappings
kindThe record kind to filter by.
request-io_mapping_list_notes
slugThe mapping slug.
statusanchorKindanchorRefvariantThe product variant, e.g. an HO-6 overlay. Omit for the base layer.
request-io_mapping_list_policy_types
request-io_mapping_list_schemas
rolerequest-io_mapping_list_spec_indexes
kindThe record kind to filter by.
specIdA schema-library spec id. spec_id is accepted as well.
spec_idA schema-library spec id. specId is accepted as well.
request-io_mapping_list_specs
request-io_mapping_list_versions
slugThe mapping slug.
request-io_mapping_load_revision_quote
policyIdrevisionIdrequest-io_mapping_lookup_spec_enum
codelimitMaximum rows to return.
listNamelistNamesNames of the code lists to read.
list_namelist_namesNames of the code lists to read.
queryspecIdA schema-library spec id. spec_id is accepted as well.
spec_idA schema-library spec id. specId is accepted as well.
request-io_mapping_lookup_spec_path
pathspecIdA schema-library spec id. spec_id is accepted as well.
spec_idA schema-library spec id. specId is accepted as well.
request-io_mapping_note_follow_up
slugThe mapping slug.
bodyThe note body.
audienceanchorKindanchorRefvariantThe product variant, e.g. an HO-6 overlay. Omit for the base layer.
authorKindrequest-io_mapping_promote_slot_to_base
slugThe mapping slug.
variantThe product variant, e.g. an HO-6 overlay. Omit for the base layer.
itemfieldkindThe record kind to filter by.
recompilepolicyTypeThe policy type name, e.g. HO-3.
stateTwo-letter state abbreviation.
request-io_mapping_reconcile_mapping
slugThe mapping slug.
policyTypeThe policy type name, e.g. HO-3.
stateTwo-letter state abbreviation.
effectiveDateThe effective date the policy type resolves on.
variantThe product variant, e.g. an HO-6 overlay. Omit for the base layer.
request-io_mapping_rename_mapping_slug
slugThe mapping slug.
newSlugrequest-io_mapping_render
policyTypeEffectiveDatepolicyTypeStateslugThe mapping slug.
mappingIdThe mapping id.
fixtureIdA fixture id; defaults to the mapping's default fixture.
templateOverridefixtureContentOverridefixtureContentTypeapiResponseOverridetemplateSha256SHA-256 (hex) of the client's copy, sent in place of templateOverride. The stored copy is rendered only when its digest matches; otherwise the response is resend.
fixtureContentSha256SHA-256 (hex) of the client's copy, sent in place of fixtureContentOverride. The stored copy is rendered only when its digest matches; otherwise the response is resend.
apiResponseSha256SHA-256 (hex) of the client's copy, sent in place of apiResponseOverride. The stored copy is rendered only when its digest matches; otherwise the response is resend.
directionWhich side of the mapping to act on: request, response or analytics.
outputFormatrequest-io_mapping_reply_to_note
slugThe mapping slug.
noteIdAn existing note id.
bodyThe note body.
outcomerequest-io_mapping_resolve_memory_followup
mappingIdThe mapping id.
topicrequest-io_mapping_resolve_note
noteIdAn existing note id.
resolvedrequest-io_mapping_review_inbox
slugThe mapping slug.
variantThe product variant, e.g. an HO-6 overlay. Omit for the base layer.
request-io_mapping_review_index
slugThe mapping slug.
request-io_mapping_save_draft_note
slugThe mapping slug.
bodyThe note body.
anchorKindanchorRefvariantThe product variant, e.g. an HO-6 overlay. Omit for the base layer.
replyTokindThe record kind to filter by.
audiencenoteIdAn existing note id.
outcomerequest-io_mapping_save_resolver_spec
slugThe mapping slug.
specvariantThe product variant, e.g. an HO-6 overlay. Omit for the base layer.
policyTypeThe policy type name, e.g. HO-3.
stateTwo-letter state abbreviation.
baseFingerprintrequest-io_mapping_search_policies
limitMaximum rows to return.
policyTypeIdqueryrequest-io_mapping_search_spec
limitMaximum rows to return.
queryspecIdA schema-library spec id. spec_id is accepted as well.
spec_idA schema-library spec id. specId is accepted as well.
request-io_mapping_set_active_version
slugThe mapping slug.
versionIdA stamped version id; defaults to the active version.
request-io_mapping_set_analytics_resolvers
slugThe mapping slug.
Resolver cells to author in this call.
request-io_mapping_set_declarations
slugThe mapping slug.
aliasesderivedchannelsvariantKeyreplacerecompilevariantThe product variant, e.g. an HO-6 overlay. Omit for the base layer.
policyTypeThe policy type name, e.g. HO-3.
stateTwo-letter state abbreviation.
previewrequest-io_mapping_set_endpoint_slot_source
slugThe mapping slug.
pathcelldirectionWhich side of the mapping to act on: request, response or analytics.
recompilerequest-io_mapping_set_item_repeat
slugThe mapping slug.
variantThe product variant, e.g. an HO-6 overlay. Omit for the base layer.
itemoverscopeWhich layer the write lands on.
distinctBykeepEmptyrecompilepolicyTypeThe policy type name, e.g. HO-3.
stateTwo-letter state abbreviation.
request-io_mapping_set_lookup_table
slugThe mapping slug.
tablemapdefaultrecompilevariantThe product variant, e.g. an HO-6 overlay. Omit for the base layer.
policyTypeThe policy type name, e.g. HO-3.
stateTwo-letter state abbreviation.
sourcePathtargetItemtargetFieldLookup tables to define in this call.
forVariantpreviewmodestandalonerequest-io_mapping_set_resolver_construct
slugThe mapping slug.
sectionvaluerecompilevariantThe product variant, e.g. an HO-6 overlay. Omit for the base layer.
policyTypeThe policy type name, e.g. HO-3.
stateTwo-letter state abbreviation.
mergepreviewrequest-io_mapping_set_resolver_path
slugThe mapping slug.
nameDisplay name.
pathPath aliases to write, as {name: path}.
recompilevariantThe product variant, e.g. an HO-6 overlay. Omit for the base layer.
policyTypeThe policy type name, e.g. HO-3.
stateTwo-letter state abbreviation.
previewrequest-io_mapping_set_resolver_table
slugThe mapping slug.
nameDisplay name.
tabledeleterecompilevariantThe product variant, e.g. an HO-6 overlay. Omit for the base layer.
policyTypeThe policy type name, e.g. HO-3.
stateTwo-letter state abbreviation.
previewrequest-io_mapping_set_resolvers
slugThe mapping slug.
Resolver cells to author in this call.
variantThe product variant, e.g. an HO-6 overlay. Omit for the base layer.
policyTypeThe policy type name, e.g. HO-3.
stateTwo-letter state abbreviation.
previewunsourcedSlots this document cannot fill, keyed by target with the reason.
Lookup tables to define in this call.
declarationsTables, variables and variant wiring to declare.
request-io_mapping_set_response_resolvers
slugThe mapping slug.
Resolver cells to author in this call.
replace_dialectrequest-io_mapping_set_response_rewrite
slugThe mapping slug.
editsreplace_dialectrequest-io_mapping_set_slot_source
slugThe mapping slug.
variantThe product variant, e.g. an HO-6 overlay. Omit for the base layer.
itemfieldkindThe record kind to filter by.
cellscopeWhich layer the write lands on.
recompilepolicyTypeThe policy type name, e.g. HO-3.
stateTwo-letter state abbreviation.
request-io_mapping_stamp_version
slugThe mapping slug.
semverTagnotessetActiverequest-io_mapping_start_copilot_job
slugThe mapping slug.
variantThe product variant, e.g. an HO-6 overlay. Omit for the base layer.
promptfixtureIdA fixture id; defaults to the mapping's default fixture.
request-io_mapping_stop_copilot_job
jobIdrequest-io_mapping_submit_review
slugThe mapping slug.
variantThe product variant, e.g. an HO-6 overlay. Omit for the base layer.
request-io_mapping_update_fixture
fixtureIdA fixture id; defaults to the mapping's default fixture.
nameDisplay name.
contentTypecontentThe document body.
apiResponseContentisDefaultrequest-io_mapping_update_mapping_metadata
slugThe mapping slug.
nameDisplay name.
descriptionFree-text description.
kindThe record kind to filter by.
inputFormatoutputFormatapiCallinputSchemainputSchemaIdanalyticsSchemaIdanalyticsEnabledanalyticsTemplateredactionRulesrequest-io_mapping_update_memory_summary
mappingIdThe mapping id.
summarymapping_idrequest-io_mapping_upload_schema
contentThe document body.
formatThe content format, e.g. jsonschema.
nameDisplay name.
descriptionFree-text description.
specIdA schema-library spec id. spec_id is accepted as well.
spec_idA schema-library spec id. specId is accepted as well.
request-issue_full_quote
idID of the Quote to issue
external_system_referenceReference to the quote in an external system
request-ivans_dbcs_abandon_build
yearFour-digit calendar year of the report month.
monthCalendar month of the report month, 1-12.
request-ivans_dbcs_get_build_status
yearFour-digit calendar year of the report month.
monthCalendar month of the report month, 1-12.
request-ivans_dbcs_get_configuration
request-ivans_dbcs_get_existing_artifacts
yearFour-digit calendar year of the report month.
monthCalendar month of the report month, 1-12.
request-ivans_dbcs_get_selected_agencies
request-ivans_dbcs_rebuild
yearFour-digit calendar year of the report month.
monthCalendar month of the report month, 1-12.
supersedes_file_idid of the earlier nxtech_dbcs XML this build replaces. Must exist, be DBCS XML and cover the requested month, or the request is refused before anything is queued. Recorded only on the NEW file's metadata; the superseded file is never modified.
acknowledged_unverified_monthRequired true for a month older than last month, whose commission checkpoint is not checked. Ignored for last month. Acknowledgement alone is not enough: the month must still have commission payments.
request-ivans_dbcs_resolve_agencies
contact_idsContact ids to resolve. Null or omitted is treated as an empty list and resolves nothing. Repeats are allowed. Ids with no contacts row come back in unknown_contact_ids.
request-ivans_dbcs_save_selected_agencies
contact_idsThe complete new selection. Null or omitted is treated as an empty list, which CLEARS the selection and therefore requires confirmation_text. Every id must be an eligible agency or the whole request is refused and nothing is written. Repeats collapse rather than erroring. The bound of 2000 is generous because a whole-roster save has to fit in one request.
confirmation_textRequired, and must be exactly 'CLEAR', only when contact_ids is empty -- clearing the selection stops DBCS file generation entirely, so it is never an accidental empty list. Ignored outright when contact_ids is non-empty.
request-ivans_dbcs_search_agencies
search_textCase-insensitive substring match against contacts.name OR contacts.agencyNumber. Null or omitted returns the whole eligible roster. Bounded at 250 because contacts.name is VARCHAR(250): a longer term cannot match either column.
page1-based page number. Bounded because it becomes the query's OFFSET, and an unbounded offset costs the same scan however far it walks. A page past the last one is not an error: it returns an empty agencies list with the real total_count.
page_sizeRows per page. 25 is both the default and the maximum; a larger value is refused rather than clamped.
request-ivans_dbcs_submit_build
yearFour-digit calendar year of the report month.
monthCalendar month of the report month, 1-12.
acknowledged_unverified_monthRequired true for a month older than last month, whose commission checkpoint is not checked. Ignored for last month. Acknowledgement alone is not enough: the month must still have commission payments.
request-ivr_policy_lookup
digits^[0-9]+$ · requiredPolicy number without letters and dashes, digits only
property_address_zip^[0-9]{5}$5-digit US zip code
request-link_underlying_policy
revision_idThe UUID of the target revision to link underlying policy to
underlying_policy_idThe UUID of the underlying policy to copy from
request-list_additional_interests
quote_idID of the quote/revision to list interests for (revision scope)
risk_idID of the risk/property to list interests for (risk scope)
request-list_calculated_fields
x_report_location_idTemplate deliverable ID. If provided, returns global + template-specific fields. If null/omitted, returns global fields only.
request-list_claim_changes
idUUID of the Policy Type
request-list_claim_estimations
claim_idClaim ID
request-list_configuration_exports
limitPage size. Defaults to 25; values outside the range are clamped rather than rejected.
offsetHow many to skip. Ordering is dateAdded descending with id as a tiebreaker, so paging is stable for rows written in the same second.
statusOptional filter. An unrecognised value is rejected rather than ignored, so a typo cannot read as 'none found'.
request-list_configuration_imports
limitPage size. Defaults to 25; values outside the range are clamped rather than rejected.
offsetHow many to skip. Ordering is dateAdded descending with id as a tiebreaker, so paging is stable for rows written in the same second.
statusFilter to packages whose runs include one in this status. Matching is against the runs, because a package has no status of its own. An unknown value is rejected rather than ignored: ignoring it would answer a typo with the whole listing.
request-list_contacts_by_role_code
roleThe role type to search
filterThe prefix to match against the role code. Minimum 5 characters after trimming whitespace.
limitMaximum number of results to return. Defaults to 50.
request-list_container_coverages_summary
quote_idQuote (revision) ID for Policy Wide container
property_idProperty ID for a specific property container
queryOptional filter to match coverages by name or description
paginationOptional pagination
request-list_containers
quote_idQuote (revision) ID to list containers for
queryOptional filter to match container coverages by name or description
request-list_copilot_skills
Filter by skill status. Omit or null for all statuses.
copilotFilter by applicable copilot identifier (e.g. 'claim-insights'). Returns skills whose applicable_copilots is empty or contains this value.
searchCase-insensitive substring match on name and description.
request-list_custom_error_codes
moduleOptional filter by module (e.g., 'stp')
request-list_custom_fields_types
quote_idThe ID of the quote to get custom field types for
request-list_definition_overrides
quick_codeThe quick code whose policy type definition overrides are reported
code_value_typeOptional quick code value. When provided, definitions_for_value lists the definitions holding an override row for it; when omitted, that list is empty.
request-list_disputes
claim_idClaim ID
request-list_effective_dates
pagePage number
page_sizeNumber of items per page
sort_orderSort order
request-list_forms_for_policy_type
policy_type_idPolicy Type to list forms for.
request-list_forms_for_policy_type_item
policy_type_item_idPolicy Type Item to list forms for.
request-list_grantee_options
grantee_typeWhich picker list to populate.
api_keyAPI key for external / programmatic clients.
request-list_insights
reference_typeType of resource whose insights are being listed
reference_idUUID of the claim or policy whose insights are being listed
product_areaOptional product-area filter. Omit or null to return insights from every product area. Pass the literal string "NULL" to limit results to reference-wide insights (rows whose product_area is null). For CLAIM references: INFORMATION, PARTIES, VEHICLES, DAMAGED_PROPERTIES, INJURIES, ESTIMATIONS, ACCOUNTING, DISPUTES, NOTES, ATTACHMENTS. For POLICY references: INFORMATION, UNDERWRITING, SUBJECTIVITIES, CONTACTS, PROPERTY, VEHICLES, DRIVERS, COVERAGES, RATING, NOTES, ATTACHMENTS, RENEWAL.
include_hiddenWhen false (default), exclude dismissed insights and insights still inside an active snooze window from both the insight list and counts. When true, return the full permitted set including hidden rows.
request-list_interest_type_labels_by_code
request-list_interest_type_options
quote_idID of the quote/revision to resolve interest type options for (revision scope)
risk_idID of the risk/property whose revision is used to resolve interest type options (risk scope)
request-list_policy_parties
policy_idsPolicies to collect parties from. Several ids at once are supported (a policy group).
rolesRestrict to these roles. A contact is included when it holds at least one requested role, and its roles list is intersected with the request. Omitted: all party roles.
request-list_policy_type_definitions
request-list_policy_types
effective_dateThe effective date of the policy type
effective_date_idThe effective date ID of the policy type
location_idThe location ID of the policy type
external_system_referenceExternal ID of the policy type
request-list_quick_code_values
A single quick code or a list of quick codes to list values for. When definition_code is provided, exactly one quick code is required.
active_onlyWhen true, only globally-active values are returned. Ignored when definition_code is provided: the definition decides for itself, and one with its own list keeps returning a value that has since been retired globally.
definition_codeOptional policy type definition code. When provided, only the values enabled for that definition are returned; if the definition has no overrides, all globally-active values are returned. Requires exactly one quick code.
request-list_quick_quote_templates
request-list_rating_grids
pagepage_sizesort_orderstatusrequest-list_report_permissions
report_idUUID of the report whose ACL rows to return.
api_keyAPI key for external / programmatic clients.
request-list_rules
policy_type_idUUID of the policy type to list rules for
request-list_rules_stp_results
revision_idUUID of the revision to get STP results for
pagePage number for pagination (default: 1)
page_sizeNumber of executions per page, max 100 (default: 25)
request-list_scopes
request-list_stp_results
revision_idRevision ID to retrieve STP results for
pagePage number for pagination
page_sizeNumber of items per page
request-list_subjectivities
revision_idID of the revision to retrieve subjectivities from
external_system_referenceReference to the revision in an external system
request-list_subjectivity_definitions
Decision Table
| Variant | Matching Criteria |
|---|---|
| No specific criteria | |
| No specific criteria |
activeFilter subjectivity definitions by active status
request-list_watercrafts_for_quote
quote_idThe ID of the quote to list watercrafts for
request-make_multi_exposure_payment
Schema for ClaimMultiExposurePaymentModel (multi-exposure payment)
request-make_note
integration_instance_external_idExternal ID of the integration instance creating the note.
reference_idReference ID to associate the note with (e.g., policy number, claim ID).
titleTitle of the note. Will be prefixed with the integration instance name.
contentsContent/body of the note.
request-make_payment_by_contact_and_payment_method
payment_method_idBritecore Payment Method ID
payment_amountPayment Amount: min/max/next_term or Explicit Amount to Pay
contact_idContact ID
policy_idPolicy ID
payor_namePayor name: contact name of the person who initiated payment for the policy(optional)
payor_emailPayor email: contact email of the person who initiated payment for the policy(optional). When present and valid, the standard payment confirmation is auto-emailed to it; when absent or invalid, no confirmation email is sent.
bypass_cannotpay_guardSkip the payability guard and accept the payment on a policy the carrier's configuration would otherwise refuse -- a pending non-pay cancellation flagged Poor Payment History, an expired or rejected policy, one canceled past its payment window (BC-24420). For internal callers acting on behalf of staff, who may take a payment the insured cannot make themselves: the life-cycle options behind the refusal are scoped to external payments. Must be a real boolean: a non-boolean is rejected with error_code invalid_parameter rather than coerced, so a stringy "false" cannot be read as an enabled bypass. Omit it, or send false, on any insured-facing channel.
request-mark_failed
api_keyAPI key for the internal-integrations caller (consumed by the gateway for authentication).
integration_instance_external_idExternal ID of the caller's ACH_ISSUANCE integration instance.
disbursement_attempt_idThe disbursement_attempts row to transition.
failure_originWhy the disbursement failed. vendor_rejected / recipient_returned / cancel_acknowledged drive the terminal transition. admin_terminate is a RECOGNIZED but operator-only value: the endpoint accepts it and returns a policy rejection (HTTP 200, success=true, data.accepted=false, rejection_reason=incompatible_current_state) rather than treating it as malformed input. Any value outside this enum is a malformed request (success=false).
failure_codeMachine-readable failure code (e.g. an ACH/vendor code).
failure_reasonHuman-readable failure detail.
ach_return_codeOptional NACHA ACH return code (e.g. R01).
request-mark_in_transit
api_keyAPI key for the internal-integrations caller (consumed by the gateway for authentication).
integration_instance_external_idExternal ID of the caller's ACH_ISSUANCE integration instance.
disbursement_attempt_idThe disbursement_attempts row to transition.
vendor_reference_idThe IS/vendor handle for the operation (set-once on the row). Normally supplied by the IS, but it may be omitted/blank when the row already has a previously snapshotted vendor reference (e.g. recovered via admin_terminate's get_vendor_reference) -- in that case the existing value carries forward. It is only rejected (missing_vendor_reference) when both the incoming value and the row's stored value are blank.
request-mark_settled
api_keyAPI key for the internal-integrations caller (consumed by the gateway for authentication).
integration_instance_external_idExternal ID of the caller's ACH_ISSUANCE integration instance.
disbursement_attempt_idThe disbursement_attempts row to transition.
request-medical_codes_search
code_system.*\S.* · requiredCode system to search within (e.g. 'ICD10')
terms.*\S.* · requiredLookup term matched against the code prefix or the description (FULLTEXT)
countMaximum number of results to return (1-100, default 10)
request-modify_contact
idnametypeconfirmation_email^[a-zA-Z0-9_.+-]+@[a…date_of_birthdrivers_licenseexternal_system_referencelast_synched_datesource_update_datefein_tax_idlegal_entity_typedate_business_starteddbaadded_bypurchase_datepositionwebsitessn_groupssnagency_inception_dateagency_termination_datefollow_agency_quoting_restrictionusernamegenderdriver_license_datelicense_state^[A-Z]{2}$date_of_deathhicn_numbercompany_idagency_group_numberagency_numberagent_idscommission_structurerequest-modify_effective_date
idThe id of the effective date
effective_dateThe effective date
descriptionThe description of the effective date
forceWhen true, skips all validations during effective date modification
request-modify_full_quote
idQuote ID
external_system_referenceExternal ID of the Quote. Also updates the revision's external system reference.
effective_dateQuote Effective Date. For new business, synced with term_effective_date.
term_effective_dateTerm Effective Date. For new business, takes precedence over effective_date when both are provided.
term_typeTerm Type. Only applied for new business quotes.
expiration_datePolicy Expiration Date. Only applied when term_type is Custom.
renewal_typeRenewal Term Type. Only applied when term_type is Custom.
renewal_statusRenewal status for the policy. Only applied for new business quotes.
agent_idThe UUID of the Agent
agency_idThe UUID of the Agency
commission_rateCommission rate
underlying_policy_idsList of underlying policy IDs to copy data from
request-modify_policy_type
idPolicy Type ID
nameName of the Policy Type
Policy Type Items
Policy Type Sub Lines
external_system_referenceExternal System Reference for the Policy Type
descriptionDescription of the Policy Type
renewal_effective_dateThe renewal effective date for this policy type
underwriting_textUnderwriting text for the Policy Type
application_form_numberApplication Form Number
sort_orderSort order of the Policy Type
allow_multiple_risksWhether multiple risks are allowed
require_credit_scoreWhether credit score is required
credit_score_permission_promptPrompt for credit score permission
term_credit_score_combination_strategyStrategy for combining term credit scores
term_credit_score_fallbackFallback value for term credit score
terms_credit_score_validNumber of policy terms the rated credit score stays locked (0 = always rate on the most recent score)
terms_credit_score_pull_intervalNumber of policy terms that must elapse before ordering a new credit report on the renewal schedule (0 = no scheduled ordering; the global contacts/auto-fetch-credit-score setting can still order a report when an insured is edited)
always_display_wizard_credit_score_buttonWhether to always display the credit score button in the wizard
open_to_quotingWhether the Policy Type is open to quoting
quote_termsAvailable quote terms
Terms and their factors
dec_sectionsDeclaration sections
separate_dec_sectionsWhether to separate declaration sections
system_tagsSystem tags
protection_classProtection class type
limit_thresholdLimit threshold
limit_breach_warningWarning message for limit breach
requires_approvalWhether approval is required
use_rating_v1Whether to use rating v1
trust_risk_premiumsWhether to trust risk premiums
rating_info_titleTitle for rating information
show_optional_builder_items_inlineWhether to show optional builder items inline
skip_insured_quoting_stepWhether to skip the insured quoting step
sequence_idSequence ID
claim_sequence_idClaim sequence ID
allow_risk_valuationWhether to allow risk valuation
maximum_risk_countMaximum number of risks allowed
require_risk_addressWhether risk address is required
require_insured_nameWhether insured name is required
allow_motor_vehicle_reportsWhether to allow motor vehicle reports
britelines_product_nameBriteLines product name
acres_visibilityVisibility setting for acres
legal_description_visibilityVisibility setting for legal description
commission_calculation_item_idCommission calculation item ID
typeType of the policy
months_mvr_validNumber of months MVR is valid
mid_term_quotingWhether mid-term quoting is allowed
billing_schedule_in_ratingWhether billing schedule is included in rating
edelivery_enabledWhether e-delivery is enabled
allow_zero_risksWhether zero risks are allowed
last_synched_dateDate of last synchronization
request-modify_policy_type_item
idID to be set for the Line Item (optional)
nameName of the Line Item
categoryCategory of the Line Item (Policy or Risk)
typeType of the Line Item
requirement_typeRequirement type of the Line Item
external_system_referenceExternal System Reference for the Line Item
descriptionDescription of the Line Item
system_tagsSystem-specific tags associated with the Line Item
has_limitIndicates if the Line Item has a limit
has_rate_or_deductibleIndicates if the Line Item has a rate or deductible
has_loss_payeeIndicates if the Line Item has a loss payee
allow_multiplesIndicates if multiple instances of this Line Item are allowed
premium_fully_billedIndicates if the premium is fully billed
premium_fully_earned_at_inceptionIndicates if the premium is fully earned at inception
premium_added_to_other_itemIndicates if the premium is added to another item
disallow_submit_boundIndicates if submitting bound is disallowed
display_on_dec_asHow the item should be displayed on declaration
dec_font_sizeFont size for declaration
dec_font_boldIndicates if the font should be bold in declaration
dec_font_italicIndicates if the font should be italic in declaration
dec_aliasesAliases for declarations display
do_not_display_in_dec_rating_informationIndicates if the item should not be displayed in declaration rating information
do_not_display_in_dec_when_zero_premiumIndicates if the item should not be displayed in declaration when premium is zero
display_in_dec_as_incl_when_zero_premiumIndicates if the item should be displayed as included in declaration when premium is zero
show_limit_and_premium_on_decIndicates if limit and premium should be shown on declaration
dividend_factorDividend factor for the Line Item
show_in_builderSpecifies where the item should be shown in the builder
hide_in_britequoteIndicates if the item should be hidden in BriteQuote
limit_availabilitySpecifies the limit availability for the Line Item
loss_exposureIndicates if the item represents a loss exposure
loss_free_creditDetails about loss-free credit
no_commission_paid_on_line_itemIndicates if no commission is paid on this Line Item
override_limitIndicates if the limit can be overridden
not_applicable_for_agency_billingIndicates if the item is not applicable for agency billing
prevent_from_being_deletedIndicates if the item should be prevented from being deleted
display_user_inputs_above_rate_categoriesIndicates if user inputs should be displayed above rate categories
renewal_amountRenewal amount for the Line Item
default_loss_reserveDefault loss reserve amount
default_adjusting_reserveDefault adjusting reserve amount
default_legal_reserveDefault legal reserve amount
modifies_other_items_on_renewalIndicates if this item modifies other items on renewal
not_rated_by_prorata_and_factorIndicates if the item is not rated by pro-rata and factor
Rate chain for the Line Item
renewal_split_bySpecifies how renewal is split
Zip code factors for renewal
renewal_factor_item_idsLine item IDs whose limit this item inflates at renewal (inflation guard targets)
round_methodRounding method for calculations
round_toSpecifies to what decimal place to round
round_pro_rataIndicates if pro-rata should be rounded
scheduled_itemDetails about scheduled item
skip_persistent_builder_when_added_mandatorilyIndicates if persistent builder should be skipped when added mandatorily
skip_persistent_builder_when_new_category_addedIndicates if persistent builder should be skipped when new category is added
disallow_submit_bound_if_limit_exceedsIndicates if submitting bound should be disallowed if limit exceeds
submit_bound_upper_limitUpper limit for submitting bound
pro_rate_feeIndicates if fee should be pro-rated
sort_orderSort order for the Line Item
claim_coverage_party_typeSpecifies the claim coverage party type
calculate_item_commission_rateIndicates if item commission rate should be calculated
commission_rate_evalCommission rate evaluation
erp_enabledIndicates if Extended Reporting Period (ERP) is enabled for this Line Item
default_erp_duration_daysDefault duration in days for the Extended Reporting Period (ERP)
erp_line_item_idReference to the Line Item used for ERP calculations
request-modify_sub_line
idUnique identifier for the Subline
nameName of the Subline
categoryCategory of the Subline (Policy or Risk)
requirement_typeRequirement type of the Subline
typeType of the Subline
policy_type_idUUID of the parent policy type this subline belongs to
external_system_referenceExternal System Reference for the Line Item
allow_multiplesIndicates if multiple instances of this Subline are allowed
name_edit_allowedIndicates if editing the name of the Subline is allowed
sort_orderSort order for the Subline
descriptionDescription of the Subline
system_tagsSystem tags associated with the Subline
hide_fromSpecifies where the Subline should be hidden from
List of line items associated with this Subline
request-modify_subjectivity
idID of the revision subjectivity
statusStatus of the subjectivity
due_dateDue date for this subjectivity to be met before
assigneeID of the assignee
descriptionDescription of the subjectivity
statementStatement for the subjectivity.
request-modify_subjectivity_definition
idID of the subjectivity to be Modified
nameName for the subjectivity definition
descriptionDescription for the subjectivity definition
policy_type_idID of the associated policy type
mandatorytrue for mandatory and false for non-mandatory. Default is false
activetrue for active and false for inactive. Default is true
due_within_daysDays the subjectivity is due within
due_date_typeType of due date (e.g., 'Post Bind' or 'Post Issue')
statementStatement for the subjectivity definition
request-modify_task
idThe ID of the task to modify.
claim_idAttach an unattached (triage) task to this claim. Attach-only: rejected if the task already has a claim or policy, if policy_id is also supplied, or if the task definition is policy-scoped.
policy_idAttach an unattached (triage) task to this policy. Attach-only: rejected if the task already has a claim or policy, if claim_id is also supplied, or if the task definition is claim-scoped.
descriptionUpdated description of the task.
priorityUpdated priority level of the task.
due_dateUpdated due date for the task (must be greater than or equal to today).
assignee_idThe ID of the user to assign this task to.
statusUpdated status of the task.
mandatoryIndicates if the task is mandatory.
request-modify_task_definition
idThe ID of the task definition to modify.
nameUpdated name of the task definition.
descriptionUpdated description of the task definition.
deletedWhether to soft delete the task definition.
request-modify_task_definitions_assignees
task_definition_idThe ID of the task definition to modify assignments for.
add_role_idsList of role IDs to add to the task definition.
add_user_group_idsList of user group IDs to add to the task definition.
delete_role_idsList of role IDs to remove from the task definition.
delete_user_group_idsList of user group IDs to remove from the task definition.
request-override_screening_check_result
screening_check_result_idID of the screening check result to override
override_reasonReason for the override
request-prefill_property_loss_history
revision_idRevision whose property/properties should have loss history pulled.
property_idsRestrict the pull to specific properties on this revision. Ids that don't belong to the revision are silently skipped. When omitted, all properties on the revision are pulled.
force_runWhen false (default), CLUE's property-level 30-day check applies: a recent report on the property is reused without burning another vendor call. When true, that property-level check is bypassed. Note that CLUE's separate <=30-day VendorCache (keyed on the named insureds) may STILL serve a cached result even with force_run=true, so a fresh vendor order is not guaranteed - inspect the per-property pull_performed flag to know whether an order actually ran. ISOLoss has no equivalent cache; this is a no-op there.
request-prefill_quote
api_keyAPI key for authentication
idQuote ID to prefill
force_runForce ADP execution regardless of existing data. false (default): Only runs if no vehicles exist. true: Always runs and uses match-and-update strategy
request-purge_migration_data
Purge targets to run. A list of target names or a comma-separated string. Defaults to both targets.
policy_type_mappingsMap of execution names to policy type UUIDs, as passed to run_migration. Defines which policy transaction / historical terms files scope the policy purge. Required when targets include "policy".
request-queue_recovery_candidate
candidate_idCandidate identifier to queue for recovery, e.g. 'file:uuid' or 'folder:uuid'.
request-quote
api_keyAPI key for BriteCore authentication
promptThe user's message/question
session_idSession ID for conversation continuity
contextAdditional context information
request-quote_stream
api_keyAPI key for BriteCore authentication
promptThe user's message/question
session_idSession ID for conversation continuity
contextAdditional context information
request-rate
quote_idThe unique identifier (UUID) of the quote revision to rate. Per the quotes v2 API convention this is the revision id.
request-rate_full_quote
idThe quote ID to bind
external_system_referenceReference to the quote in an external system
debugWhether to enable debug mode or not
request-reconcile_insights
reference_typeType of resource under reconciliation
reference_idUUID of the claim or policy under reconciliation
keepInsight IDs to retain (bumps last_evaluated_at)
Per-row partial updates (title, description, product_area, selector only)
removeInsight IDs to delete
New insights to insert (reference_type and reference_id taken from parent envelope)
request-record_saved_method_authorization
contact_idUUID of the policyholder the payment method is being stored for.
authorization_confirmedThe affirmative attestation captured by the consent UI. Proof is recorded only when this is a strict boolean true; a truthy-but-non-affirmative value is rejected.
request-regenerate_statements
yearFour-digit calendar year of the report month (e.g. 2026). Must be supplied together with month.
monthCalendar month of the report month, 1-12. Must be supplied together with year.
request-reinstate_policy
policy_idThe UUID of the policy to reinstate
policy_term_idThe UUID of the policy term to reinstate. Optional: the service falls back to the term on the resolved revision, which is correct for a single-term policy and ambiguous otherwise.
revision_idThe UUID of the revision to reinstate from. Optional: the service resolves the cancelling revision when omitted.
reinstatement_date^\d{4}-\d{2}-\d{2}$Effective date of the reinstatement in YYYY-MM-DD format. Required when lapse is true.
reinstate_reasonThe UUID of a configured reinstatement reason, recorded as the policy status reason
assess_feeWhich reinstatement fee to assess. Mirrors REINSTATEMENT_FEE_TYPES, which the request schema validates with OneOf. Omit to let the policy life cycle decide; sending a value overrides it.
custom_reinstatement_feeOverrides the configured fee amount. Decimal sent as a string to avoid float rounding.
lapseReinstate on a date AFTER the cancel date, leaving a gap in coverage. The service computes and books the gap-credit premium for the uncovered window. Requires reinstatement_date.
propagateWhether legacy accounting recursively reinstates future terms. The billing engine sets this false so cross-term reinstatement is represented by explicit engine events and audit rows.
create_notice_deliverableExpired path only, and therefore inert on this endpoint, which cannot reach expired policies. The Notice of Reinstatement on the Cancelled path is gated on the policy life cycle's send_notice_on_reinstatement, not on this flag.
push_invoice_datesExpired path only, and therefore inert on this endpoint. Pushes out due and cancel dates on renewal invoices.
date_cursorProcessing date-time. Omit to use now.
request-remove_contact_from_role
role_nameThe name of the role to add the contact to
contact_idThe unique identifier of the contact
request-remove_form_from_policy_type
form_idThe x_policy_types_docs row's own id (NOT File.id). The row and stored file are kept for audit purposes; only File.active is set to false.
request-remove_form_from_policy_type_item
form_idThe x_policy_type_items_docs row's own id (NOT File.id). The row and stored file are kept for audit purposes; only File.active is set to false.
request-remove_policy_contact
policy_idThe policy ID to remove the contact from
contact_idThe contact ID to remove from the policy
roleThe role of the contact in the policy
request-remove_policy_type_relations
policy_type_idThe ID of the policy type
relationship_typeThe type of relationships to remove
request-remove_quote_contact
quote_idThe quote ID to remove the contact from
contact_idThe contact ID to remove from the quote
roleThe role of the contact in the quote
request-remove_risk_contact
risk_idThe risk ID to remove the contact from
contact_idThe contact ID to remove from the risk
roleThe role of the contact in the risk
request-reports_export_report
report_idThe id of the report to export
request-reports_import_report
The report definition to import (same shape produced by /api/v2/reports/export_report). Any id / sheet id carried in the payload is ignored: an import always creates a new report and fails if the name already exists.
file_dataAlternative to report_data: the JSON text of an exported report file (or base64 of it), following the file_data convention used by /api/v2/lines/import_line. Takes precedence over report_data.
request-request_claim_estimation
claim_idClaim ID
assignment_typeType of assignment
request-request_claims_search
claim_idUUID of the claim to search
request-resolve_property_geolocation
The property and the address to resolve. Accepts the same shape as update_property_location: 'id' selects the property, and every other recognised key is compared against the stored value and written only when it differs. A key left out is left alone; an empty value clears the column. Unrecognised keys are ignored rather than rejected.
context_identifierReported to integration logging. Usually the policy number.
request-retrieve_adjuster_licenses
contact_idUUID of the contact whose adjuster licenses to retrieve
request-retrieve_claim_payments
transaction_date_from^\d{4}-\d{2}-\d{2} \… · requiredThe start date for the transaction date range. The date should be in the format 'YYYY-mm-dd HH:MM:SS'.
transaction_date_to^\d{4}-\d{2}-\d{2} \… · requiredThe end date for the transaction date range. The date should be in the format 'YYYY-mm-dd HH:MM:SS'.
policy_type_idsList of policy type ids to filter the claim payments. The function will return only the claim payments that have a policy type id in this list.
exportedIf provided, the function will return only the claim payments that have the exported flag set to this value.
voidedIf provided, the function will return only the claim payments that have the voided flag set to this value.
historicalIf provided, the function will return only the claim payments that have the historical flag set to this value.
request-retrieve_common_allowed_assignees
task_definition_idsThe task definitions to intersect. Only contacts allowed by every one of them are returned.
limitMaximum number of assignees to return. Omit for no cap.
searchFilters the assignees by name or id (substring match).
assigned_role_idRole the selection is pinned to. Narrows the result on top of the task definitions, when it is one they are configured with.
assigned_user_group_idUser group the selection is pinned to. Narrows the result on top of the task definitions, when it is one they are configured with.
request-retrieve_config
location_idBusiness-location UUID for a per-state scope. Omit or pass null for the carrier-wide global default.
request-retrieve_contact
idThe unique identifier of the contact
external_system_referenceThe external identifier of the contact
request-retrieve_convenience_fee
account_typeThe type of the account being charged. For PaymentProcessor integration: 'ACH', 'CC', or 'DEBIT'. For legacy vendors: 'ACH', 'MasterCard', 'VISA', 'AmericanExpress', 'Discover'
policy_idPolicy ID (Optional)
request-retrieve_convenience_fee_preview
payment_methodsList of payment methods to calculate fees for. If not provided, defaults to all payment methods (ach, cc, debit)
policy_idPolicy ID (optional)
request-retrieve_full_quote
idQuote ID
external_system_referenceExternal ID of the Quote
request-retrieve_my_permissions
request-retrieve_my_roles
request-retrieve_payment
payment_idrequest-retrieve_payment_method_creation_details
contact_idContact ID for which to retrieve payment method creation details.
typesOptional list of payment method types to include in the creation details.
policy_idsOptional list of policy IDs to associate with the payment method.
success_urlOptional URL to redirect to after successful payment method creation.
cancel_urlOptional URL to redirect to if payment method creation is cancelled.
requester_contact_idOptional contact ID of the requester. If not provided, defaults to the currently logged-in user.
request-retrieve_payment_methods
contact_idsRequired. List of contact IDs to filter payment methods by.
exp_less_thanOptional. Filter all payment methods where expiration date is less than or equal to (current date + exp_less_than days). If not provided, all active payment methods are returned.
min_updated_onOptional. Filter payment methods created after the given date in ISO 8601 format (e.g. 2025-01-01T00:00:00Z).
request-retrieve_pending_payments_for_settlement
integration_instance_external_idExternal ID of the integration instance. Only pending payments owned by this instance are returned.
request-retrieve_permissions
prefixesList of filtering prefixes for permissions list.
request-retrieve_policy_billing_information
policy_idID of the Policy
policy_term_idID of the Policy Term
billing_onlyFlag to indicate that the response should only include billingSetup information.
request-retrieve_policy_change_logs
api_keyAPI key for authentication
filter_byThe date field to filter by. 'date_stamp' - The date the change was made (in CST timezone). Supports time-based filtering if 'allow_timestamp' is set to True. 'date_cursor' - The calculated date in effect upon revision commit. Does not support time-based filtering. 'revision_commit_date_time' - The date and time when the revision was committed. Supports time-based filtering if 'allow_timestamp' is set to True.
from_dateThe start date of the search. If allow_timestamp is True and filter_by is 'date_stamp' or 'revision_commit_date_time', format is 'YYYY-mm-dd HH:MM:SS'. Otherwise, format is 'YYYY-mm-dd'.
to_dateThe end date of the search. If allow_timestamp is True and filter_by is 'date_stamp' or 'revision_commit_date_time', format is 'YYYY-mm-dd HH:MM:SS'. Otherwise, format is 'YYYY-mm-dd'.
allow_timestampIf True and 'filter_by' is set to 'date_stamp' or 'revision_commit_date_time', the 'from_date' and 'to_date' arguments will be treated as datetime with format 'YYYY-mm-dd HH:MM:SS'. If False or not provided, or if 'filter_by' is 'date_cursor', the 'from_date' and 'to_date' arguments will be treated as date with format 'YYYY-mm-dd'.
transactionsLimit the search to the specified transactions
policy_type_idsLimit the search to the specified policy types
revision_idsLimit the search to the specified revisions
policy_idsLimit the search to the specified policies
request-retrieve_policy_snapshot
policy_numberThe policy number to retrieve snapshot information for
dateThe date for which to retrieve the policy snapshot (YYYY-MM-DD)
request-retrieve_policy_type_claims_tabs_visibility
policy_type_idPolicy Type ID for retrieving claims tabs visibility
request-retrieve_policy_types
effective_date_idIf provided, scopes the result to policy types belonging to this single effective date
date_cursorIf provided, resolves policy types the way quoting does: the governing effective date for this date, including policy types inherited from an earlier effective date that did not redefine them (gaps, BC-14373). Takes precedence over effective_date_id if both are sent.
request-retrieve_queue_capabilities
request-retrieve_rating_table
idRating Table ID
pageNumber of page of the pagination for the grid point factors
page_sizePage size of the pagination for the grid point factors
sort_byGrid point column to sort by
sort_orderrequest-retrieve_recovery_statuses
job_idsList of BackgroundJob IDs to retrieve recovery status for.
request-retrieve_revision_billing_schedule_context
policy_idID of the policy whose term is inspected.
revision_idOptional. ID of the revision being edited in the Builder. When supplied, the gating signals are computed from this revision's own policy term rather than the policy's in-force term, so the dialog stays suppressed on a manual renewal (whose revision lives on a new term with no committed revisions). Omitted -> the policy's current term is used.
request-retrieve_risk_details
risk_idThe UUID of an existing risk/property
request-retrieve_saved_method_authorization
request-retrieve_settings
sectionOptional section name. When provided, only that section is returned; otherwise every section is returned.
request-retrieve_subjectivity
idID of the subjectivity to retrieve
request-retrieve_subjectivity_definition
idID of the subjectivity definition to be retrieved
request-retrieve_subjectivity_provenance
idThe id of the revision subjectivity whose rule-execution lineage to retrieve.
request-retrieve_task
idThe id of the task to retrieve.
request-retrieve_task_definition
idThe id of the task definition to retrieve.
request-retrieve_task_definition_allowed_assignees
task_definition_idThe id of the task definition to retrieve allowed assignees for.
limitMaximum number of assignees to return. Omit for no cap.
searchFilters the assignees by name or id (substring match).
assigned_role_idNarrows the result to this role, when it is one the task definition is configured with.
assigned_user_group_idNarrows the result to this user group, when it is one the task definition is configured with.
request-retrieve_task_definitions_assignees
task_definition_idOptional task definition ID to filter by. If not provided, returns all assignments.
request-retrieve_task_documents
idThe id of the task whose linked record's documents to retrieve.
request-retrieve_task_filter_options
viewView type to scope the assignee options
include_uw_optionsWhen true, the response also populates the underwriting dropdown options (transaction_types, lobs, stages). Callers that do not render those dropdowns should omit this to skip the extra queries.
task_scopesThe same scope the caller's retrieve_tasks request carries, so a dropdown cannot offer a value that selects an empty queue -- an assignee who holds only claim work, or a line of business reached only through it. Omitted means both scopes. Distinct from include_uw_options, which decides whether the expensive LOB / stage aggregates run at all: that flag is about COST, this one is about WHICH ROWS. See retrieve_tasks for the scope rule itself. An empty list is rejected.
request-retrieve_task_history
idThe id of the task to retrieve history.
request-retrieve_task_notes
idThe id of the task whose notes are returned.
request-retrieve_task_provenance
idThe id of the task whose rule-execution lineage to retrieve.
request-retrieve_tasks
querySearch query for tasks. Matches task fields, claim number, policy number (including claim-attached tasks reached through the claim's policy), and named insureds.
viewNamed view applying server-side scoping. submissions = policy tasks whose latest revision is in submission; triage = open, unassigned tasks.
include_filter_countsWhen true, the response includes filter_counts (status quick-filter bucket totals over the full filtered set).
include_view_countsWhen true, the response includes view_counts: totals for the my_tasks / all_tasks / submissions / triage views in one aggregate, unfiltered by every queue control (including filters.bucket) so the tab numbers stay put as filters change.
include_bucket_countsWhen true, the response includes bucket_counts (per-lifecycle-bucket totals over the filtered set, computed before filters.bucket narrows it, so every bucket tab shows its own total). Only callers that render the admin bucket tabs request them.
group_byWhen set to 'policy', pagination counts whole policy groups instead of task rows: pagination.page/page_size select groups (unattached tasks form one bucket, sorted first; then overdue count desc, top priority desc), the response returns every task belonging to the page's groups (a policy's tasks never split across pages), and pagination carries total_groups. total_count still reports the task total. sorting orders the tasks WITHIN each group and does not reorder the groups, whose rank is an aggregate over their tasks; insured, agency and lob hold one value per group, so the queue offers only task-level keys in this mode.
suggestLightweight typeahead mode: returns only the LIMITed rows for the query, skipping the aggregate COUNT over the search predicate and the transaction-type enrichment. The response omits pagination in this mode.
task_scopesWhether to return CLAIM work, POLICY work, or both. Omitted (the default) means both, so existing callers are unaffected. The Underwriting Workbench sends ["policy"]; claim work belongs to the Claims module's own task tab. An explicit list rather than something derived from view, because my_tasks / my_team / all_tasks are shared with the legacy Tasks Workbench, which lists every task on the site. THE RULE: the attachment decides when there is one, and the task's definition decides when there is not. policy = claimId IS NULL AND (policyId IS NOT NULL OR the task's definition is policy-scoped); claim is its exact complement. The two partition the table, so any subset selects a well-defined set of rows, and a task carrying BOTH columns is claim. Why the attachment wins where both could speak: task_definitions.scope was added NOT NULL DEFAULT 'claim' and backfilled every pre-existing definition, so a policy-attached task whose definition says 'claim' is ordinary legacy data and is still policy work. Why the definition decides an UNATTACHED task: it is binding, not advisory -- modify_task refuses to attach a claim-scoped task to a policy, so an unattached claim-scoped task can only ever become a claim task. The scope applies to the rows, to filter_counts / bucket_counts / view_counts and to group_by, so every number describes the rows returned. retrieve_task, modify_task and bulk_modify_tasks are unaffected and still serve both. An empty list is rejected.
Filter criteria for tasks
Pagination parameters
Sorting parameters, applied server-side over the whole filtered set rather than the returned page. Nullable keys place missing values last regardless of direction; task number is the final tiebreaker, so paging cannot repeat or skip a row. An unrecognised sort_by leaves only that tiebreaker.
request-retrieve_team_workload
request-retrieve_underwriting_calendar
month^[0-9]{4}-[0-9]{2}$The month to report, as YYYY-MM. Defaults to the current month when omitted. Rejected beyond five years either side of today.
request-retrieve_underwriting_dashboard
request-retrieve_underwriting_dashboard_panels
request-retrieve_underwriting_team_performance
request-review_revision
revision_idRevision ID to run STP against
request-revoke_report_permission
report_idUUID of the report.
grantee_typeKind of grantee whose row to remove.
grantee_idIdentifier of the grantee matching the row to revoke.
api_keyAPI key for external / programmatic clients.
request-revoke_screening_override
screening_check_result_idID of the screening check result to revoke override from
request-rewrite_policy
rewritten_revision_external_system_referenceThe external system reference of the revision of the rewritten policy
policy_number_optionThe option to use for the policy number of the policy to be rewritten
effective_dateThe effective date of the policy to be rewritten
revision_idThe revision ID of the policy to be rewritten
revision_external_system_referenceThe external system reference of the revision of the policy to be rewritten
policy_numberThe policy number of the policy to be rewritten
rewritten_policy_numberThe policy number of the rewritten policy
termThe term of the policy to be rewritten
reasonThe reason for rewriting the policy
reason_idThe ID of the reason for rewriting the policy
expiration_dateThe expiration date of the policy to be rewritten
at_renewal_set_policy_term_toThe term to be set to the policy at renewal
request-run_migration
policy_type_mappingsMap of execution names to policy type UUIDs
disable_rulesMap of execution names to semicolon-separated rule IDs to disable
Runtime filters to control which migration scripts execute
dry_runIf true, validates configuration without executing
request-run_pre_rate_integrations
quote_idThe unique identifier (UUID) of the quote revision to run the integrations for. Per the quotes v2 API convention this is the revision id.
request-run_property_lookup
property_idUUID of the Property to look up. Required.
integration_instance_idUUID of the IntegrationInstance to run. Required when headless is omitted or false. Ignored when headless is true or a PropertyLookupOptions string.
When true, run every PROPERTY_LOOKUP instance on the property's policy type (integration_instance_id is not required). When a string, run only instances whose property-lookup-options setting includes that option. Quote Wizard property-details save sends runWhenQWUserSavesPropertyDetails.
Optional rating values to persist on the property before the vendor call. Each entry is a category or a user-input label.
request-run_rules
quote_idUUID of the quote/revision to run rules for
property_idOptional UUID of a specific property to run rules for. If not provided, runs for all properties.
Optional UI context data for running UI-specific rules. When provided, runs UI rules instead of quoting rules.
request-save_definition_quick_code_value_toggle
definition_codePolicy type definition code the toggle applies to
quick_codeThe quick code the value belongs to
code_value_typeThe code value type being enabled or disabled for the definition
enabledTrue to enable the value for the definition, false to disable it
request-save_html_template
nameThe name to use when referencing the template. Globally unique. If a template with the same name already exists, it will be updated.
htmlThe HTML string (Jinja template) to be converted into a deliverable.
use_new_html_renderWhether or not to use the new render.py to render the Jinja template.
use_new_pdf_renderWhether or not to use the new render.py to render the PDF deliverable.
enabledWhether the template is enabled or not.
show_as_custom_deliverableWhether the template should be shown as a custom deliverable in the UI.
request-save_remove_value_from_definitions_and_deactivate
quick_codeThe quick code the value belongs to
code_value_typeThe code value type to strip from every policy type definition and then deactivate globally
request-save_reset_definition_quick_code_values
definition_codePolicy type definition code whose overrides are cleared so it inherits the global values again
quick_codeThe quick code the reset is scoped to; other quick codes on the same definition are untouched
request-search_names_emails
querySearch query for email addresses or usernames. Must be at least 2 characters long.
limitMaximum number of results to return
request-search_recovery_candidates
start_dateStart of the print-date range to scan for broken deliverables.
end_dateEnd of the print-date range to scan for broken deliverables.
include_empty_s3_file_contentInclude files whose S3 object has zero bytes.
include_zero_sized_file_recordInclude files whose DB size field is 0.
include_mismatched_size_recordInclude files where the DB size does not match the S3 content length.
include_empty_folderInclude deliverable folders that contain no child files.
request-select_my_role
role_idExact role identifier returned by retrieve_my_roles.
request-send_payment_receipt_email
payment_idUUID of the payment
policy_numberPolicy number; must belong to the payment. Does not select the attached document -- multi-policy payments email the group confirmation
recipient_emailRecipient email address (from UI dropdown or free-form entry)
subjectOptional email subject; defaults to a standard receipt subject if omitted
bodyOptional email body; defaults to a standard message if omitted
request-set_binder_to_active
revision_idThe revision ID to bind
external_system_referenceReference to the revision in an external system. If provided, and multiple revisions are found, the latest non archived revision will be used.
request-set_html_templates_locations
successIndicates if the request was successful
request-simulate_rule
Full rule definition (same structure as create_rule/update_rule)
quote_idUUID of the revision to simulate the rule against. Required for every rule category except 'claim'.
claim_idUUID of the claim to simulate the rule against. Required when the rule's category is 'claim'; ignored otherwise. The rule is simulated once against the whole claim: triggers are evaluated for the claim itself, and each effect is previewed against every exposure whose coverage type the effect targets. The policy revision comes from the claim, falling back to an exposure's coverage when the claim carries none.
property_idOptional UUID of a specific risk/property to scope the simulation. Ignored for UI-scoped rule categories (vehicle-ui, driver-ui, watercraft-ui) and for claim-scoped rules.
ui_contextOptional override for UI-scoped rule categories (vehicle-ui, driver-ui, watercraft-ui). When omitted, the simulation fans out across every matching risk on the revision: vehicles for vehicle-ui, drivers for driver-ui, watercrafts for watercraft-ui. Pass an explicit context to scope the simulation to a single risk or to inject custom field values. Same shape as the production run_quoting_ui_rules payload -- must contain at least one of: 'driver', 'drivers', 'vehicle', 'vehicles', 'watercraft', 'watercrafts'.
request-sort_calculated_field
field_idID of the field to move
new_orderNew 0-based index position
request-store_claims_search
Wrapper object added by Tray.io containing the actual response data
request-store_config
location_idBusiness-location UUID for a per-state scope. Omit or pass null for the carrier-wide global default.
Snake_case logical-key dict. Missing keys leave the existing column untouched. For the text columns, an empty string clears the column to NULL = a blank override at this scope ($0 fee / blank copy), NOT inherit; re-inherit only via delete_config. disclosure_style is the exception (a blank falls through to the broader tier).
request-store_contact_legal_entity_type
contact_idThe unique identifier of the contact whose Legal Entity Type is being set.
legal_entity_typeLegal Entity Type value to set. A literal empty string clears the field. Null/omitted, non-string, and whitespace-only values are rejected. Surrounding whitespace on a real value is trimmed.
request-store_payment
integration_instance_external_idExternal ID of the integration instance.
policy_numbersList of policy numbers associated with the payment.
transaction_amount_in_centsAmount of the transaction in cents.
convenience_fee_in_centsConvenience fee charged for the transaction in cents.
pay_byMethod of payment.
account_nameName associated with the payment account.
masked_numberMasked account number for security.
transaction_date_timeDate and time when the transaction occurred.
vendor_messageMessage from the payment vendor.
reference_idUnique reference ID for the transaction.
vendor_responseRaw response from the payment vendor.
vendor_processing_fee_in_centsOptional processing fee charged by the vendor in cents.
payor_nameName of the payor from payment gateway billing details (e.g., Stripe).
payor_emailEmail address of the payor from payment gateway billing details (e.g., Stripe).
britecore_confirmation_numberOptional. BriteCore confirmation (receipt) number minted up front by request_payment_entry and echoed back here so the stored Payment's confirmation number matches the value attached to the Stripe PaymentIntent metadata (BC-22803). When omitted, BriteCore generates one at store time. Capped at 32 chars to match the payments.confirmationNumber VARCHAR(32) column.
requester_contact_idOptional. Contact id of the BriteCore user who originated the payment, derived from the authenticated user by request_payment_entry and echoed back via the Stripe PaymentIntent metadata. When provided, the "Payment Received" policy note is attributed to that user instead of the integration service account (srv_integrations). See BC-19725.
request-store_payment_nsf
payment_idUUID of the payment to mark as NSF.
policy_idUUID of the policy that the payment belongs to.
assess_feeWhen to assess NSF fee. 'now' = immediately, 'next' = on next invoice, 'waive' = no fee.
allow_cancelWhether to allow policy cancellation. Must be false if postpone_until_date is provided.
postpone_until_dateDate to postpone outstanding invoices. Accepts various date formats (YYYY-MM-DD recommended).
policy_term_idUUID of the policy term. Required if policy_term_external_system_reference is not provided.
policy_term_external_system_referenceExternal system reference for the policy term. Required if policy_term_id is not provided.
request-sync_underlying_policy_changes
revision_idThe UUID of the current umbrella revision
request-terms_accept
keyIdentifier of the terms document, validated against the in-repo registry (core.terms_of_service). An unknown value is rejected.
versionThe version the caller actually displayed, as returned by /api/v2/terms/status. Always required. While the site shows the notice it must equal the currently registered version: sending the key alone would let a notice edit between page render and submit produce an audit row claiming the user accepted text they never saw, and a mismatch is rejected with a version field error so the client can reload and show the current notice. On a site where reports.enable-sql-editor-terms is off the notice is not in force, so nothing is recorded and a stale value is tolerated rather than rejected.
api_keyAPI key for authentication
request-terms_status
keyIdentifier of the terms document, validated against the in-repo registry (core.terms_of_service). An unknown value is rejected.
api_keyAPI key for authentication
request-test_expression
expressionRestrictedPython expression to evaluate
pathPath context (e.g. '' for root, 'drivers' for arrays)
contextTemplate context data to evaluate the expression against
request-trigger_scheduled_claims_research
integration_instance_idExternal ID of the integration instance (as known by Tray.io)
research_interval_daysMinimum days since last successful search
request-unassign_business_location
location_idBusiness location identifier
request-unassign_policy_type_definition
location_idBusiness location identifier
policy_type_definition_idPolicy type definition identifier
request-update_additional_interest
request-update_additional_interest_associations
idID of an existing x_properties_contacts record for this AI
risk_idsComplete desired set of risk IDs for this contact+interest. Risks present in the current set but absent here will be removed.
request-update_adjuster_assignment_config
request-update_adjuster_license
License update data object
request-update_billing_schedule
policy_idID of the policy to update
billing_scheduleID of the billing schedule to apply
policy_term_idOptional ID of the specific policy term to update. If not provided, the current term will be used.
request-update_brand
idThe unique identifier of the brand
nameBrand name
logo_file_idFile ID for the brand logo
signature_file_idFile ID for the brand signature
header_line_1Header line 1
header_line_2Header line 2
header_line_3Header line 3
header_line_4Header line 4
activeWhether the brand is active
request-update_calculated_field
idID of the field to update
field_name^[a-zA-Z_][a-zA-Z0-9…New field name
expressionNew expression
pathNew path
descriptionNew description
request-update_carbone_custom_deliverable
idThe ID of the deliverable to update.
location_idpolicy_type_namecustom_nameThe deliverable name.
overwrite_stockcarbone_template_idsource_file_namedraft_carbone_template_iddraft_source_file_namelast_preview_entity_numberprint_on_initial_decprint_on_renewal_decprint_on_non_autopayallow_britequote_creationmodulegenerated_peruse_dynamic_fieldsOptional list of dynamic fields to create/update on this template. Validated (and, for a dropdown field, its option_source-specific requirements) before any mutation - including deleted_dynamic_field_ids' deletions - is applied.
deleted_dynamic_field_idsOptional list of dynamic field IDs to delete.
request-update_claim_estimation
request-update_copilot_skill
idUUID of the skill to update
nameNew display name
descriptionNew short summary
bodyNew markdown instruction body
statusNew lifecycle status
applicable_copilotsNew copilot identifiers list. Empty means all copilots.
request-update_custom_error_code
The custom error code to update
request-update_dispute
A claim Dispute, including litigation details, settlements, and dates.
request-update_exported_check_details
Batch of partial updates for already-exported outbound checks. Mixed payment types are allowed. Duplicate ids are rejected. Omitted fields are left alone; explicit null is treated as omit. Replacing an already-set check_number, check_date, or cleared_date requires force_update on that record. Voided, canceled, rejected, or transferred return premiums, voided claim payments, claim recoveries, untyped claims, and electronic, net, or negative commissions are rejected.
request-update_exposure
Exposure update fields
api_keyAPI key for authentication
request-update_form_on_policy_type
form_idThe x_policy_types_docs row's own id (NOT File.id) - see the 'form_id' field returned by list_forms_for_policy_type / attach_form_to_policy_type's metadata.
titleNew file name for the File record. Left unchanged when omitted. Null is accepted and also leaves it unchanged.
metadataPrint-flag metadata. PARTIAL update (merge, not replace): only the keys present in the request are written, and every field omitted here keeps its stored value. To clear a field, send it explicitly - null for form_code/edition_number/description/mortgagee_types, false for the flags - which is honored, not silently ignored. Omitting this object entirely, or sending {}, leaves the metadata row untouched.
request-update_form_on_policy_type_item
form_idThe x_policy_type_items_docs row's own id (NOT File.id).
titleNew file name for the File record. Left unchanged when omitted. Null is accepted and also leaves it unchanged.
metadataPrint-flag metadata. PARTIAL update (merge, not replace): only the keys present in the request are written, and every field omitted here keeps its stored value. To clear a field, send it explicitly - null for form_code/edition_number/description/conditional_values/mortgagee_types/ntp_start_date/ntp_end_date, false for the flags, "gt" for conditional_premium_select - which is honored, not silently ignored. Omitting this object entirely, or sending {}, leaves the metadata row untouched.
request-update_insight
idUUID of the insight to update
titleShort headline
descriptionAdjuster-readable narrative
product_areaProduct-area placement; null clears placement (reference-wide). Valid values depend on the insight's reference_type. CLAIM: INFORMATION, PARTIES, VEHICLES, DAMAGED_PROPERTIES, INJURIES, ESTIMATIONS, ACCOUNTING, DISPUTES, NOTES, ATTACHMENTS. POLICY: INFORMATION, UNDERWRITING, SUBJECTIVITIES, CONTACTS, PROPERTY, VEHICLES, DRIVERS, COVERAGES, RATING, NOTES, ATTACHMENTS, RENEWAL.
selectorOptional card-level deep-link within product_area. Requires a non-null product_area. CLAIM selectors are per product area (e.g. INFORMATION: CLAIM_INFORMATION, POLICY_INFORMATION, ADDITIONAL_INFORMATION, CLAIM_ASSIGNMENTS, CLAIMS_HISTORY, LOSS_ADDRESS, CATASTROPHE, REINSURANCE_CONTRACTS, DATES, REPORTS, PHOTOS; ACCOUNTING: ACCOUNTING_OVERVIEW, RECOVERIES, EXPOSURE_INFORMATION; PARTIES: PARTIES_LIST; VEHICLES: VEHICLES_LIST; DAMAGED_PROPERTIES: DAMAGED_PROPERTIES_LIST; INJURIES: INJURIES_LIST; ESTIMATIONS: ESTIMATIONS_LIST; DISPUTES: DISPUTES_LIST, LITIGATION_DETAILS; NOTES: NOTES_LIST; ATTACHMENTS: ATTACHMENTS_LIST). POLICY selectors are per product area (INFORMATION: EFFECTIVE_DATES, POLICY_STATUS, REVISION, PREMIUM_TOTALS; UNDERWRITING: STP_STATUS, UW_RULES, UW_QUESTIONS, UW_CONTACT; SUBJECTIVITIES: SUBJECTIVITIES_LIST, ESIGNATURE; CONTACTS: NAMED_INSURED, ADDITIONAL_INTERESTS, AGENT, PREMIUM_FINANCE, SURPLUS_LINE_PRODUCER, CONTACTS_SECTION; PROPERTY: PROPERTIES_LIST; VEHICLES: VEHICLES_LIST; DRIVERS: DRIVERS_LIST; COVERAGES: PRIMARY_EXPOSURES, POLICY_WIDE; RATING: PREMIUM_TOTALS, COMMISSION_RATE, CREDIT_SCORE; NOTES: NOTES_LIST; ATTACHMENTS: ATTACHMENTS_LIST; RENEWAL: RENEWAL_STATUS, POLICY_STATUS).
request-update_payment
The payment object ClaimExposurePaymentModel
request-update_policy_type_claims_tab_visibility
policy_type_idPolicy Type ID for updating claims tab visibility
code_value_typeClaims tab visibility name
flaggedVisibility value
request-update_quick_quote_template
idThe ID of the Quick Quote Template to update
nameThe name of the Quick Quote Template
Quote-wide data containing coverage items
List of template risk default values
policy_type_idsList of policy type IDs to associate with this template
request-update_quote_details
idRevision id. One of id, external_system_reference, or property_id is required.
external_system_referenceCaller-side reference; alternative to id.
property_idProperty id. Derives the revision (via Property.revision_id) and scopes PropertyItem name resolution to this property. RevisionItem (policy-wide) name resolution is unaffected.
Revision-level UW questions, PATCH-merged into the existing list by questionId. Each entry takes questionId or questionText (case-insensitive substring of yes_no_question, scoped to this policy type's effective version) plus yesNoAnswer and optional explanation.
rerateWhen true, the revision is rated synchronously after updates are applied.
run_uw_rulesWhen true, the UW rules engine is run after updates are applied. Useful for callers that want dynamic item mandatoriness recomputed on the new answers.
request-update_rating_table
idID of the existing rating table to update
file_idID of the new uploaded file that will replace the existing rating table data
request-update_revision_billing_schedule
policy_idID of the policy whose current term's revision is being updated.
billing_schedule_idBilling schedule to stage on the revision.
revision_idID of the open (uncommitted) revision to update.
regenerate_installmentsOptional preserve/regenerate choice for already-sent invoices, persisted to revisions.regenerateInstallmentsOnCommit and consumed at commit by build_installments (BC-22886). true = regenerate, false = preserve, omitted/null = no decision recorded (treated as preserve at commit via bool(None) == False). Only meaningful on rating-driven policy types (policy_type.billing_schedule_in_rating = True); on the non-rating branch it is ignored and the column is left NULL.
request-update_rule
idUUID of the rule to update
policy_type_idUUID of the policy type
nameRule name
categoryRule category (policy, property, vehicle, driver, claim, etc.)
moduleModule the rule applies to (all, bc, bq, events, stp)
descriptionRule description
severitySeverity level for STP rules (critical, high, medium, low)
waiver_behaviorWaiver behavior for STP rules (run_always, waived_for_x_terms)
waiver_termsNumber of terms for waiver (when waiver_behavior is waived_for_x_terms)
enabled_for_renewalWhether rule runs on renewals
enabled_for_endorsementWhether rule runs on endorsements
enabled_for_new_businessWhether rule runs on new business
sort_orderRule sort order
valid_from_dateStart date for rule validity (YYYY-MM-DD)
valid_to_dateEnd date for rule validity (YYYY-MM-DD)
properties_affectedWhich properties are affected (null, primary, non-primary)
exception_typeException type (include, exclude)
exception_agenciesList of agency IDs for exceptions
eventEvent type for events module rules
Array of rule triggers. Include id to update existing triggers, omit id for new triggers. Existing triggers not included in this array are automatically soft-deleted.
Array of rule effects. Include id to update existing effects, omit id for new effects. Existing effects not included in this array are automatically soft-deleted.
request-update_selection
revision_idThe ID of the revision to update
selected_optionThe selected credit score option type
request-update_task_definition
idThe ID of the Task Definition to update
nameThe name of the Task Definition
scopeThe scope of the task definition (policy or claim)
descriptionDescription of the task definition
request-update_watercraft
Watercraft definition schema
skip_rulesWhether to skip business rules validation
request-user_has_permission
permissionusernamecognito_usernameaccess_levelrequest-validate_rule
policy_type_idUUID of the policy type this rule belongs to
nameName of the rule
categoryRule category (e.g., 'policy', 'property', 'vehicle', 'driver')
moduleRule module (e.g., 'bc', 'bq', 'stp', 'events')
idUUID of existing rule (optional, for update validation)
severitySeverity level for STP rules (e.g., 'critical', 'high', 'medium', 'low')
descriptionDescription of the rule
enabled_for_new_businessWhether the rule is enabled for new business
enabled_for_renewalWhether the rule is enabled for renewals
enabled_for_endorsementWhether the rule is enabled for endorsements
valid_from_dateStart date for rule validity
valid_to_dateEnd date for rule validity
List of rule triggers
List of rule effects
request-vehicle_in_force_status
vehicle_vinVehicle Identification Number to resolve; matched case/whitespace-insensitively
as_of_dateThe YYYY-MM-DD date coverage is checked for; any in-term date is supported
policy_type_idsOptional hard filter: only these policy types are considered. Omitted/null returns all policy types and the caller filters on policy_type_id.
request-vehicle_prefill_fallback
quote_idThe ID of the quote to determine location and renewal status
vehicle_yearThe year of the vehicle
cost_newThe cost of the vehicle when new (decimal with 2 decimal places)
api_keyAPI key for authentication
request-workflows_publish_workflow
idDraft workflow ID
request-write_off_agency_commissions
agency_idThe ID of the agency to write off all negative entries for
write_off_reasonThe reason for writing off the commissions. 'collected_from_agency' indicates the balance was collected from the agency. 'forgiven' indicates the balance was written off/forgiven.
whyUser-provided description/reason for the write-off. This is stored in the commission_accounting.why field.
response-activate_copilot_skill
successIndicates if the request was successful
Any messages or errors related to the request
response-add_contact_to_role
successresponse-add_recovery
successresponse-add_recovery_reserve
successresponse-add_template_to_policy_type
The created association between template and policy type
successIndicates if the request was successful
response-agents_agent_config
response-agents_agent_create_job
response-agents_agent_delete_session
Delete confirmation payload from the agent service.
response-agents_agent_get_job
dataThe full AIAgentJobModel object when the job is found, or an empty array [] when it is not.
response-agents_agent_resume_job
response-agents_agent_session_messages
response-agents_agent_sessions
Conversation sessions for the logged-in user.
response-agents_agent_status
response-agents_report_copilot_attach_entity
Attach confirmation payload from the AIAgents service.
response-agents_report_copilot_capabilities
Capability flags describing which report agent the site is running.
response-agents_report_copilot_client_error
The metric tags recorded for this error.
response-agents_report_copilot_delete_session
Delete confirmation payload from the agent service.
response-agents_report_copilot_session_messages
response-agents_report_copilot_session_state
response-agents_report_copilot_sessions
Conversation sessions for the logged-in user.
response-approve_pending_payment
successIndicates whether the payment approval was successful.
messagesError messages if the operation failed.
response-archive_copilot_skill
successIndicates if the request was successful
Any messages or errors related to the request
response-assign_business_location
Brand association definition schema
successresponse-assign_policy_contact
successresponse-assign_policy_type_definition
Brand association definition schema
successresponse-assign_quote_contact
successresponse-assign_risk_contact
successresponse-attach_file
successresponse-attach_file_to_brand
successresponse-attach_form_to_policy_type
successresponse-attach_form_to_policy_type_item
successresponse-auth_session
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: success, messages, data | |
| type = object · requires: success, messages | |
| type = object · requires: permissionDenied, success |
successresponse-auto_assign_claim
successresponse-batch_export_payments
successWhether the export request was accepted. False on request validation (bad commission_payment_ids, missing explicit id) or ambiguous routing (more than one active ACH_ISSUANCE instance).
The export result.
response-bifurcate_claim
successresponse-bind_full_quote
successIndicates if the request was successful
response-claims
successmessageserrorError message if request failed
response-bulk_modify_tasks
successresponse-bulk_upsert
successIndicates if the request was successful
response-cancel_claim_estimation
successIndicates if the request was successful
response-cancel_policy_v2
successWhether the operation was successful
response-change_with_remap
successresponse-claims_analytics
successmessageserrorError message if request failed
response-claimsearch_sso_data
acs_urlClaimSearch ACS endpoint URL. The frontend navigates the SSO popup to this URL.
saml_responseBase64-encoded signed SAML Response, if provided by Tray.io
relay_stateRelayState for deep-linking to a match report. Empty string for the ClaimSearch home page.
response-create_additional_interest
successresponse-create_adjuster_assignment_config
response-create_adjuster_license
successWhether the request was successful
messagesAny messages or errors related to the request
response-create_adjustment
The result of the commission adjustment operation
successWhether the operation was successful
response-create_and_rate_endorsement_quote
successIndicates if the request was successful
response-create_and_rate_full_quote
successIndicates if the request was successful
response-create_calculated_field
A calculated field definition for Carbone document templates
successresponse-create_carbone_custom_deliverable
successThe created Carbone deliverable template (CarboneDeliverableModel).
response-create_configuration_import
successTrue if the request was handled
The configuration import record. Nothing has been run against it yet, so its status is null; running belongs to import_configuration.
response-create_contact
successresponse-create_copilot_skill
successIndicates if the request was successful
Any messages or errors related to the request
response-create_dispute
A claim Dispute, including litigation details, settlements, and dates.
successIndicates if the request was successful
response-create_effective_date
Data related to the created effective date
successIndicates if the request was successful
response-create_endorsement_quote
successIndicates if the request was successful
response-create_exposures
successList of created exposure objects
response-create_full_quote
successIndicates if the request was successful
response-create_full_quote_async
Discriminated on 'status': 'success' carries the recovered quote envelope; 'in_progress' carries a null result.
successIndicates if the request was successful
response-create_insight
successIndicates if the request was successful
response-create_line
Created line data
successIndicates if the request was successful
response-create_policy_type
successIndicates if the request was successful
response-create_policy_type_item
successIndicates if the request was successful
response-create_policy_type_relation
successIndicates if the request was successful
response-create_quick_code_value
successWhether the request was successful
The created quick code value
messagesAny messages or errors
response-create_quick_quote_template
The created Quick Quote Template
successIndicates if the request was successful
response-create_quote_extended
successIndicates if the request was successful
messagesAny messages or errors related to the request
response-create_rating_table_definition
successWhether the rating table definition creation was successful
response-create_renewal_quote
successIndicates if the request was successful
response-create_rule
successmessagesresponse-create_sub_line
successIndicates if the request was successful
response-create_subjectivity
Data related to the created subjectivity
successIndicates if the request was successful
response-create_subjectivity_definition
successIndicates if the request was successful
response-create_system_tags
successresponse-create_task
successWhether the task creation was successful
response-create_task_definition
successresponse-create_task_definitions_assignees
List of task definition assignments, aggregated by task definition ID.
successresponse-create_task_note
successresponse-create_template_risk_default_value
The created Template Risk Default Value
successIndicates if the request was successful
response-create_watercraft
Watercraft definition schema
Any business rules that failed during creation
warningsAny warnings generated during creation
successIndicates if the request was successful
response-decline_pending_payment
successIndicates whether the payment decline was successful.
messagesError messages if the operation failed.
response-delete_additional_interest
messagesSuccess or error messages
dataEmpty object on successful deletion
successresponse-delete_adjuster_license
successWhether the request was successful
messagesAny messages or errors related to the request
response-delete_brand
successresponse-delete_calculated_field
successresponse-delete_config
successWhether the operation was successful
response-delete_copilot_skill
successIndicates if the request was successful
Any messages or errors related to the request
response-delete_dispute
successIndicates if the request was successful
dataAlways null on success
response-delete_full_quote
dataEmpty object
successIndicates if the request was successful
response-delete_html_template
dataEmpty object
successIndicates if the request was successful
response-delete_quick_code_value
successWhether the deletion was successful
Response data
messagesAny messages or errors
response-delete_quick_quote_template
Success message for template deletion
successIndicates if the request was successful
response-delete_rule
successWhether the API call succeeded
messagesError messages if success is false
response-delete_sub_line
successIndicates if the request was successful
response-delete_subjectivity
Empty array returned when the request is successful.
successIndicates if the request was successful
response-delete_task_definition
successresponse-delete_template_risk_default_value
Success message for risk default value deletion
successIndicates if the request was successful
response-delete_watercraft
successIndicates if the request was successful
response-disbursement_funding_archive_account
The archived anchor, or an empty array when the id is unknown.
successIndicates if the request was successful
Any messages or errors related to the request
response-disbursement_funding_check_source_balance
successIndicates if the request was successful. True even when available is null -- an unavailable peek is a normal outcome for an advisory read, not a failed request.
Any messages or errors related to the request
response-disbursement_funding_describe_connection
successIndicates if the request was successful
Any messages or errors related to the request
response-disbursement_funding_get_financial_account_balance
successIndicates if the request was successful
Any messages or errors related to the request
response-disbursement_funding_link_funding_source
A BriteCore funding-source row. Stores only the waterfall priority policy for a vendor source; display and status stay vendor-owned.
successIndicates if the request was successful
Any messages or errors related to the request
response-disbursement_funding_list_financial_account_transactions
successIndicates if the request was successful
Any messages or errors related to the request
response-disbursement_funding_list_funding_requests
successIndicates if the request was successful
Any messages or errors related to the request
response-disbursement_funding_list_funding_sources
successIndicates if the request was successful
Any messages or errors related to the request
response-disbursement_funding_manage_account
A BriteCore financial-account anchor. A pure handle: the vendor reference plus its integration binding. Everything displayable about the account (balance, status, nickname, features) is vendor-owned and read live, never stored here.
successIndicates if the request was successful
Any messages or errors related to the request
response-disbursement_funding_reconcile_view
successIndicates if the request was successful
Any messages or errors related to the request
response-disbursement_funding_request_source_entry
Vendor-shaped embed payload, rendered verbatim.
successIndicates if the request was successful
Any messages or errors related to the request
response-disbursement_funding_set_source_priority
The updated row, or an empty array when the id is unknown.
successIndicates if the request was successful
Any messages or errors related to the request
response-disbursement_funding_top_up
One row of BriteCore's append-only money-IN log: a top-up BriteCore asked the vendor to perform, and how that call turned out. This is BriteCore's own record, not vendor state, so it can legitimately disagree with the live balance and transaction feeds while a pull settles.
successWhether the request was processed and recorded. Not a statement about whether money arrived.
Any messages or errors related to the request. Two refusals arrive here rather than as an outcome, because no pull was attempted: a request_id already in flight, and an unavailable funding lock (fail-closed, no money moved). A message reporting that a pull was attempted but its audit row did not persist means MONEY MAY HAVE MOVED and must be reconciled against the live feed, never retried blindly.
response-disbursements_admin_terminate
Outbound disbursement attempt definition schema (BC-22436). One attempt to pay a source obligation (Commission Payment / Return Premium / Claim Payment) over a rail (ach / check / manual).
successIndicates if the request was successful
Any messages or errors related to the request
response-disbursements_aggregates
successIndicates if the request was successful
Any messages or errors related to the request
response-disbursements_cancel
Outbound disbursement attempt definition schema (BC-22436). One attempt to pay a source obligation (Commission Payment / Return Premium / Claim Payment) over a rail (ach / check / manual).
successIndicates if the request was successful
Any messages or errors related to the request
response-disbursements_check_vendor
Outbound disbursement attempt definition schema (BC-22436). One attempt to pay a source obligation (Commission Payment / Return Premium / Claim Payment) over a rail (ach / check / manual).
successIndicates if the request was successful
Any messages or errors related to the request
response-disbursements_get_detail
Full attempt (with folded enrichment) when the row exists. Absent row -> the standard-response envelope emits an empty array ([]) for data; null is also tolerated.
successIndicates if the request was successful
Any messages or errors related to the request
response-disbursements_issue
successIndicates if the request was successful
Any messages or errors related to the request
response-disbursements_list_disbursements
successIndicates if the request was successful
Any messages or errors related to the request
response-disbursements_needs_attention
successIndicates if the request was successful
Any messages or errors related to the request
response-disbursements_obligation_history
successIndicates if the request was successful
Any messages or errors related to the request
response-disbursements_record_manual
Outbound disbursement attempt definition schema (BC-22436). One attempt to pay a source obligation (Commission Payment / Return Premium / Claim Payment) over a rail (ach / check / manual).
successIndicates if the request was successful
Any messages or errors related to the request
response-disbursements_source_enrichment
SPARSE map of disbursement_attempt_id -> enrichment. Keyed only by ids that resolve to an existing attempt: a well-formed id with no row (deleted / stale) is OMITTED, not an error and not an empty-value key. A present key is a found attempt (value is always a full enrichment object); an absent key is an unknown/stale id.
successIndicates if the request was successful
Any messages or errors related to the request
response-disbursements_unissued_obligations
successIndicates if the request was successful
Any messages or errors related to the request
response-documents_templates
successmessageserrorError message if request failed
response-documents_templates_carbone_context
successmessagesThe Carbone context (live or example). Includes a _schema map describing fields whose meaning is not obvious from the key name, and, when a policy type resolved in example mode, the two grounding sidecars below. All three are underscore-prefixed so the MCP's field-summary builder skips them as mappable paths.
response-download_import_schema
successIndicates if the request was successful
messagesArray of informational or error messages
Response data containing schema download information
response-download_report_file
successTrue when the url was issued
messagesError messages; empty on success
The url a browser navigates to, and the name to save it as
response-edit_attachment
A File / attachment row. Marshmallow FileModel field names (snake_case). extra fields are ignored on deserialize; only title, description, code_value_type, and quick_code are persisted by edit_attachment.
successIndicates if the request was successful
response-enable_business_location_with_all_counties
Business location with all counties enabled
successWhether the operation was successful
response-enable_disable_contact
successresponse-ensure_receipt
successWhether the request succeeded
Receipt data when success is true
response-evaluate_contact_screening
successresponse-evaluate_convenience_fee_formula
successWhether the operation was successful
response-execute_dummy_task
messagesAny messages or errors related to the request
successresponse-export_configuration
The configuration export. Queued, it comes back at status queued with the background_job_id to poll; run in the request, it is already complete and names the package it produced. The package itself is never in the response: read it from the file the record names, through files/generate_download_url.
successWhether the request was successful
response-export_tasks
successWhether the request was successful
Any messages or errors related to the request
Response for /api/v2/tasks/export_tasks. The export plan is present on every response, whether or not a file was requested, so a client part-way through a multi-file export can compare total_count against the plan it started from and detect the filtered set changing underneath it. content/filename/file_index/row_count are present only when file_index was supplied.
response-exposure_remap_preview
successThe remap preview
response-files_generate_upload_url_for_tmp_file
successmessagesAny messages or errors related to the request
response-filter_subjectivities
Array of existing subjectivities that match the filter criteria
successIndicates if the request was successful
response-finalize_recovery_candidate
Result of the finalization step.
successIndicates if the request was successful.
response-finalize_sync
successIndicates if the request was successful
response-find_contact_by_params
successIndicates if the request was successful
Array of contact objects matching the search criteria
response-fnol
successmessageserrorError message if request failed
response-get_accounting_loss_details
successWhether the request was successful
response-get_accounting_overview
successWhether the request was successful
response-get_accounting_recoveries_data
total_recordsTotal number of exposures for pagination.
response-get_additional_interest
Additional interest definition. Either revision-level (quote_id) or risk-level (vehicle_id or risk_id).
successresponse-get_adjuster_assignment_config
response-get_all_associated_claims_parties
Claim parties. Current-only mortgagees may appear as virtual rows with a null id when claims.pull-current-mortgagees is enabled.
successIndicates if the request was successful
response-get_all_claim_transactions
successIndicates if the request was successful
response-get_all_html_templates
successIndicates if the request was successful
response-get_applicable_forms
successIndicates if the request was successful
response-get_available_functions
successresponse-get_billing_contact_emails
successWhether the request succeeded
Email and email options when success is true
response-get_claim_estimation
successIndicates if the request was successful
response-get_claims_tabs_visibility
successIndicates if the request was successful
response-get_configuration_export
successTrue if the request was handled
The configuration export record.
response-get_configuration_import
successTrue if the request was handled
The package, and the outcome of the last run against it. Re-running replaces that outcome, so this is current state rather than a history.
response-get_contact_by_agency
successresponse-get_contact_by_agency_group
successresponse-get_contact_by_agent
successresponse-get_contact_screening_status
successresponse-get_copilot_skill
successIndicates if the request was successful
Any messages or errors related to the request
response-get_delayed_commission_accounting_entries
List of delayed commission accounting entries
total_entriesTotal count of delayed entries
total_commissionable_amountSum of all commissionable amounts as decimal string
total_amount_to_be_paidSum of all amounts to be paid as decimal string
Contact identifiers for inserted_by fields
response-get_deliverable_preview_json
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object · requires: warning |
dynamicResolved dynamic-field values, keyed by field_key. A dynamic dropdown's value is the FULL matched object from its source_key array, not just the raw submitted value.
calculatedResolved calculated-field values, keyed by field_name.
EXAMPLE MODE ONLY, and absent on the live path. Says what the context in the same payload actually is, so the panel can tell the author whether they are looking at this site's configuration or BriteCore's shipped sample. Underscore-prefixed so it is skipped as a mappable Carbone path.
response-get_dynamic_fields
array of dynamic fields objects.
successIndicates if the request was successful
response-get_effective_date
successIndicates if the request was successful
response-get_erp_items
successIndicates if the request was successful
response-get_estimated_quote
successIndicates if the request was successful.
dataContains the estimated quote details on success, otherwise null.
response-get_event_types
successWhether the API call succeeded
messagesError messages if success is false
List of available event types
response-get_exposure_edit_status
successresponse-get_exposure_transactions
List of accounting transactions for the exposure
successIndicates if the request was successful
response-get_full_quote_async_status
Status payload for async full-quote creation. Each branch below is a discriminated variant keyed on 'status' — result/policy_id/policy_url are only ever populated in the combinations the service actually produces. 'result_available' is always present and is false only when the job's stored results BLOB could not be read.
successIndicates if the request was successful
response-get_html_template
successIndicates if the request was successful
response-get_installed_integrations
successIndicates if the request was successful
response-get_invoices
successIndicates if the API call was successful.
messagesA list of messages, usually empty on success or containing errors on failure.
response-get_last_prefill_quote_execution_date
successIndicates if the request was successful
response-get_migration_job_status
successIndicates if the request was successful
messagesArray of informational or error messages
response-get_options
revision_idThe ID of the revision
policy_idThe ID of the policy
Summary of the current policy term
List of historical policy terms
Policy type settings related to credit scores
Credit reports for named insureds
Available credit score options
Validation status for the revision
response-get_payment
The payment object ClaimExposurePaymentModel
successresponse-get_policies_with_sub_line
successIndicates if the request was successful
response-get_policy_applicable_suspensions
Array of applicable suspensions for the given policy and suspension actions
actionThe suspension action type
idUnique identifier for the suspension
start_dateSuspension start date
end_dateSuspension end date
descriptionSuspension description
Array of rules that define when this suspension applies
response-get_policy_number_history
Every policy holding the requested number, current holder included. Empty when nothing matches. Order is stable but carries no preference: the caller chooses, using is_current.
successIndicates if the request was successful
response-get_policy_type
successIndicates if the request was successful
response-get_policy_type_item
successIndicates if the request was successful
response-get_policy_type_minimal
successIndicates if the request was successful
response-get_quick_quote_template
The requested Quick Quote Template
successIndicates if the request was successful
response-get_quote_wizard_plugin
Quote wizard plugin model with embed URL
successIndicates if the request was successful
response-get_rate_chains
One entry per line item (top-level and subline items) for the policy types in scope
successIndicates if the request was successful
response-get_regenerate_statements_status
The current state of the async job.
successWhether the poll request itself was accepted (the job's own status is in data.async_status / data.success).
response-get_revision_history
Revision history for the requested policy
successIndicates if the request was successful
response-get_risks
Array of risk summaries for the quote
successIndicates if the request was successful
response-get_rule
successmessagesresponse-get_rules_config
successWhether the API call succeeded
messagesError messages if success is false
Rules configuration data
response-get_rules_documentation
successWhether the API call succeeded
messagesError messages if success is false
Advanced Triggers documentation content
response-get_screening_history
successresponse-get_status
messagesAny messages or errors related to the request
successresponse-get_underlying_policy_changes
successmessagesresponse-get_underwriting_question_autofill_answers
Array of auto-fill answers for underwriting questions
successIndicates if the request was successful
response-get_upload_url
successIndicates if the request was successful
messagesArray of informational or error messages
Pre-signed S3 POST URL and fields for file upload
response-get_user_suspensions_with_geometries
Array of suspension objects with geometry data
successIndicates if the request was successful
response-get_watercraft
Watercraft definition schema
successIndicates if the request was successful
response-get_zip_geometry
successIndicates if the request was successful
response-grant_report_permission
Payload when success is true.
successIndicates if the request was successful
response-import_configuration
The configuration import the run was made against. Queued, it comes back at status queued; poll get_configuration_import with its id. Run in the request, it is already complete. Either way the outcome is in summary, and a later run replaces it.
successWhether the request was successful
response-import_disclosures
List of imported disclosure records
successIndicates if the request was successful
response-import_loss_report
dataIndicates if the loss report was successfully imported
successIndicates if the request was successful
response-import_payment_method
successIndicates if the request was successful
response-import_policy_number
Data related to the imported policy number
successIndicates if the request was successful
response-io_mapping_add_memory_decision
successWhether the request succeeded
dataBody: {mappingId, topic, decision, rationale?}.
response-io_mapping_add_memory_followup
successWhether the request succeeded
dataBody: {mappingId, topic, status}.
response-io_mapping_add_memory_ruled_out
successWhether the request succeeded
dataBody: {mappingId, approach, reason}.
response-io_mapping_add_note
successWhether the request succeeded
dataAnchor a note to a place in the mapping. To ASK somebody, prefer
response-io_mapping_ask_insurance_expert
successWhether the request succeeded
dataAsk a product lead or underwriter a question about how the CARRIER'S PRODUCT
response-io_mapping_ask_technical_expert
successWhether the request succeeded
dataAsk an engineer a question about the SYSTEM -- the endpoint, the schema, the
response-io_mapping_assess_variant_fit
successWhether the request succeeded
dataShould this policy type be a variant of this mapping, or its own mapping?
response-io_mapping_call_wrapped_api
successWhether the request succeeded
dataRender this mapping's request and CALL the endpoint it wraps, for real.
response-io_mapping_capture_reconcile_snapshot
successWhether the request succeeded
dataPin the live definition's domains onto the spec as the authoring snapshot
response-io_mapping_clear_agent_memory
successWhether the request succeeded
dataWipe the agent_memory column.
response-io_mapping_compile_analytics_preview
successWhether the request succeeded
dataCompile a WORKING spec's ANALYTICS section for live preview.
response-io_mapping_compile_resolver_preview
successWhether the request succeeded
dataCompile a WORKING (unsaved) spec to its Jinja template for live preview —
response-io_mapping_compile_response_preview
successWhether the request succeeded
dataCompile a WORKING spec's RESPONSE section (spec['response']) for live preview.
response-io_mapping_copilot
successWhether the request succeeded
dataSSE streaming endpoint (mirrors reports.py:send_prompt).
response-io_mapping_create_fixture
successWhether the request succeeded
dataIO mapping endpoint create_fixture.
response-io_mapping_create_mapping
successWhether the request succeeded
dataIO mapping endpoint create_mapping.
response-io_mapping_delete_fixture
successWhether the request succeeded
dataIO mapping endpoint delete_fixture.
response-io_mapping_delete_mapping
successWhether the request succeeded
dataIO mapping endpoint delete_mapping.
response-io_mapping_delete_schema
successWhether the request succeeded
dataDelete a BYOS schema library row.
response-io_mapping_discard_draft_note
successWhether the request succeeded
dataDrop one unsent note.
response-io_mapping_dismiss_memory_decision
successWhether the request succeeded
dataBody: {mappingId, topic}.
response-io_mapping_dismiss_memory_ruled_out
successWhether the request succeeded
dataBody: {mappingId, approach}.
response-io_mapping_export_mapping
successWhether the request succeeded
dataReturn the portable JSON blob for slug at the given version.
response-io_mapping_find_live_copilot_job
successWhether the request succeeded
dataThe job already working on this mapping, if there is one.
response-io_mapping_find_policy_type
successWhether the request succeeded
dataAs-of resolve (name, state, effectiveDate[, lineName]) to a minimal PT summary.
response-io_mapping_generate_sample
successWhether the request succeeded
dataGenerate a valid, complete sample instance from a schema.
response-io_mapping_get_analytics_slots
successWhether the request succeeded
dataThe slot grid for the ANALYTICS direction: the mapping's analytics schema
response-io_mapping_get_copilot_job
successWhether the request succeeded
dataA running job's status, next to what the review still owes.
response-io_mapping_get_endpoint_slots
successWhether the request succeeded
dataThe endpoint's own schema flattened into the slot grid: one section per top-level
response-io_mapping_get_mapping
successWhether the request succeeded
dataIO mapping endpoint get_mapping.
response-io_mapping_get_policy_type_definition
successWhether the request succeeded
dataWalkable PT definition (mapping scope: sub_lines + items + item_questions +
response-io_mapping_get_policy_type_schema
successWhether the request succeeded
dataSynthesize the extended JSON Schema (the RH mapping target) for a resolved policy
response-io_mapping_get_resolver_constructs
successWhether the request succeeded
dataEverything a mapping DECLARES for its slots to share — each of it a cell: derived
response-io_mapping_get_resolver_paths
successWhether the request succeeded
dataThe mapping's named path aliases ({name: absolute-path}) — the path analogue of
response-io_mapping_get_resolver_spec
successWhether the request succeeded
dataThe mapping's full resolver spec — the seed for the client's working copy.
response-io_mapping_get_review
successWhether the request succeeded
dataThe mapping stated in the carrier's language -- one row per slot.
response-io_mapping_get_schema
successWhether the request succeeded
dataOne schema library row WITH content.
response-io_mapping_get_schema_index
successWhether the request succeeded
dataParsed ACORD schema index (codes, code lists, elements, aggregates) for schema_id.
response-io_mapping_get_slotfill_context
successWhether the request succeeded
dataData for the schema-bound slotFill table editor: source.codes — the LEFT key
response-io_mapping_get_source_paths
successWhether the request succeeded
dataFlatten the inbound document to candidate SOURCE paths + sample values in one
response-io_mapping_get_spec_overview
successWhether the request succeeded
dataTop-level snapshot of one spec.
response-io_mapping_get_variant_slots
successWhether the request succeeded
dataThe Resolver Stack FORM contract for one (policyType, state) variant: the
response-io_mapping_import_mapping
successWhether the request succeeded
dataCreate a new mapping from an export blob.
response-io_mapping_infer_schema_from_workbook
successWhether the request succeeded
dataPropose a JSON Schema from an uploaded workbook. Writes nothing -- confirm by
response-io_mapping_introspect_fixture
successWhether the request succeeded
dataTag tree for document.<...> autocomplete.
response-io_mapping_list_bruno_examples
successWhether the request succeeded
dataBruno-collection examples {name, collection, method, url, body}, optionally
response-io_mapping_list_endpoints
successWhether the request succeeded
dataDotted api paths the apiCall pill suggests.
response-io_mapping_list_fixture_coordinates
successWhether the request succeeded
dataEvery fixture on the mapping, with the COORDINATE its request resolves to.
response-io_mapping_list_fixtures
successWhether the request succeeded
dataReturn every fixture on the mapping, with content.
response-io_mapping_list_mappings
successWhether the request succeeded
dataIO mapping endpoint list_mappings.
response-io_mapping_list_notes
successWhether the request succeeded
dataNote threads on a mapping.
response-io_mapping_list_policy_types
successWhether the request succeeded
dataEvery PolicyType row for the carrier -- used by the copilot's discovery flow
response-io_mapping_list_schemas
successWhether the request succeeded
dataSchema library for the manager UI.
response-io_mapping_list_spec_indexes
successWhether the request succeeded
dataNamed query targets in a spec (code lists, aggregates, enums, ...).
response-io_mapping_list_specs
successWhether the request succeeded
dataEvery spec the registry knows, sorted (source, spec_id).
response-io_mapping_list_versions
successWhether the request succeeded
dataIO mapping endpoint list_versions.
response-io_mapping_load_revision_quote
successWhether the request succeeded
dataReconstruct an existing revision as a create_quote_extended quote_info
response-io_mapping_lookup_spec_enum
successWhether the request succeeded
dataMembers of a named code list / enum within a spec.
response-io_mapping_lookup_spec_path
successWhether the request succeeded
dataResolve a path within a spec (ACORD: dotted element/aggregate; JSONSchema: dotted
response-io_mapping_note_follow_up
successWhether the request succeeded
dataRecord a JOB for later -- not a question, so nobody owes a reply and it does
response-io_mapping_promote_slot_to_base
successWhether the request succeeded
dataFactor a slot's per-variant override UP into the shared base catalog: the overlay
response-io_mapping_reconcile_mapping
successWhether the request succeeded
dataReconcile a mapping against the LIVE policy-type definition for one variant.
response-io_mapping_rename_mapping_slug
successWhether the request succeeded
dataRename an existing mapping's slug.
response-io_mapping_render
successWhether the request succeeded
dataLive preview -- render an in-flight (mapping, fixture, template) triple. When a digest in the request does not match the stored copy, nothing is rendered and data is {"resend": [...]}, naming the override fields to send in full.
response-io_mapping_reply_to_note
successWhether the request succeeded
dataAnswer one review note, with an outcome.
response-io_mapping_resolve_memory_followup
successWhether the request succeeded
dataBody: {mappingId, topic}.
response-io_mapping_resolve_note
successWhether the request succeeded
dataClose a note thread, or reopen it.
response-io_mapping_review_inbox
successWhether the request succeeded
dataReview notes still waiting on a reply.
response-io_mapping_review_index
successWhether the request succeeded
dataThe mapping's products and what each still owes -- the review's front door, for
response-io_mapping_save_draft_note
successWhether the request succeeded
dataStore a reviewer's unsent answer so a reload does not discard it. Invisible to
response-io_mapping_save_resolver_spec
successWhether the request succeeded
dataPersist the client's working resolver spec — Save Mapping.
response-io_mapping_search_policies
successWhether the request succeeded
dataTypeahead search for policies of a given policy type, to load a sample revision
response-io_mapping_search_spec
successWhether the request succeeded
dataFuzzy search across a spec's named entities.
response-io_mapping_set_active_version
successWhether the request succeeded
dataIO mapping endpoint set_active_version.
response-io_mapping_set_analytics_resolvers
successWhether the request succeeded
dataBATCH-write ANALYTICS cells -- the dimensions to derive from an inbound
response-io_mapping_set_declarations
successWhether the request succeeded
dataDeclare aliases, shared logic and the variant key in ONE transaction.
response-io_mapping_set_endpoint_slot_source
successWhether the request succeeded
dataWrite (or clear, with cell=None) a ROOT resolver cell, addressed by its
response-io_mapping_set_item_repeat
successWhether the request succeeded
dataMake an item emit ONE INSTANCE PER SOURCE ELEMENT, or stop it doing so.
response-io_mapping_set_lookup_table
successWhether the request succeeded
dataCreate or replace a shared lookup table's map (code→value) and/or default
response-io_mapping_set_resolver_construct
successWhether the request succeeded
dataReplace one construct section (derived/channels/variantKey) and
response-io_mapping_set_resolver_path
successWhether the request succeeded
dataCreate / rename / update named path aliases, ONE OR MANY.
response-io_mapping_set_resolver_table
successWhether the request succeeded
dataCreate / replace / delete one entry in the reference-table library
response-io_mapping_set_resolvers
successWhether the request succeeded
dataBATCH-write resolver cells -- the copilot's core authoring primitive (the shift
response-io_mapping_set_response_resolvers
successWhether the request succeeded
dataBATCH-write RESPONSE cells -- the FIELDS dialect, for a response the mapping
response-io_mapping_set_response_rewrite
successWhether the request succeeded
dataWrite the RESPONSE REWRITE list -- the dialect for a response that ECHOES the
response-io_mapping_set_slot_source
successWhether the request succeeded
dataWrite (or clear) a resolver cell for one slot of a LAYERED mapping -- the
response-io_mapping_stamp_version
successWhether the request succeeded
dataIO mapping endpoint stamp_version.
response-io_mapping_start_copilot_job
successWhether the request succeeded
dataHand a submitted review to the copilot as a background job.
response-io_mapping_stop_copilot_job
successWhether the request succeeded
dataStop a running copilot job.
response-io_mapping_submit_review
successWhether the request succeeded
dataSend this reviewer's drafts as a batch the copilot is expected to answer.
response-io_mapping_update_fixture
successWhether the request succeeded
dataIO mapping endpoint update_fixture.
response-io_mapping_update_mapping_metadata
successWhether the request succeeded
dataIO mapping endpoint update_mapping_metadata.
response-io_mapping_update_memory_summary
successWhether the request succeeded
dataBody: {mappingId, summary}.
response-io_mapping_upload_schema
successWhether the request succeeded
dataCreate or replace a BYOS schema library row after validating content.
response-is_stp_enabled
successresponse-issue_full_quote
successIndicates if the request was successful
response-ivans_dbcs_abandon_build
successWhether the request itself succeeded. False with messages.refusal_code on an admission refusal.
Empty on success. On a refusal: an object with refusal_code plus one sentence under the field the refusal is about.
response-ivans_dbcs_get_build_status
successWhether the request itself succeeded. False with messages.refusal_code on an admission refusal.
Empty on success. On a refusal: an object with refusal_code plus one sentence under the field the refusal is about.
response-ivans_dbcs_get_configuration
successIndicates if the request was successful.
Any messages or errors related to the request.
response-ivans_dbcs_get_existing_artifacts
successWhether the request itself succeeded. False with messages.refusal_code on an admission refusal.
Empty on success. On a refusal: an object with refusal_code plus one sentence under the field the refusal is about.
response-ivans_dbcs_get_selected_agencies
successIndicates if the request was successful.
Any messages or errors related to the request.
response-ivans_dbcs_rebuild
successWhether the request itself succeeded. False with messages.refusal_code on an admission refusal.
Empty on success. On a refusal: an object with refusal_code plus one sentence under the field the refusal is about.
response-ivans_dbcs_resolve_agencies
successIndicates if the request was successful.
Any messages or errors related to the request.
response-ivans_dbcs_save_selected_agencies
successIndicates if the request was successful.
Empty on success. On a refusal this is an object keyed by field, and it always carries contact_ids with one human-readable sentence naming every offending id. It additionally carries exactly one of the structured keys below, which a UI can act on without parsing that sentence. Validation is all-or-nothing and runs before the write, so a refused request stores nothing.
response-ivans_dbcs_search_agencies
successIndicates if the request was successful.
Any messages or errors related to the request.
response-ivans_dbcs_submit_build
successWhether the request itself succeeded. False with messages.refusal_code on an admission refusal.
Empty on success. On a refusal: an object with refusal_code plus one sentence under the field the refusal is about.
response-ivr_policy_lookup
totalFoundTotal number of policies found
response-link_underlying_policy
successTrue if the operation was successful, false otherwise
messagesList of human-readable messages (errors or informational)
Response data containing confirmation of successful operation
response-list_additional_interests
messagesSuccess or informational messages
Array of additional interests for the quote
successIndicates if the request was successful
response-list_available_schemas
successIndicates if the request was successful
messagesArray of informational or error messages
Response data containing available schemas
response-list_calculated_fields
Flat list of calculated fields. Use field_type to distinguish global vs template.
successresponse-list_claim_changes
successresponse-list_claim_estimations
successIndicates if the request was successful
response-list_configuration_exports
successTrue if the request was handled
A page of configuration exports.
response-list_configuration_imports
successTrue if the request was handled
A page of configuration packages, newest first
response-list_contacts_by_role_code
List of matching contacts
successresponse-list_container_coverages_summary
successIndicates if the request was successful
response-list_containers
successIndicates if the request was successful
response-list_copilot_skills
successIndicates if the request was successful
Any messages or errors related to the request
response-list_custom_fields_types
successIndicates if the request was successful
response-list_definition_overrides
successWhether the request was successful
Endpoint payload wrapped by the api_request response envelope
messagesHuman messages on success (array) or errors (object)
response-list_effective_dates
Array of existing effective dates
response-list_forms_for_policy_type
One entry per active form attached to the Policy Type. Mirrors legacy retrieveDocuments (lib/lines/views.py:1930), which surfaces both the doc row's own id (form_id here) and the File's id (file_id).
successresponse-list_forms_for_policy_type_item
One entry per active form attached to the Policy Type Item. Mirrors legacy retrieveDocuments (lib/lines/views.py:1930), which surfaces both the doc row's own id (form_id here) and the File's id (file_id).
successresponse-list_grantee_options
List of {id, name} options for the picker when success is true.
successIndicates if the request was successful
response-list_insights
successresponse-list_interest_type_labels_by_code
messagesSuccess or informational messages
code -> label map for ADDITIONAL_INTEREST_TYPES (active + inactive)
successIndicates if the request was successful
response-list_interest_type_options
messagesSuccess or informational messages
Selectable interest type QuickCode values for the resolved revision
successIndicates if the request was successful
response-list_policy_parties
successIndicates if the request was successful
messagesAny messages or errors related to the request
response-list_policy_type_definitions
successWhether the request was successful
All policy type definitions, ordered by name
messagesHuman messages on success (array) or errors (object)
response-list_quick_code_values
successWhether the request was successful
The quick code values. In definition scope, only the values enabled for the definition are returned.
messagesHuman messages on success (array) or errors (object)
response-list_quick_quote_templates
List of all Quick Quote Templates
successIndicates if the request was successful
response-list_report_permissions
Payload when success is true.
successIndicates if the request was successful
response-list_rules
successWhether the API call succeeded
messagesError messages if success is false
Response containing the list of rules
response-list_rules_stp_results
successWhether the API call succeeded
messagesError messages if success is false
STP execution results with pagination
response-list_scopes
successWhether the operation was successful
response-list_stp_results
Any messages or errors related to the request
successWhether the request was successful
response-list_subjectivities
Array of existing subjectivities
successIndicates if the request was successful
response-list_subjectivity_definitions
successIndicates if the request was successful
response-list_system_tags
successresponse-list_watercrafts_for_quote
successIndicates if the request was successful
response-make_multi_exposure_payment
Schema for ClaimMultiExposurePaymentModel (multi-exposure payment)
successIndicates if the request was successful
response-make_note
successIndicates whether the note creation was successful.
response-make_payment_by_contact_and_payment_method
successIndicates if the request was successful
error_codeStable, machine-readable reason the request failed. Present only on failure, and only for failures that have one. 'payments_not_allowed' means the policy's status or its policy type's life cycle forbids an electronic payment (BC-24420) -- a refusal by configuration, not an outage, so retrying will not help. 'invalid_parameter' means a parameter was sent with the wrong type -- notably bypass_cannotpay_guard, which must be a real boolean and is rejected rather than coerced, so a stringy "false" cannot be read as an enabled bypass.
response-mark_failed
successFalse for a forbidden/malformed request; true when BC processed the call.
messagesError/warning messages when success is false.
The serialized LifecycleTransitionResult object when success is true; an empty array (standard_response default) when success is false.
response-mark_in_transit
successFalse for a forbidden/malformed request; true when BC processed the call.
messagesError/warning messages when success is false.
The serialized LifecycleTransitionResult object when success is true; an empty array (standard_response default) when success is false.
response-mark_settled
successFalse for a forbidden/malformed request; true when BC processed the call.
messagesError/warning messages when success is false.
The serialized LifecycleTransitionResult object when success is true; an empty array (standard_response default) when success is false.
response-medical_codes_search
successIndicates if the request was successful
response-modify_contact
successresponse-modify_effective_date
Data related to the created effective date
successIndicates if the request was successful
response-modify_full_quote
successIndicates if the request was successful
response-modify_policy_type
successIndicates if the request was successful
response-modify_policy_type_item
successIndicates if the request was successful
response-modify_sub_line
successIndicates if the request was successful
response-modify_subjectivity
Data related to the updated subjectivity
successIndicates if the request was successful
response-modify_subjectivity_definition
response-modify_task
successWhether the task modification was successful
response-modify_task_definition
successresponse-modify_task_definitions_assignees
List of task definition assignments after modification, aggregated by task definition ID.
successresponse-override_screening_check_result
successresponse-prefill_property_loss_history
successresponse-prefill_quote
successIndicates if the request was successful
response-purge_migration_data
successIndicates if the request was successful
messagesArray of informational or error messages
Purge job launch information
response-queue_recovery_candidate
Result of queuing the recovery task.
successIndicates if the request was successful.
response-rate
successIndicates if the request was successful.
dataThe retrieve_revision_details payload of the rated revision (read back after the rate delta committed), extended with the delta_summary, uwr_outcome and risk_rates siblings. Only the stable rating-contract fields are typed here; the rest of the revision-details fields ride along unchanged. On errors data is an empty list (the standard_error envelope).
messagesAny messages or errors related to the request. ALWAYS the flat legacy list shape (for example 'No Revision found for id: X', 'Rating Error: ...', 'The quote could not be rated. Try again, and contact support if it keeps failing.') -- never the 'base' dict shape: every exception this endpoint does not translate is caught, logged, and re-raised as a sanitized flat message.
error_codePresent only when the rate delta committed but the response over it could not be built ('rate_saved_response_unavailable'): the rate is saved, reloading the quote shows the current premiums. Absent from every other response, success or failure -- callers that need a machine-readable reason branch on this instead of parsing 'messages'.
response-rate_full_quote
successIndicates if the request was successful
response-reconcile_insights
successIndicates if the request was successful
response-record_saved_method_authorization
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: data, success, messages | |
| type = object · requires: success, messages | |
| type = object · requires: success, permissionDenied |
successAny messages related to the request.
response-regenerate_statements
The async job handle. The caller polls get_regenerate_statements_status with reference_id until async_status reaches a terminal state.
successWhether the request to start the job was accepted.
response-regenerate_summary
successmessagesAsync queue result for summary regeneration.
response-reinstate_policy
successWhether the operation was successful
messagesAny messages or errors related to the request
response-remove_contact_from_role
successresponse-remove_form_from_policy_type
successresponse-remove_form_from_policy_type_item
successresponse-remove_policy_contact
dataThe data object is empty for this endpoint
successresponse-remove_policy_type_relations
datasuccessIndicates if the request was successful
response-remove_quote_contact
dataThe data object is empty for this endpoint
successresponse-remove_risk_contact
dataThe data object is empty for this endpoint
successresponse-reports_export_report
nameThe report name
descriptionThe report description
report_runnerThe report runner (e.g. sql_runner)
customWhether the report is a user-created (custom) report
draftWhether the report is a draft
date_typeThe report date type (single or range)
hiddenWhether the report is soft-deleted
output_formatThe output format (e.g. excel, text)
output_file_delimiterThe delimiter used for delimited output
category_nameThe report category name, or null when uncategorized
Parameter definitions for the report
export_optionsDelivery/output options (e.g. filename); a password is redacted
additional_report_settingsAdditional report settings
The report sheets (SQL tabs)
response-reports_import_report
The created report (same shape as /api/v2/reports/retrieve_report)
successIndicates if the request was successful
Empty list on success; on error a standard_error envelope keyed by field, or 'base' for non-field errors (e.g. name collision, invalid SQL)
response-request_claim_estimation
claim_ididxact_assignment_idassignment_typexact_analysis_statussent_datesent_byassignment_dateinspection_datecontact_dateestimate_dateappointment_dateestimate_approval_datebuilding_estimate_amountcontents_estimate_amounticc_estimate_amountstatuscanceled_bycanceled_dateis_canceledresponse-request_claims_search
request_idCorrelation ID for tracking the request
statusStatus of the request submission
messageHuman-readable status message
error_codeError code if status is Failed
error_messageDetailed error message if status is Failed
response-resolve_property_geolocation
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: success, data | |
| type = object · requires: success, messages, data |
successThe property's own serialization (Property.to_dict(), which is SNAKE_CASE) plus the keys below. Additional properties are permitted deliberately: the body carries every column and grows with the model.
messagesresponse-retrieve_adjuster_licenses
successWhether the request was successful
messagesAny messages or errors related to the request
List of adjuster license records
response-retrieve_claim_payments
successTrue if the function executed successfully, false if there was an error.
List of human-readable error messages. If the function executed successfully, this list will be empty.
List of claim payment dictionaries, each containing all ClaimTransaction fields including system_tags
response-retrieve_common_allowed_assignees
List of contacts allowed to be assigned to tasks of every given task definition
successresponse-retrieve_config
successWhether the operation was successful
response-retrieve_contact
successresponse-retrieve_convenience_fee
successIndicates if the request was successful
response-retrieve_convenience_fee_preview
successIndicates if the request was successful
response-retrieve_filter_options
successWhether the request was successful
response-retrieve_full_quote
successIndicates if the request was successful
response-retrieve_my_permissions
successresponse-retrieve_my_roles
successresponse-retrieve_payment
successresponse-retrieve_payment_method_creation_details
successIndicates if the request was successful
response-retrieve_payment_methods
successIndicates if the request was successful
response-retrieve_pending_payments_for_settlement
Response schema for /api/v2/payments/retrieve_pending_payments_for_settlement
idUnique identifier for the pending payment.
reference_idExternal reference identifier for the payment.
response-retrieve_permissions
successIndicates if the request was successful
response-retrieve_policy_billing_information
successIndicates if the request was successful
response-retrieve_policy_change_logs
successIndicates if the request was successful
Contains policy change log info as well as revision timestamps
response-retrieve_policy_snapshot
successIndicates if the request was successful
response-retrieve_policy_type_claims_tabs_visibility
successIndicates if the request was successful
response-retrieve_policy_types
successIndicates if the request was successful
response-retrieve_queue_capabilities
successresponse-retrieve_rating_table
successIndicates if the request was successful
response-retrieve_recovery_statuses
Status of each requested recovery job.
successIndicates if the request was successful.
response-retrieve_revision_billing_schedule_context
messagesAny messages or errors related to the request.
Gating signals for the policy's current term. Defaults (false / empty) when the policy has no current term (new business).
successTrue when the signals were computed successfully.
response-retrieve_risk_details
successresponse-retrieve_saved_method_authorization
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: data, success, messages | |
| type = object · requires: success, messages | |
| type = object · requires: success, permissionDenied |
successAny messages related to the request.
response-retrieve_settings
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: messages, data, success | |
| type = object · requires: permissionDenied, success |
Advanced Settings grouped by section.
successresponse-retrieve_subjectivity
Details of the retrieved subjectivity
successIndicates if the request was successful
response-retrieve_subjectivity_definition
successIndicates if the request was successful
response-retrieve_subjectivity_provenance
successresponse-retrieve_task
successresponse-retrieve_task_definition
successresponse-retrieve_task_definition_allowed_assignees
List of contacts that are allowed to be assigned to tasks for this task definition
successresponse-retrieve_task_definitions_assignees
List of task definition assignments, aggregated by task definition ID.
successresponse-retrieve_task_documents
Documents on the record the task is attached to, plus whether the caller may read them at all.
successresponse-retrieve_task_history
successresponse-retrieve_task_notes
successresponse-retrieve_task_provenance
successresponse-retrieve_tasks
Any messages or errors related to the request
successWhether the request was successful
response-retrieve_team_workload
successresponse-retrieve_underwriting_calendar
successresponse-retrieve_underwriting_dashboard
successresponse-retrieve_underwriting_dashboard_panels
successresponse-retrieve_underwriting_team_performance
successresponse-review_revision
successresponse-revoke_report_permission
dataEmpty object on success (no row payload returned).
successIndicates if the request was successful
response-revoke_screening_override
successresponse-rewrite_policy
successIndicates if the request was successful
response-run_migration
successIndicates if the request was successful
messagesArray of informational or error messages
Migration job launch information
response-run_pre_rate_integrations
successIndicates if the request was successful.
dataThe integrations outcome. On errors data is an empty list (the standard_error envelope).
messagesAny messages or errors related to the request. Integration failures keep the legacy flat list shape (rate_risk's standard_error(str(e)) contract).
response-run_property_lookup
successTrue when the lookup ran. False when validation failed, the revision is not open, the vendor errored, or the property address is incomplete.
messagesEmpty on success. On failure: missing mandatories, unknown ids, closed revision, missing address fields, or the vendor error string.
One lookup result when a single integration_instance_id was run. A list of lookup results when headless. An empty array on failure (and also on a successful headless run with no matching instances).
response-run_rules
successWhether the API call succeeded
messagesError messages if success is false
Rules execution result data
response-save_definition_quick_code_value_toggle
successWhether the toggle was saved successfully
Endpoint payload wrapped by the api_request response envelope
messagesHuman messages on success (array) or errors (object)
response-save_html_template
successIndicates if the request was successful
response-save_remove_value_from_definitions_and_deactivate
successWhether the bulk removal and deactivation succeeded
Endpoint payload wrapped by the api_request response envelope
messagesHuman messages on success (array) or errors (object)
response-save_reset_definition_quick_code_values
successWhether the reset succeeded
Endpoint payload wrapped by the api_request response envelope
messagesHuman messages on success (array) or errors (object)
response-search_names_emails
successIndicates if the request was successful
Array of search results containing contact information
response-search_recovery_candidates
List of broken deliverable candidates matching the search filters.
successIndicates if the request was successful.
response-select_my_role
successresponse-send_payment_receipt_email
successWhether the request succeeded
Result when success is true
response-send_scheduled_alerts
successresponse-set_binder_to_active
Data related to the request
successIndicates if the request was successful
response-set_html_templates_locations
successIndicates if the request was successful
response-simulate_rule
successWhether the API call succeeded
API messages or validation errors
Simulation result data, or an empty array when request validation fails
response-sort_calculated_field
successresponse-store_claims_search
request_idUnique identifier for the original request
statusProcessed status of the callback
match_countNumber of matches found
response-store_config
successWhether the operation was successful. False when the caller lacks admin permission or disclosure_style is outside the allowed enum.
response-store_contact_legal_entity_type
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: messages, data, success | |
| type = object · requires: permissionDenied, success |
Empty object on success (the value is persisted server-side); an empty array on error responses, per the standard_error envelope.
successresponse-store_payment
idUnique identifier for the payment.
confirmation_numberConfirmation number for the payment transaction.
receipt_file_idsList of file IDs for payment receipts.
policy_numbersList of policy numbers associated with the payment.
vendor_messageMessage from the payment vendor about the transaction status.
response-store_payment_nsf
successWhether the operation was successful.
messagesList of messages from the operation.
Payment data returned from the operation.
response-sync_underlying_policy_changes
successmessagesresponse-terms_accept
successThe recorded acceptance. On a site where reports.enable-sql-editor-terms is off the notice is not in force: no acceptance row and no audit note are written, and this reports the registered version rather than the submitted one, so an already-open dialog can close instead of erroring.
response-terms_status
successAcceptance state for the requested terms document
response-test_expression
successresponse-trigger_scheduled_claims_research
triggeredNumber of celery tasks dispatched
Eligible claims for which celery tasks were dispatched
response-unassign_business_location
successresponse-unassign_policy_type_definition
successresponse-update_additional_interest
Additional interest definition. Either revision-level (quote_id) or risk-level (vehicle_id or risk_id).
successresponse-update_additional_interest_associations
Additional interest definition. Either revision-level (quote_id) or risk-level (vehicle_id or risk_id).
successresponse-update_adjuster_assignment_config
response-update_adjuster_license
successWhether the request was successful
messagesAny messages or errors related to the request
response-update_billing_schedule
dataEmpty object when successful
successIndicates if the request was successful
response-update_calculated_field
A calculated field definition for Carbone document templates
successresponse-update_carbone_custom_deliverable
successThe updated Carbone deliverable template (CarboneDeliverableModel).
response-update_claim_estimation
successIndicates if the request was successful
response-update_copilot_skill
successIndicates if the request was successful
Any messages or errors related to the request
response-update_dispute
A claim Dispute, including litigation details, settlements, and dates.
successIndicates if the request was successful
response-update_exported_check_details
On success, the updated/failed payload. Request-level errors use the standard v2 envelope with an empty array.
successIndicates if the request was successful
Any messages or errors related to the request
response-update_exposure
successUpdated exposure object
response-update_form_on_policy_type
successresponse-update_form_on_policy_type_item
successresponse-update_insight
successresponse-update_payment
The payment object ClaimExposurePaymentModel or null if authority limits broken
successbrokenLimitsList of broken authority limits if any
adminDataAdmin data for authority limit override if any
response-update_policy_type_claims_tab_visibility
Empty array
successIndicates if the request was successful
response-update_quick_quote_template
The updated Quick Quote Template
successIndicates if the request was successful
response-update_quote_details
Current full-quote state after the PATCH was applied. Shape matches CreateFullQuoteResponseModel (the same shape returned by create_full_quote, modify_full_quote, and bind_full_quote).
successresponse-update_rating_table
successWhether the operation was successful
messagesList of informational messages
response-update_revision_billing_schedule
dataNo data is returned; the schedule change (and any preserve/regenerate choice) is staged on the revision and applied at commit.
successTrue when the change was staged successfully.
response-update_rule
successmessagesresponse-update_selection
policy_term_idThe ID of the policy term that was updated
revision_idThe ID of the revision
selected_optionThe selected credit score option type
applied_scoreThe credit score that was applied to the term
applied_tierThe credit tier corresponding to the applied score
previous_scoreThe previous credit score value, if any
note_idThe ID of the note created for this change
response-update_task_definition
successresponse-update_watercraft
Watercraft definition schema
Any business rules that failed during update
warningsAny warnings generated during update
successIndicates if the request was successful
response-user_has_permission
dataIndicates if the user has the specified permission
successIndicates if the request was successful
response-validate_rule
successWhether the API call succeeded
messagesError messages if success is false
Validation result
response-validate_uploaded_files
successIndicates if the API executed successfully (not validation status)
messagesSummary messages about validation results
Validation results for all uploaded files
response-vehicle_in_force_status
successIndicates if the request was successful
response-vehicle_prefill_fallback
successIndicates if the request was successful
response-workflows_list_workflows
successmessagesresponse-write_off_agency_commissions
The result of the agency write-off operation
successWhether the operation was successful
revision_summary-def
idRevision ID
policy_idPolicy ID
external_system_referenceRevision External System Reference
policy_term_idPolicy Term ID
policy_type_idPolicy Type ID
revision_dateRevision Date
revision_stateRevision State
descriptionRevision Description
risk-def
nameRisk Name
external_system_referenceExternal ID of the Risk
address_cityRisk Address City, required if require_risk_address line configuration is true
address_countyRisk Address County
address_line1Risk Address Line 1, required if require_risk_address line configuration is true
address_line2Risk Address Line 2
address_stateRisk Address State, required if require_risk_address line configuration is true
address_countryRisk Address Country
address_zipRisk Address Zip, required if require_risk_address line configuration is true
latitudeRisk Latitude
longitudeRisk Longitude
replacement_cost_valueRisk Replacement Cost Value
List of mortgagees associated with this risk
typeRisk Type. Can be Vehicle or Property. Default is Property
sub_line_def-def
nameName of the Subline
categoryCategory of the Subline (Policy or Risk)
requirement_typeRequirement type of the Subline
typeType of the Subline
idUnique identifier for the Subline
policy_type_idUUID of the parent policy type this subline belongs to
external_system_referenceExternal System Reference for the Line Item
allow_multiplesIndicates if multiple instances of this Subline are allowed
name_edit_allowedIndicates if editing the name of the Subline is allowed
sort_orderSort order for the Subline
descriptionDescription of the Subline
system_tagsSystem tags associated with the Subline
hide_fromSpecifies where the Subline should be hidden from
List of line items associated with this Subline
subline-def
sub_line_idSub Line ID
sub_line_external_system_referenceExternal ID of the Sub Line
summary-def
Role variants keyed by role token. POLICY: agent, underwriter, adjuster. CLAIM: adjuster, siu. The required key set depends on reference_type and is validated server-side.
underwriting_question-def
idUnique identifier for the question
effective_idReference to the effective date
yes_no_questionThe question text
reference_idReference identifier for versioning
policy_type_idReference to policy type. Null for global questions that apply to all policy types. Optional when nested inside a policy type - will be inherited from parent.
inheritance_idInheritance identifier for question hierarchy
Whether explanation is required
Whether a 'yes' answer prevents continuing
orderDisplay order of the question
expiration_dateExpiration date for the question
underwriting_rule-def
idUUID of the rule
reference_idReference UUID for rule versioning (if applicable)
policy_type_idUUID of the policy type this rule belongs to
nameHuman-readable name of the rule
descriptionDetailed description of what the rule does
Rule category that determines scope and available triggers/effects
Module that determines when the rule is executed. 'all' = BriteCore and BriteQuote, 'bc' = BriteCore only, 'bq' = BriteQuote only, 'events' = Event-triggered rules, 'stp' = Straight-Through Processing rules, 'quote-submit-new-business' = Agent new business quote submission
Severity level for STP rules. Required when module is 'stp'
Event type for event-triggered rules. Required when module is 'events'
Behavior when the rule has been waived. 'run_always' = Always run the rule, 'waived_for_x_terms' = Skip for specified number of terms, 'skip_after_waived' = Skip permanently after waiver
waiver_termsNumber of terms to skip when waiver_behavior is 'waived_for_x_terms'
properties_affectedComma-separated list of property IDs affected by this rule
exception_typeType of exception for agency-specific rule exceptions
List of agency IDs or agency configuration for rule exceptions
enabled_for_renewalWhether the rule applies to policy renewals
enabled_for_endorsementWhether the rule applies to policy endorsements
enabled_for_new_businessWhether the rule applies to new business policies
sort_orderOrder in which the rule is evaluated relative to other rules
valid_from_dateStart date when the rule becomes effective (YYYY-MM-DD)
valid_to_dateEnd date when the rule stops being effective (YYYY-MM-DD)
deletedWhether the rule has been soft-deleted
List of conditions that must be met for the rule to fire
List of actions taken when all triggers are satisfied
underwriting_rules_effect-def
idUUID of the effect
reference_idReference UUID for effect versioning
underwriting_rule_idUUID of the parent rule
target_idUUID of the target policy type item, sub line, subjectivity definition, or task definition. For 'Add Subjectivity' effects, this is the subjectivity definition ID. For 'Create Task', this is the task definition ID.
sort_orderOrder of this effect within the rule
The action to perform when the rule fires
label_nameLabel or category/field name for the effect. Required for category, deductible, and field-related effects.
valueEffect value. Usage varies by action: category option name for Set/Remove Category Option, code string for Set Field Value, error message for Validation Error, deliverable ID for Generate Deliverable, integration instance ID for Attach Property Valuation, JSON task configuration for Create Task.
deletedWhether the effect has been soft-deleted
mandatoryWhether the effect creates a mandatory coverage
hard_reverseWhether to hard reverse the effect when conditions are no longer met
hide_categoryWhether to hide the category in the UI (optional for Set Category Option)
popup_messageMessage text for 'Add Popup Message' or 'Block Quote' effects
custom_error_code_idUUID of the custom error code. Required for 'Set STP Error' effects.
underwriting_rules_trigger-def
idUUID of the trigger
reference_idReference UUID for trigger versioning
underwriting_rule_idUUID of the parent rule
policy_type_item_idUUID of the policy type item this trigger evaluates
sort_orderOrder of this trigger within the rule
label_nameLabel or field name for the trigger condition
Value(s) to compare against. Can be string, number, boolean, array, or object depending on trigger_type
Type of trigger condition
deletedWhether the trigger has been soft-deleted
vehicle-def
idquote_idvehicle_yearvehicle_makevehicle_modelvehicle_vinvehicle_typevehicle_body_typevehicle_numbernameaddress_cityaddress_countyaddress_line1address_line2address_stateaddress_zipsymbol_age_groupsymbol_collisionsymbol_comprehensivesymbol_liabilitysymbol_medical_paymentsterritoryvehicle_classregistered_statehorse_powergarage_codestated_amountvehicle_valuationcost_new_vehiclereplacement_cost_valueannual_mileageodometer_readingmiles_to_workper_week_days_drivenper_month_weeks_drivenperformancedate_vehicle_leaseddate_vehicle_purchasedpurchased_newpurchase_pricenew_vehicleusagecar_poolmulti_carseat_beltsseat_belt_typeair_bagsair_bag_typepassive_restraintanti_lock_brakesanti_theft_deviceanti_theft_device_typeanti_theft_codedaytime_running_lightsgross_vehicle_weightplate_numberused_for_ride_sharecustomized_equipmentcustomization_descriptionaudio_equipment_cost_newprimary_driver_indexIndex into drivers[] array to assign as primary driver (input only). Referenced driver must be included_in_policy.
primary_driver_idsecondary_driver_idincluded_in_policydeletedvehicle_template-def
address_cityVehicle garaging city
address_countyVehicle garaging county
address_line1Vehicle garaging address line 1
address_line2Vehicle garaging address line 2
address_stateVehicle garaging state
address_zipVehicle garaging ZIP code
yearVehicle model year (simplified field name)
makeVehicle make (simplified field name)
modelVehicle model (simplified field name)
vinVehicle identification number (simplified field name)
vehicle_typeVehicle type code from quick_code_values AUTO_VEHICLE_TYPES
vehicle_body_typeVehicle body type code from quick_code_values BODY_TYPE_OPTIONS
cost_new_vehicleCost of new vehicle
annual_mileageAnnual mileage
included_in_policyWhether vehicle is included in policy
watercraft-def
idUnique identifier for the watercraft
address_cityCity where the watercraft is located
address_countyCounty where the watercraft is located
address_line1Primary address line
address_line2Secondary address line
address_stateState where the watercraft is located
address_zipZIP code where the watercraft is located
watercraft_hull_idHull identification number
watercraft_typeType of watercraft (validated against WATERCRAFT_VEHICLE_TYPES quick codes)
watercraft_type_labelHuman-readable label for watercraft type
watercraft_yearYear the watercraft was manufactured
watercraft_makeManufacturer of the watercraft
watercraft_modelModel of the watercraft
watercraft_lengthLength of the watercraft
watercraft_horsepowerHorsepower of the watercraft engine
watercraft_numberRegistration number of the watercraft
quote_idID of the associated quote
primary_operator_idID of the primary operator
secondary_operator_idID of the secondary operator
Custom fields for the watercraft
deletedWhether the watercraft is deleted
included_in_policyWhether the watercraft is included in the policy
previous_idPrevious ID if this is an updated watercraft
added_from_templateIndicates if the watercraft was added from a template
watercraft_template-def
address_cityWatercraft storage city
address_countyWatercraft storage county
address_line1Watercraft storage address line 1
address_line2Watercraft storage address line 2
address_stateWatercraft storage state
address_zipWatercraft storage ZIP code
yearWatercraft model year (simplified field name)
makeWatercraft make (simplified field name)
modelWatercraft model (simplified field name)
hull_idHull identification number (simplified field name)
watercraft_typeWatercraft type code from quick_code_values WATERCRAFT_VEHICLE_TYPES
watercraft_lengthWatercraft length in feet
watercraft_horsepowerWatercraft horsepower
watercraft_numberWatercraft sequence number
included_in_policyWhether watercraft is included in policy
workflow-def
namescopeiddescriptionstatusrolesource_workflow_idlive_ref_idcurrent_version_idlive_statuslive_version_numberhas_unpublished_changespolicy_type_version_idslast_fired_atfirings_30dcreated_atupdated_atworkflow_run-def
run_idworkflow_idevent_class_namestatusrun_numberworkflow_nameworkflow_version_idworkflow_version_numberevent_idevent_payload_snapshotentity_typeentity_identity_labeltriggering_user_idstarted_atcompleted_atlast_error_messageparent_run_idparent_run_numberretry_of_node_idrate_chain-def-defs-BaseCategory
optionsAn array of category options
disallow_optionsAn array of booleans indicating whether or not each option is disallowed
category_nameThe name of the category
typeprint_on_declarationWhether or not to print the category on the declaration
print_order_in_decThe order in which to print the category on the declaration
enabled_in_britequoteWhether the category is enabled/disabled in BriteQuote.
visible_in_britequoteWhether the category is shown in BriteQuote.
sync_across_line_itemsWhether the category value is synced with other categories across line items. Other categories should also have the same name and this value set to true to sync.
sync_alwaysWhether the category values are synced every time a change is made to the category or only once.
require_explicit_selection_in_wizardWhether the category requires an explicit selection in the wizard.
renew_with_defaultRenew with the Default Category if no Category selection was previously made.
is_requiredWhether the category is required.
show_message_popup_in_builderWhether to show a message popup in the builder.
message_popup_textThe text to show in the message popup.
selected_by_lookupWhether the category is selected by a lookup table.
The lookup table to use for selecting the category.
preservation_uuidsUUIDs of the options for Credit Tier, Location Code, Zip Code. These ids correspond to the options using the same index in the options list.
default_optionThe default option for the category.
line_item_idID of the referenced category's line item.
rate_chain-def-defs-Category
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: options, disallow_options, category_name +1 more | |
| type = object · requires: categories, mapping | |
| type = object · requires: options, disallow_options, category_name +1 more | |
| type = object · requires: options, disallow_options, category_name +1 more | |
| type = object · requires: options, disallow_options, category_name +1 more | |
| type = object · requires: options, disallow_options, category_name +1 more | |
| type = object · requires: options, disallow_options, category_name +1 more | |
| type = object · requires: options, disallow_options, category_name +1 more | |
| type = object · requires: options, disallow_options, category_name +1 more | |
| type = object · requires: options, disallow_options, category_name +1 more | |
| type = object · requires: options, disallow_options, category_name +1 more | |
| type = object · requires: options, disallow_options, category_name +1 more | |
| type = object · requires: options, disallow_options, category_name +1 more | |
| type = object · requires: options, disallow_options, category_name +1 more | |
| type = object · requires: options, disallow_options, category_name +1 more |
typerate_chain-def-defs-MappedCategoryMapping
map_fromA list of options to map from.
map_toAn option to map to.
rate_chain-def-defs-FlatRate
categoriesA list of category names that this flat rate object uses.
A list that represents the rates for the categories in categories.
rate_chain-def-defs-BaseFactorTable
factor_table_typeapplies_toRate applies to.
between_intervalsHow to the interval between the rates.
round_toThe round to value for the rates.
round_methodThe round method for the rates.
categoriesA list of category names that this factor table uses.
tiersA list of tiers.
referenced_itemsA list of referenced line items.
rate_chain-def-defs-FactorTable
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: factor_table_type, applies_to, between_intervals +5 more | |
| type = object · requires: factor_table_type, applies_to, between_intervals +5 more | |
| type = object · requires: label | |
| type = object · requires: factor_table_type, applies_to, between_intervals +5 more | |
| type = object · requires: factor_table_type, applies_to, between_intervals +5 more | |
| type = object · requires: factor_table_type, applies_to, between_intervals +5 more | |
| type = object · requires: factor_table_type, applies_to, between_intervals +5 more | |
| type = object · requires: factor_table_type, applies_to, between_intervals +5 more | |
| type = object · requires: factor_table_type, applies_to, between_intervals +5 more |
factor_table_typerate_chain-def-defs-BaseRateTable
rate_table_typebetween_intervalsHow to the interval between the rates.
round_toThe round to value for the rates.
round_methodThe round method for the rates.
categoriesA list of category names that this rate table uses.
tiersA list of tiers.
referenced_itemsA list of referenced line items.
rate_chain-def-defs-RateTable
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: rate_table_type, between_intervals, round_to +4 more | |
| type = object · requires: rate_table_type, between_intervals, round_to +4 more | |
| type = object · requires: label | |
| type = object · requires: rate_table_type, between_intervals, round_to +4 more | |
| type = object · requires: rate_table_type, between_intervals, round_to +4 more | |
| type = object · requires: rate_table_type, between_intervals, round_to +4 more | |
| type = object · requires: rate_table_type, between_intervals, round_to +4 more | |
| type = object · requires: rate_table_type, between_intervals, round_to +4 more |
rate_table_typerate_chain-def-defs-BasePremiumBasis
premium_basis_typeround_toThe round to value for the rates.
round_methodThe round method for the rates.
categoriesA list of category names that this table uses.
tiersA list of tiers.
rate_chain-def-defs-PremiumBasis
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: premium_basis_type, round_to, round_method +3 more | |
| type = object · requires: premium_basis_type, round_to, round_method +3 more | |
| type = object · requires: premium_basis_type, round_to, round_method +3 more |
premium_basis_typerate_chain-def-defs-BaseDeductible
deductible_typerate_chain-def-defs-Deductible
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: round_to, round_method | |
| type = object · requires: deductible_group_id | |
| type = object · requires: eval_code |
round_toThe round to value for the deductible.
round_methodThe round method for the deductible.
deductible_typerate_chain-def-defs-MinimumPremium
minimum_premium_typecategoriesA list of category names that this minimum premium object uses.
A list of objects that represents the rates for the categories in categories.
referenced_itemsA list of referenced policy type items.
rate_chain-def-defs-MaximumPremium
maximum_premium_typecategoriesA list of category names that this maximum premium object uses.
A list of objects that represents the rates for the categories in categories.
referenced_itemsA list of referenced policy type items.
rate_chain-def-defs-Evaluation
eval_codePython code for the evaluation.
assignmentfinalWhether this is the final premium.
new_var_nameThe new variable name for the evaluation result.
rate_chain-def-defs-BaseLimit
limit_typeunitThe unit of the limit.
roundThe round to value for the limit.
set_limit_to_minWhether to set the limit to the minimum automatically.
rate_chain-def-defs-LimitNested
typeamountThe amount of the limit.
min_limit_line_item_ref_idsA list of entered min limit line item reference ids.
max_limit_line_item_ref_idsA list of entered max limit line item reference ids.
shared_limitsWhether the limits are shared.
eval_codePython code for the evaluation.
nameThe name of the user chosen limit.
A list of user chosen limits.
default_limit_rowThe default limit row for chosen limits.
rate_chain-def-defs-Limit
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: source | |
| type = object · requires: source | |
| type = object · requires: source |
rate_chain-def-defs-BaseRatePer
rate_per_typeround_toThe round to value for the rates.
round_methodThe round method for the rates.
categoriesA list of category names that this rate per object uses.
same_for_allWhether the rate per is the same for all.
referenced_itemsA list of referenced policy type items.
rate_chain-def-defs-RatePer
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object | |
| type = object | |
| type = object | |
| type = object | |
| type = object | |
| type = object | |
| type = object | |
| type = object |
typeresponse-run_property_lookup-defs-lookupResult
Category and user-input fields whose stored value changed.
Property valuation fields that were written. Absent keys were not changed. replacement_cost_value is quantized to DECIMAL(64,2) and serializes as a JSON number (BC-23939).
alert_messageVendor alert text. Empty string when none.
Rating fields whose vendor value is not in selection_options. Headless stops further instances when this is non-empty.
Hold and vendor-proposal state after this run, keyed by property item id then field name. Reported because two outcomes produce no rating_information_updates entry and so reach the client by no other route: a converging vendor value releases the hold without writing a value, and a value refused by a live hold records a fresh proposal while leaving the stored value alone. Absent on the early skip path, where no integration ran.
summary-def-defs-summary_variant
narrative2-4 sentence narrative for this role
data_completeness_warningWarning about missing or incomplete source data, or null