{"openapi":"3.1.0","info":{"title":"Documentation","version":"1.0.0","description":"Canopy Connect Public API Documentation","contact":{"name":"Canopy Connect","email":"support@usecanopy.com","url":"https://usecanopy.com/"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"servers":[{"url":"https://app.usecanopy.com/api/v1.0.0"}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic authentication. Use your Canopy Connect Client ID as the username and your Client Secret as the password. The `Authorization` header value is `Basic <base64 of clientId:clientSecret>`. See the [Authentication guide](https://docs.usecanopy.com/reference/authentication-guide) for a full walkthrough, and create or manage your Client ID and Client Secret on the [API Settings page](https://app.usecanopy.com/dashboard/settings/api-settings)."}},"schemas":{"Pull":{"title":"Pull","type":"object","properties":{"pull_id":{"type":"string","format":"uuid","description":"ID of the pull"},"status":{"title":"PullStatus","enum":["STARTED","QUEUED","DOCUMENT_PARSING","PROCESSING","IDENTITY_VERIFICATION_OPTIONS","IDENTITY_VERIFICATION","GETTING_CONSUMERS","PULLING_DATA","SERVICING","WAITING_FOR_CONSUMER_CONFIRMATION","SUBMITTING_CONFIRMATION","NOT_AUTHENTICATED","INTERNAL_ERROR","PROVIDER_ERROR","VALIDATION_ERROR","SUCCESS","INCOMPLETE"],"description":"Pull Status. Certain statuses correspond with a certain `type`:<br>- `GETTING_CONSUMERS` and `PULLING_DATA` are for `PULLING_DATA` pulls only.<br>- `SERVICING`, `WAITING_FOR_CONSUMER_CONFIRMATION`, `SUBMITTING_CONFIRMATION` and `VALIDATION_ERROR` are for `SERVICING` pulls only.<br>- All other statuses can be present on any pull type."},"account_identifier":{"type":["string","null"],"description":"Unique identifier for online account holder that will stay the same across PULLING_DATA pulls"},"first_name":{"type":["string","null"],"description":"First name of online account holder"},"middle_name":{"type":["string","null"],"description":"Middle name of online account holder"},"last_name":{"type":["string","null"],"description":"Last name of online account holder"},"email":{"type":["string","null"],"description":"Email optionally provided by consumer after submitting bad credentials (`NOT_AUTHENTICATED`)","format":"email"},"account_email":{"type":["string","null"],"description":"Online account holder email address","format":"email"},"phone":{"type":["string","null"],"description":"Preferred contact phone"},"mobile_phone":{"type":["string","null"],"description":"Online account holder mobile phone"},"home_phone":{"type":["string","null"],"description":"Online account holder home phone"},"work_phone":{"type":["string","null"],"description":"Online account holder work phone"},"work_phone_extension":{"type":["string","null"],"description":"Online account holder work phone extension"},"insurance_provider_name":{"type":["string","null"],"description":"Online account holder's insurance provider identifier. This is not a user-friendly name."},"insurance_provider_friendly_name":{"type":["string","null"],"description":"Online account holder's insurance provider name. This is a user-friendly name."},"team_id":{"type":"string","format":"uuid","description":"Team ID this pull is associated with (should match the team id used or api call)"},"widget_id":{"type":"string","format":"uuid","description":"Widget/Link Id that the online account holder submitted on"},"meta_data":{"type":["string","null"],"description":"Developer-supplied arbitrary JSON-serializable data as a string"},"is_archived":{"type":"boolean","default":false,"description":"Whether the pull is archived"},"created_at":{"type":"string","format":"date-time","description":"Time at which the pull was created by online account holder giving consent"},"public_alias":{"type":"string","description":"Url alias/extension of the Canopy Connect link where the pull was submitted"},"public_url":{"type":"string","description":"Full public url used to create pull"},"encountered_mfa":{"type":"boolean","description":"Whether the Pull encountered MFA"},"no_policies":{"type":"boolean","description":"Whether the account has no policies"},"no_drivers":{"type":"boolean","description":"Whether the account has no drivers"},"no_documents":{"type":"boolean","description":"Whether the account has no documents"},"no_claims":{"type":"boolean","description":"Whether the account has no claims"},"no_loss_events":{"type":"boolean","description":"Whether the account has no loss events"},"type":{"type":"string","enum":["PULLING_DATA","SERVICING","DOCUMENT_UPLOAD","DOCUMENT_PARSING","AGENT","MANUAL_ENTRY","POLICY_LOOKUP","CONTACT_ME"],"description":"Pull Type"},"parent_pull_id":{"type":["string","null"],"format":"uuid","description":"Internal correlation field linking a pull to its parent pull, when applicable. `null` for top-level pulls. Pulls with a `parent_pull_id` represent internal work and do not fire customer-facing webhooks — only the parent pull's webhooks are delivered externally."},"policy_check_status":{"type":"string","enum":["COMPLIANT","NOT_COMPLIANT","REVIEW_REQUIRED"],"description":"Overview of Policy Check Status"},"policies":{"type":"array","uniqueItems":true,"description":"List of policy objects","items":{"$ref":"#/components/schemas/Policy"}},"drivers":{"type":"array","uniqueItems":true,"description":"List of driver objects","items":{"$ref":"#/components/schemas/Driver"}},"documents":{"type":"array","uniqueItems":true,"description":"List of document objects","items":{"$ref":"#/components/schemas/Document"}},"addresses":{"type":"array","uniqueItems":true,"description":"List of address objects","items":{"type":"object","$ref":"#/components/schemas/Address"}},"claims":{"type":"array","description":"List of claim objects","uniqueItems":true,"items":{"$ref":"#/components/schemas/Claim"}},"driving_records":{"type":"array","description":"List of driving record objects","uniqueItems":true,"items":{"$ref":"#/components/schemas/DrivingRecord"}},"loss_events":{"type":"array","description":"List of commercial loss events objects","uniqueItems":true,"items":{"$ref":"#/components/schemas/LossEvent"}},"agents":{"type":"array","description":"List of agent objects","items":{"$ref":"#/components/schemas/AgentInfo"}},"answers":{"type":"array","description":"List of answers to custom fields in the link flow","items":{"$ref":"#/components/schemas/AnswerSection"}},"skipped_product_types":{"description":"Product types for skipped policies due to lack of access","type":["array","null"],"items":{"enum":["personal","commercial","agent"]}},"funnel":{"$ref":"#/components/schemas/PullFunnel","description":"Information about the Pull’s deal stage"}}},"PullFunnel":{"title":"PullFunnel","type":["object","null"],"description":"Information about the Pull’s deal stage","properties":{"assignee":{"$ref":"#/components/schemas/PullAssignee","description":"Agent to whom the Pull is assigned"},"premium":{"description":"Total premium won (when `stage` is `WON`)","type":["number","null"]},"stage":{"description":"Reported deal stage that the Pull is in","type":"string","enum":["WORKING","WON","LOST"]}}},"PullAssignee":{"title":"PullAssignee","type":["object","null"],"description":"Agent to whom the Pull is assigned","properties":{"agent_id":{"type":"string","format":"uuid"},"email":{"type":"string","format":"email"},"first_name":{"type":"string"},"last_name":{"type":"string"}}},"Policy":{"title":"Policy","type":"object","properties":{"policy_id":{"type":"string","format":"uuid","description":"ID of the policy"},"name":{"type":["string","null"],"description":"Human-friendly name of policy"},"description":{"type":["string","null"],"description":"Human-friendly description of policy"},"carrier_policy_number":{"type":["string","null"],"description":"The carrier's identifier for the policy"},"policy_type":{"type":["string","null"],"description":"Policy type","enum":["AUTO","NAMED_NON_OWNER","CLASSIC_CAR","BOAT","CONDO","FARMOWNER","FLOOD","HOMEOWNERS","LANDLORD","LIFE","MOTORCYCLE","TERM_LIFE","UNIVERSAL_LIFE","WHOLE_LIFE","RENTERS","SNOWMOBILE","UMBRELLA","RECREATIONAL_VEHICLE","FIRE","TRAILER","PERSONAL_ARTICLES","EARTHQUAKE","BUSINESS_OWNERS","COMMERCIAL_UMBRELLA","COMMERCIAL_AUTO","COMMERCIAL_FIRE","COMMERCIAL_AGRIBUSINESS","COMMERCIAL_PACKAGE","COMMERCIAL_PROPERTY","COMBO","OFFROAD_VEHICLE","WORKERS_COMPENSATION","MOBILE_HOME","PET","PERSONAL_LIABILITY","GENERAL_LIABILITY","ERRORS_AND_OMISSIONS","INLAND_MARINE","GARAGE","EXCESS_LIABILITY","CYBER","IDENTITY_THEFT","COMMERCIAL_CRIME","ARTISAN_AND_SERVICE_CONTRACTORS","FARM_POLLUTION_LIABILITY","FARM_UMBRELLA","MANAGEMENT_LIABILITY","GOLF_CART","YACHT","PERSONAL_WATERCRAFT","STANDARD_PROPERTY","CONTRACTORS_EQUIPMENT","WINDSTORM","SHORT_TERM_DISABILITY","LONG_TERM_DISABILITY","LONG_TERM_CARE"]},"effective_date":{"type":["string","null"],"description":"The date that the coverage provided by the policy is in force.","format":"date-time"},"expiry_date":{"type":["string","null"],"description":"The date that the coverage provided by the policy is no longer in force.","format":"date-time"},"renewal_date":{"type":["string","null"],"description":"The date that the coverage provided by the policy will renew. This will be the effective date of the new term.","format":"date-time"},"canceled_date":{"type":["string","null"],"description":"The date that the policy was cancelled.","format":"date-time"},"total_premium_cents":{"type":["integer","null"],"description":"Total policy premium in cents"},"paid_in_full":{"type":["boolean","null"],"description":"Whether the policy is fully paid"},"amount_paid_cents":{"type":["integer","null"],"description":"Amount paid for the policy so far in cents"},"amount_due_cents":{"type":["integer","null"],"description":"Amount left to pay for the policy in cents"},"total_estimated_annual_premium_cents":{"type":["integer","null"],"description":"Total estimated annual premium, in cents (Workers' Compensation)"},"total_minimum_premium_cents":{"type":["integer","null"],"description":"Total minimum premium, in cents (Workers' Compensation)"},"total_deposit_premium_cents":{"type":["integer","null"],"description":"Total deposit premium, in cents (Workers' Compensation)"},"carrier_name":{"type":"string","description":"Insurance carrier identifier. This is not a user-friendly name."},"carrier_friendly_name":{"type":["string","null"],"description":"Insurance carrier name. This is a user-friendly name."},"status":{"type":["string","null"],"enum":["ACTIVE","CANCELLED","EXPIRED","UNVERIFIED","PENDING_ACTIVATION","PENDING_CANCELLATION","RESCINDED","QUOTE"],"description":"Policy status"},"state":{"type":["string","null"],"description":"Policy jurisdiction, as a two-letter state code"},"limited_access":{"type":"boolean","description":"Whether the carrier provided policy detail access"},"form_of_business":{"type":["string","null"],"enum":["INDIVIDUAL","PARTNERSHIP","LIMITED_LIABILITY_COMPANY","S_CORPORATION","CORPORATION","JOINT_VENTURE","NOT_FOR_PROFIT_ORGANIZATION","TRUST"],"description":"Commercial policy form of business"},"deductible_cents":{"type":["integer","null"],"description":"Commercial policy deductible in cents"},"is_monoline":{"type":"boolean","description":"Indicates whether or not the account has a single policy"},"policy_check":{"type":["null","object"],"$ref":"#/components/schemas/PolicyCheck","description":"Policy check data containing verification status and detail verification information"},"dwellings":{"type":"array","uniqueItems":true,"description":"List of dwelling objects","items":{"$ref":"#/components/schemas/Dwelling"}},"locations":{"type":"array","uniqueItems":true,"description":"List of location objects","items":{"$ref":"#/components/schemas/Location"}},"vehicles":{"type":"array","description":"List of vehicle objects","uniqueItems":true,"items":{"$ref":"#/components/schemas/Vehicle"}},"commercial_named_insureds":{"type":"array","description":"List of commercial named insureds","uniqueItems":true,"items":{"$ref":"#/components/schemas/CommercialNamedInsured"}},"named_insureds":{"type":"array","description":"List of named insured objects","items":{"$ref":"#/components/schemas/NamedInsured"}},"life":{"$ref":"#/components/schemas/LifePolicy"},"forms_and_endorsements":{"type":"array","description":"List of forms and endorsements. Your plan must include policy forms in order to access this data in production. For more information, contact your Canopy Connect representative.","items":{"$ref":"#/components/schemas/PolicyForm"}},"is_telematics_enabled":{"type":["boolean","null"],"description":"Indicates whether Telematics is enabled for the policy (Auto policies only)"},"payment_frequency":{"type":["string","null"],"enum":["MONTHLY","QUARTERLY","SEMIANNUALLY","ANNUALLY"],"description":"Frequency of payments for this policy"},"last_payment_date":{"type":["string","null"],"description":"The date of the last payment","format":"date-time"},"premium_groups":{"type":"array","description":"List of premium groups","items":{"$ref":"#/components/schemas/PremiumGroup"}}}},"Address":{"title":"Address","allOf":[{"properties":{"address_id":{"type":"string","format":"uuid","description":"ID of the address"},"full_address":{"type":["string","null"],"description":"One-line address for convenience"},"address_nature":{"type":["string","null"],"enum":["MAILING","PHYSICAL","LIENHOLDER","INCIDENT_LOCATION","AGENCY_LOCATION","MORTGAGEE"],"description":"The type of adress"}}},{"title":"Address","type":"object","properties":{"country":{"type":["string","null"],"description":"Country of Address"},"number":{"type":["string","null"],"description":"House or street number of Address"},"street":{"type":["string","null"],"description":"Name of the street without directional or type qualifier"},"type":{"type":["string","null"],"description":"Abbreviated street type, eg. Rd, St, Ave, etc"},"city":{"type":["string","null"],"description":"City of Address"},"state":{"type":["string","null"],"description":"State of Address, as a two-letter state code"},"sec_unit_type":{"type":["string","null"],"description":"The type of unit"},"sec_unit_num":{"type":["string","null"],"description":"The number of the unit (may not be numeric)"},"zip":{"type":["string","null"],"description":"Zipcode of Address"},"prefix":{"type":["string","null"],"description":"Directional prefix for the street, such as N, NE, E, etc. A given prefix should be one to two characters long."}}}],"type":"object"},"AnswerField":{"title":"AnswerField","type":"object","properties":{"consumer_flow_section_field_id":{"type":"string","format":"uuid","description":"ID of the field"},"label":{"type":"string","description":"Label of the field as displayed to the user"},"meta":{"type":"object","description":"Meta data for the field, including validation rules and display options. This varies based on the field type."},"type":{"type":"string","enum":["TEXT","NUMBER","BOOLEAN","DATE","FILE_UPLOAD"],"description":"Type of field"},"value":{"description":"Value of the field. Type varies based on the field type, and will be null if the field has not been answered. When `type` is `FILE_UPLOAD`, this is an array of file objects.","anyOf":[{"type":["string","number","boolean","null"]},{"type":"array","items":{"$ref":"#/components/schemas/FileUpload"}}]}}},"AnswerSection":{"title":"AnswerSection","type":"object","properties":{"consumer_flow_section_id":{"type":"string","format":"uuid","description":"ID of the section"},"fields":{"type":"array","description":"The fields contained in the section","items":{"$ref":"#/components/schemas/AnswerField"}}}},"FileUpload":{"title":"FileUpload","type":"object","properties":{"name":{"type":"string","description":"Original filename of the uploaded file"},"size":{"type":"number","description":"Size of the file in bytes"},"type":{"type":"string","description":"MIME type of the file, e.g. `application/pdf`"},"file_id":{"type":"string","format":"uuid","description":"ID of the uploaded file"},"download_url":{"type":"string","description":"The API endpoint URL from which the file can be downloaded","format":"uri"}}},"Agent":{"title":"Agent","type":"object","properties":{"agent_id":{"type":"string","format":"uuid","description":"A unique identifier for the Agent."},"email":{"type":"string","description":"Agent's email","format":"email"},"first_name":{"type":"string","description":"Agent's first name"},"last_name":{"type":"string","description":"Agent's last name"},"role":{"type":"string","enum":["ADMIN","AGENT"],"description":"Agent's Role"}}},"AgentInfo":{"title":"AgentInfo","type":"object","properties":{"agent_info_id":{"type":"string","description":"ID of the AgentInfo","format":"uuid"},"address_id":{"type":["string","null"],"description":"Address ID where the agent/agency is located","format":"uuid"},"agency_name":{"type":["string","null"],"description":"Name of the agency (agency_name or agent_full_name required)"},"agent_full_name":{"type":["string","null"],"description":"Name of the agent (agency_name or agent_full_name required)"},"phone_number":{"type":["string","null"],"description":"Phone number for the agent/agency"},"email":{"type":["string","null"],"description":"Email for the agent/agency"},"policy_ids":{"type":"array","description":"Policy ID's associated to the agent","items":{"type":"string","format":"uuid"}}}},"Driver":{"title":"Driver","type":"object","properties":{"driver_id":{"type":"string","format":"uuid","description":"ID of the driver"},"first_name":{"type":["string","null"],"description":"First name of driver"},"middle_name":{"type":["string","null"],"description":"Middle name of driver"},"last_name":{"type":["string","null"],"description":"Last name of driver"},"drivers_license":{"type":["string","null"],"description":"Driver's license number"},"drivers_license_state":{"type":["string","null"],"description":"State of Driver's license"},"date_of_birth_str":{"type":["string","null"],"description":"Driver's date of birth"},"gender":{"$ref":"#/components/schemas/WebhookBody/properties/data/anyOf/0/properties/updates/items/anyOf/3/properties/data/properties/gender","description":"Driver's gender"},"marital_status":{"$ref":"#/components/schemas/WebhookBody/properties/data/anyOf/0/properties/updates/items/anyOf/3/properties/data/properties/marital_status","description":"Driver's marital status"},"relationship_to_insured":{"type":["string","null"],"enum":["INSURED","SPOUSE","BROTHER","SISTER","FATHER","MOTHER","DAUGHTER","SON","CHILD","RELATIVE","DOMESTIC_PARTNERSHIP"],"description":"Relationship to the insured"},"age":{"type":["integer","null"],"description":"Driver's age"},"age_on_date":{"type":["string","null"],"description":"Date reference for driver's age"},"education":{"$ref":"#/components/schemas/WebhookBody/properties/data/anyOf/0/properties/updates/items/anyOf/3/properties/data/properties/education","description":"Driver's education"},"occupation":{"type":["string","null"],"description":"Driver's occupation"},"age_licensed":{"type":["integer","null"],"description":"Age at which driver was licensed"}}},"Document":{"title":"Document","type":"object","properties":{"document_id":{"type":"string","format":"uuid","description":"ID of the document"},"title":{"type":"string","description":"Title of Document"},"date_added":{"type":["string","null"],"description":"Effective date of Document","format":"date-time"},"document_type":{"type":["string","null"],"enum":["INSURANCE_APPLICATION","INSURANCE_BINDER","DECLARATIONS","ENDORSEMENT","INSURANCE_ID_CARD","VERIFICATION_OF_INSURANCE"],"description":"Type of Document"},"policy_id":{"type":["string","null"],"description":"Policy Id that the document belongs to","format":"uuid"},"mime_type":{"enum":["application/pdf","image/jpeg"],"description":"The file type of the Document"},"download_url":{"type":"string","description":"The API endpoint URL from which the document can be downloaded","format":"uri"}}},"EnrichmentDriverLicense":{"title":"EnrichmentDriverLicense","type":"object","properties":{"driver_license_id":{"type":"string","format":"uuid","description":"Canopy Connect Driver License lookup ID."},"driver_license":{"title":"EnrichmentDriverData","type":"object","properties":{"first_name":{"type":"string","description":"The first name of the person."},"middle_name":{"type":["string","null"],"description":"The middle name of the person."},"last_name":{"type":"string","description":"The last name of the person."},"date_of_birth_str":{"type":["string","null"],"description":"The date of birth of the person."},"drivers_license":{"type":["string","null"],"description":"The driver's license number."},"drivers_license_state":{"type":["string","null"],"description":"The state where the driver's license was issued."},"gender":{"type":["string","null"],"description":"The reported gender of the driver."},"marital_status":{"type":["string","null"],"description":"The marital status of the driver."}}}}},"EnrichmentDrivingRecordIq":{"title":"EnrichmentDrivingRecordIq","type":"object","properties":{"driving_record_iq_id":{"type":"string","format":"uuid","description":"Canopy Connect Driving Record IQ lookup ID."},"driving_record_iq":{"type":"object","properties":{"status":{"type":["string","null"],"enum":["CLEAN","NO_EVIDENCE","MINOR_VIOLATIONS","MAJOR_VIOLATIONS"]},"minor_violations":{"type":"integer","default":0},"last_minor_violation_date_str":{"type":["string","null"]},"major_violations":{"type":"integer","default":0},"last_major_violation_date_str":{"type":["string","null"]}}}}},"EnrichmentHousehold":{"title":"EnrichmentHousehold","type":"object","properties":{"household_id":{"type":"string","format":"uuid","description":"Canopy Connect Household lookup ID"},"drivers":{"type":"array","items":{"$ref":"#/components/schemas/EnrichmentDriverLicense/properties/driver_license"}},"vehicles":{"type":"array","items":{"title":"EnrichmentVehicleData","type":"object","properties":{"vin":{"type":["string","null"],"description":"The VIN of the vehicle."},"year":{"type":["integer","null"],"description":"The model year of the vehicle."},"make":{"type":["string","null"],"description":"The make of the vehicle."},"model":{"type":["string","null"],"description":"The model of the vehicle."},"series":{"type":["string","null"],"description":"The series of the vehicle."},"series2":{"type":["string","null"],"description":"The series2 of the vehicle."},"type":{"type":["string","null"],"description":"The type of the vehicle, based on state registration."},"ownership_type":{"type":["string","null"],"enum":["OWN","FINANCE","LEASE"],"description":"The ownership type of the vehicle."},"lien_holder":{"type":["string","null"],"description":"The lienholder of the vehicle."},"purchase_date":{"type":["string","null"],"format":"date-time","description":"The purchase date of the vehicle."}}}}}},"EnrichmentPropertyData":{"title":"EnrichmentPropertyData","type":"object","properties":{"address":{"$ref":"#/components/schemas/Address/allOf/1"},"data":{"$ref":"#/components/schemas/PropertyData/allOf/1"}}},"Vehicle":{"title":"Vehicle","type":"object","properties":{"vehicle_id":{"type":"string","format":"uuid","description":"ID of the vehicle"},"year":{"type":["integer","null"],"description":"Vehicle year"},"make":{"type":["string","null"],"description":"Vehicle make"},"model":{"type":["string","null"],"description":"Vehicle model"},"series":{"type":["string","null"],"description":"Vehicle series"},"series2":{"type":["string","null"],"description":"Vehicle series 2"},"type":{"type":["string","null"],"description":"Vehicle type"},"annual_mileage":{"type":["integer","null"],"description":"Vehicle annual mileage"},"vin":{"type":["string","null"],"description":"Vehicle identification number"},"hin":{"type":["string","null"],"description":"Boat hull identification number"},"serial_number":{"type":["string","null"],"description":"Vehicle serial number"},"uses":{"type":["array","null"],"description":"Vehicle uses","items":{"enum":["PERSONAL","COMMUTE","WORK","SCHOOL","PLEASURE","FARM"]}},"purchase_date":{"type":["string","null"],"description":"Vehicle purchase date","format":"date-time"},"ownership_type":{"type":["string","null"],"enum":["OWN","FINANCE","LEASE"],"description":"Vehicle ownership type"},"features":{"type":["array","null"],"description":"Vehicle features","items":{"type":"string"}},"is_removed":{"type":"boolean","description":"Whether or not the Vehicle is excluded from the Policy"},"lien_holder":{"type":["string","null"],"description":"Vehicle lien holder name"},"garaging_address":{"type":["object","null"],"$ref":"#/components/schemas/Address"},"lien_holder_address":{"type":["object","null"],"$ref":"#/components/schemas/Address"},"coverages":{"type":"array","uniqueItems":true,"description":"List of vehicle coverage objects","items":{"$ref":"#/components/schemas/VehicleCoverage"}},"drivers":{"type":"array","uniqueItems":true,"description":"List of driver objects","items":{"$ref":"#/components/schemas/VehicleDriver"}}}},"VehicleCoverage":{"title":"VehicleCoverage","type":"object","description":"ID of the vehicle coverage","properties":{"vehicle_coverage_id":{"type":"string","format":"uuid"},"premium_group_id":{"type":["string","null"],"description":"ID of the premium group if apart of one","format":"uuid"},"name":{"$ref":"#/components/schemas/ServicingAction/allOf/1/oneOf/3/allOf/1/properties/confirmation_data/anyOf/0/properties/coverage_selections/propertyNames","description":"Name of coverage item"},"friendly_name":{"type":"string","enum":["Single Limit Liability","Bodily Injury Liability","Property Damage Liability","Supplemental Spousal Liability","Supplemental Spousal Bodily Injury Liability","Supplemental Spousal Property Damage Liability","Personal Injury Protection","Comprehensive","Full Glass","Collision Deductible Waiver","Collision","Uninsured Motorists","Uninsured Motorist Bodily Injury Liability","Uninsured Motorist Property Damage Liability","Uninsured Motorist Bodily Injury & Property Damage Liability","Underinsured Motorists","Underinsured Motorist Bodily Injury Liability","Underinsured Motorist Property Damage Liability","Underinsured Motorist Bodily Injury & Property Damage Liability","Uninsured / Underinsured Motorists","Uninsured / Underinsured Motorist Bodily Injury Liability","Uninsured / Underinsured Motorist Property Damage Liability","Uninsured / Underinsured Motorist Bodily Injury & Property Damage Liability","Towing and Labor","Loan or Lease Assistance","Rideshare Gap Protection","Medical Payments","Emergency Road Service","Rental Reimbursement","Car Rental and Travel Expenses","Portable Electronics","Mechanical Breakdown","Supplemental Uninsured / Underinsured Motorists","Emergency Expense","Replacement Cost Personal Effects","Vacation Liability Coverage","RV Medical","Extended Benefits","Wage Earner Disability Benefits","Essential Services Disability Benefits","Death Benefit","Car Replacement Assistance","Full Tort","Limited Tort","Combined Single Limit","Spare Parts","Optional Bodily Injury Liability","Motor Cargo","On Hook","First Party Benefit","First Party Benefit - Medical Expense","First Party Benefit - Accidental Death","First Party Benefit - Income Loss","First Party Benefit - Funeral Expense","First Party Benefit - Extraordinary Medical","First Party Benefit - Survivors Loss","Custom Parts and Equipment","Vehicle Protection","Funeral Benefit","Survivors Loss Benefit"],"description":"Friendly name of coverage item"},"premium_cents":{"type":["integer","null"],"description":"Premium paid for coverage item, in cents"},"per_person_limit_cents":{"type":["integer","null"],"description":"Per-person limit, in cents"},"per_person_unlimited":{"type":"boolean","description":"If true, this coverage has an unlimited per-person limit"},"per_incident_limit_cents":{"type":["integer","null"],"description":"Per-incident limit, in cents"},"per_incident_unlimited":{"type":"boolean","description":"If true, this coverage has an unlimited per-incident limit"},"per_day_limit_cents":{"type":["integer","null"],"description":"Per-day limit, in cents"},"max_days":{"type":["integer","null"],"description":"Max days, comes in pairs with `per_day_limit_cents`"},"deductible_cents":{"type":["integer","null"],"description":"Deductible, in cents"},"actual_cash_value":{"type":"boolean","description":"If true, this coverage is Actual Cash Value"},"is_declined":{"type":"boolean","description":"If true, this coverage item was declined"},"is_stacked":{"type":["boolean","null"],"description":"If true, this coverage has stacked limits; if false, explicitly non-stacked; if null, stacking not applicable or unknown"},"pip_deductible_applicability":{"type":["string","null"],"enum":["NAMED_INSURED","NAMED_INSURED_AND_RESIDENT_RELATIVES"],"description":"Who the PIP deductible applies to"},"per_mile_premium_tenth_of_cents":{"type":["integer","null"],"description":"Premium per mile, in tenth of cents"}}},"VehicleDriver":{"title":"VehicleDriver","type":"object","properties":{"driver_id":{"type":"string","format":"uuid","description":"ID of the driver"},"first_name":{"type":["string","null"],"description":"First name of driver"},"middle_name":{"type":["string","null"],"description":"Middle name of driver"},"last_name":{"type":["string","null"],"description":"Last name of driver"},"drivers_license":{"type":["string","null"],"description":"Driver's license number"},"drivers_license_state":{"type":["string","null"],"description":"State of Driver's license"},"date_of_birth_str":{"type":["string","null"],"description":"Driver's date of birth"},"gender":{"type":["string","null"],"enum":["MALE","FEMALE","NONBINARY"],"description":"Driver's gender"},"marital_status":{"type":["string","null"],"enum":["SINGLE","MARRIED","DIVORCED","WIDOWED","SEPARATED","CIVIL_UNION"],"description":"Driver's marital status"},"relationship_to_insured":{"type":["string","null"],"enum":["INSURED","SPOUSE","BROTHER","SISTER","FATHER","MOTHER","DAUGHTER","SON","CHILD","RELATIVE","DOMESTIC_PARTNERSHIP"],"description":"Relationship to the insured"},"age":{"type":["integer","null"],"description":"Driver's age"},"age_on_date":{"type":["string","null"],"description":"Date reference for driver's age"},"education":{"type":["string","null"],"description":"Driver's education","enum":["LESS_THAN_HIGH_SCHOOL","HIGH_SCHOOL","SOME_COLLEGE","BACHELORS","DOCTORS","ASSOCIATES","MASTERS","LAW","VOCATIONAL","PHD","HIGH_SCHOOL_GED","COLLEGE_DEGREE","IN_COLLEGE","GRADUATE_WORK"]},"occupation":{"type":["string","null"],"description":"Driver's occupation"},"age_licensed":{"type":["integer","null"],"description":"Age at which driver was licensed"},"is_excluded":{"type":"boolean","description":"Whether or not the Driver is excluded from the Policy or Vehicle"}}},"Dwelling":{"title":"Dwelling","type":"object","properties":{"dwelling_id":{"type":"string","format":"uuid","description":"ID of the dwelling"},"address":{"type":"object","$ref":"#/components/schemas/Address","description":"Address of the dwelling"},"coverages":{"type":"array","uniqueItems":true,"description":"List of dwelling coverage objects","items":{"$ref":"#/components/schemas/DwellingCoverage"}},"mortgagees":{"type":"array","uniqueItems":true,"description":"List of mortgagee objects","items":{"$ref":"#/components/schemas/Mortgagee"}},"mortgagee_name":{"type":["string","null"],"description":"[DEPRECATED] Name of the mortgagee. Please use mortgagees instead.","deprecated":true},"mortgagee_address":{"type":["object","null"],"$ref":"#/components/schemas/Address","description":"[DEPRECATED] Address of the mortgagee. Please use mortgagees instead.","deprecated":true},"mortgage_loan_number":{"type":["string","null"],"description":"[DEPRECATED] Loan number of the mortgage. Please use mortgagees instead.","deprecated":true},"replacement_cost_cents":{"type":["integer","null"],"description":"Replacement cost in cents"},"cash_value_cents":{"type":["integer","null"],"description":"Cash value in cents"},"property_data":{"type":["object","null"],"$ref":"#/components/schemas/PropertyData","description":"Dwelling property data. Your plan must include property data in order to access this API in production. For more information, contact your Canopy Connect representative."},"loss_settlement_type":{"type":["string","null"],"description":"The loss settlement provision for the dwelling","enum":["REPLACEMENT_COST","ACTUAL_CASH_VALUE"]},"extended_replacement_cost_percent":{"type":["integer","null"],"description":"The increased limit of liability for the DWELLING coverage (Coverage A), in percent","maximum":100,"minimum":0},"total_replacement_cost_cents":{"type":["integer","null"],"description":"Total replacement cost in cents, calculated as the base replacement cost plus any extended replacement cost coverage. Formula: replacement_cost_cents * (1 + extended_replacement_cost_percent/100)"},"is_replacement_cost_cents_derived":{"type":"boolean","description":"A boolean flag indicating whether the replacement cost amount was derived from the dwelling coverage limit"}}},"DwellingCoverage":{"title":"DwellingCoverage","type":"object","properties":{"dwelling_coverage_id":{"type":"string","format":"uuid","description":"ID of the dwelling coverage"},"name":{"type":"string","enum":["ADDITIONAL_LIVING_EXPENSE","ALL_OTHER_PERILS","ALL_PERILS","BASE","BICYCLE","BUILDING","BUILDING_CODES","BUSINESS_PROPERTY","CAMERA","CONTENTS","DAMAGE_TO_PROPERTY_OF_OTHERS","DANGEROUS_DOG_AND_EXOTIC_ANIMAL_LIABILITY","DWELLING","EARTHQUAKE","EQUIPMENT_BREAKDOWN","FAMILY_LIABILITY_PROTECTION","FASHION_ITEMS","FINE_ART","FIRE_DEPARTMENT_SERVICE_CHARGE","FLOOD","FUNGI_BACTERIA_AND_MOLD","GUEST_MEDICAL_PROTECTION","HURRICANE","ICC","IDENTITY_THEFT","JEWELRY","LOSS_ASSESSMENTS","LOSS_OF_USE","MEDICAL_PAYMENTS","MUSICAL_INSTRUMENT","NAMED_STORM","ORDINANCE_OR_LAW","OTHER_STRUCTURES","PERSONAL_INJURY_PROTECTION","PERSONAL_LIABILITY","PERSONAL_PROPERTY","PET_DAMAGE","PORTABLE_ELECTRONICS","PREMISES_LIABILITY","REFRIGERATED_PROPERTY","REPLACEMENT_COST_CONTENTS","REPLACEMENT_COST_DWELLING","REPLACEMENT_COST_FULL_VALUE","SERVICE_LINE","SPECIAL_COMPUTER_COVERAGE","TENANT_WATER_DAMAGE_LIABILITY","WATER_BACKUP_AND_SUMP_OVERFLOW","WINDSTORM_OR_HAIL"],"description":"Name of coverage item"},"friendly_name":{"type":"string","enum":["Additional Living Expense","All Other Perils","All Perils","Base Liability","Bicycle","Building","Building Codes","Business Property Liability","Camera","Contents","Damage to Property of Others","Dangerous Dog and Exotic Animal Liability","Dwelling","Earthquake","Equipment Breakdown","Family Liability Protection","Fashion Items","Fine Art","Fire Department Service Charge","Flood","Fungi, Bacteria, and Mold","Guest Medical Protection","Hurricane","Increased Cost of Compliance","Identity Theft","Jewelry","Loss Assessments","Loss of Use","Medical Payments","Musical Instrument","Named Storm","Ordinance or Law","Other Structures","Personal Injury Protection","Personal Liability","Personal Property","Pet Damage","Portable Electronics","Premises Liability","Refrigerated Property","Replacement Cost - Contents","Replacement Cost - Dwelling","Replacement Cost - Full Value","Service Line","Special Computer Coverage","Tenant Water Damage Liability","Water Backup and Sump Overflow","Windstorm or Hail"],"description":"Friendly name of coverage item"},"premium_cents":{"type":["integer","null"],"description":"Premium paid for coverage item, in cents"},"per_person_limit_cents":{"type":["integer","null"],"description":"Per-person limit, in cents"},"per_person_unlimited":{"type":["boolean","null"],"description":"If true, this coverage has an unlimited per-person limit"},"per_incident_limit_cents":{"type":["integer","null"],"description":"Per-incident limit, in cents"},"per_incident_limit_percent":{"type":["string","null"],"description":"Percentage of Dwelling (Coverage A) limit. Example: `2.500`","example":"2.500"},"per_incident_unlimited":{"type":["boolean","null"],"description":"If true, this coverage has an unlimited per-incident limit"},"per_incident_limit_months":{"type":["integer","null"],"description":"Duration in months for per-incident limit (e.g., 12 for a 12-month aggregate)"},"deductible_cents":{"type":["integer","null"],"description":"Deductible, in cents"},"deductible_percent":{"type":["string","null"],"description":"Percentage of Dwelling (Coverage A) limit. Example: `2.500`","example":"2.500"},"is_declined":{"type":"boolean","description":"If true, this coverage item was declined"}}},"PropertyData":{"title":"PropertyData","type":"object","allOf":[{"properties":{"property_data_id":{"type":"string","format":"uuid","description":"ID of the property data"},"dwelling_id":{"type":"string","format":"uuid","description":"ID of the dwelling this property data belongs to"}}},{"title":"PropertyData","type":"object","properties":{"apn":{"type":["string","null"],"description":"The Assessor's Parcel Number of the dwelling"},"class":{"type":["string","null"],"enum":["AGRICULTURAL","AMUSEMENT_RECREATION","APARTMENT","COMMERCIAL","COMMERCIAL_CONDOMINIUM","CONDOMINIUM_RESIDENTIAL","DUPLEX_TRIPLEX_QUADPLEX","EXEMPT","FINANCIAL_INSTITUTION","HOSPITAL","HOTEL_MOTEL","INDUSTRIAL","INDUSTRIAL_HEAVY","INDUSTRIAL_LIGHT","MISCELLANEOUS","OFFICE_BUILDING","PARKING","RETAIL","SERVICE","SINGLE_FAMILY_RESIDENCE_TOWNHOUSE","TRANSPORT","UTILITIES","VACANT"],"description":"The class of the dwelling"},"sub_type":{"type":["string","null"],"enum":["AGRICULTURE_FARMING","COMMERCIAL","INDUSTRIAL","OTHER","OTHER_UNKNOWN","PUBLIC_WORKS","RESIDENTIAL","VACANT_LAND"],"description":"The sub type of the dwelling"},"year_built":{"type":["integer","null"],"description":"The year the dwelling was built"},"construction_type":{"type":["string","null"],"enum":["A_FRAME","ADOBE","ALUMINUM_FRAME","ALUMINUM_SIDING","ALUMINUM_VINYL","ARCHED_DOME","BLOCK_BRICK","BLOCK_METAL","BLOCK_STEEL","BRICK","BRICK_CINDER_BLOCK","BRICK_CONCRETE","BRICK_FRAME","BRICK_METAL","BRICK_STEEL","BRICK_STONE","BRICK_STUCCO","CINDER_BLOCK","CLAPBOARD","COMBINATION","CONCRETE","CONCRETE_BLOCK","CONCRETE_MASONRY","CONCRETE_STEEL","CUSTOM","DOME","FLEXIBLE_FLEXICORE","FRAME","FRAME_MASONRY","FRAME_STEEL","FRAME_STUCCO","GLASS","HEAVY","LIGHT","LOG","MANUFACTURED_MODULAR","MASONRY","MASONRY_TILT_UP","METAL","NONE","POLE_FRAME","PREFAB_METAL","STEEL","STEEL_MASONRY","STEEL_STUCCO","STEEL_WOOD","STONE_VENEER","STONE_ROCK","STUCCO","TILT_UP","TILT_UP_BRICK_METAL","TILT_UP_CONCRETE","TYPE_NOT_SPECIFIED","TYPE_UNKNOWN","WOOD","WOOD_FRAME","WOOD_FRAME_CONCRETE_BLOCK","WOOD_FRAME_METAL","WOOD_BRICK","WOOD_STEEL","WOOD_STONE","WOOD_STUCCO"],"description":"The construction material used to build the dwelling"},"wall_type":{"type":["string","null"],"enum":["$2X2_FRAME","$2X3_FRAME","$2X4_FRAME","$2X6_FRAME","$8_INCH_PAINT","ADOBE","ALUMINUM_LAP","ALUMINUM_SIDING","ALUMINUM_VINYL","ASBESTOS","ASBESTOS_FRAME","ASPHT_SHINGLE","BAKED_ENAMEL","BAT_BOARD","BEVEL_FINISHING_STYLE","BLOCK","BLOCK_MASONRY","BOARD_BATTEN","BRICK","BRICK_FRAME_STONE","BRICK_VENEER","BRICK_STONE_BRICK_AND_OR_STONE","BRICK_WOOD","BUTTRESSED","CEDAR","CERAMIC_TILE","CHANNEL","CINDER_BLOCK","CLAY_TILE","COMB","COMBINATION","COMPOSITION_COMPOSITE","CONCRETE","CONCRETE_BLOCK","CONCRETE_BLOCK_STUCCO","CONCRETE_TILE","CONCRETE_CINDER_BLOCK","CURTAIN","DIAGONAL","DROP","EIFS_SYNTHETIC_STUCCO","FARM_SINGLE","FIBER_CEMENT_SIDING_HARDI_BOARD_HARDI_PLANK","FRAME_BRICK","FRAME_SIDING","FRAME_ALUMINUM","FRAME_MASONRY","FRAME_MASONRY_VENEER","FRAME_SHINGLE_SIDING","FRAME_STONE","FRAME_STUCCO","FRAME_VINYL","FRAME_WOOD","GLASS","HARDWOOD_SIDING","HORIZONTAL","LAP","LOG_1_2_ROUND","LOGS","MARBLE","MARBLECRETE","MASONITE","MASONRY_STUCCO","METAL","METAL_SIDING","MODULAR","NONE","NOT_AVAILABLE","NP","OTHER","OTHER_NOT_CLASSIFIED","PANEL","PAPER","PLYWOOD","POLE","PRE_CAST","PRECAST_CONCRETE_PANEL","PREFAB_WOOD","PROTECTIVE_TREATMENT","RIBBED","RIBBED_ALUMINUM","RUSTIC","SHAKE","SHINGLES","SIDING","SIDING_ALUM_VINYL","SIDING_NOT_SPECIFIED","SINGLE_WALL","SLUMP_BLOCK","STEEL_PANEL","STONE","STONE_VENEER","STONE_WOOD_FRAME","STRUT_FRAME","STUCCO","T111","TBD","TILE","TONG_GROOVE","UNKNOWN","VERTICAL","VINYL","WOOD","WOOD_FRAME","WOOD_FRAME_SIDING","WOOD_SHINGLE","WOOD_SIDING","WOOD_STEEL_STUD"],"description":"The wall type of the dwelling"},"foundation_type":{"type":["string","null"],"enum":["BLOCK","BLOCK_UNSPECIFIED","BRICK","BRICK_UNSPECIFIED","CLOSED_PIERS","CONCRETE","CONCRETE_BEAM_SLAB","CONCRETE_BLOCK","CONCRETE_BEAM","CONTINUOUS_FOOTING","CONTINUOUS_WALL","CROSS_BRIDGED_WALLS","DIRT_EARTH","FOOTING","FOOTING_CONTINUOUS_STRIP","FOOTING_SPREAD","GRADE_BEAM","MASONRY","MASONRY_UNSPECIFIED","MAT_RAFT_FOUNDATION","MUD_SILL","NO_FOUNDATION","NONE","NOT_STATED","NP","OPEN_PIERS","PIER","PIER_POST_CONCRETE","PIER_POST_WOOD","PIER_POST_BEAM","PILE","PILE_CONCRETE","PILE_END_BEARING","PILE_FRICTION","PILE_WOOD_TIMBER","PILINGS","PIPE_IRON","PRE_FAB","RAISED","RAISED_UNSPECIFIED","RAISED_BASEMENT","RAISED_CRAWLSPACE","RETAINING_WALL","SLAB","SPREAD_FOOTING","STANDARD","STEEL","STEM_WALL","STEM_WALL_CRAWLSPACE","STONE","STONE_UNSPECIFIED","TYPE_NOT_SPECIFIED","TYPE_UNKNOWN","TYPE_UNKNOWN_BASEMENT","TYPE_UNKNOWN_CRAWLSPACE","TYPE_UNKNOWN_PART_BASEMENT","UNAVAILABLE","UNKNOWN","WOOD","WOOD_UNSPECIFIED"],"description":"The foundation type of the dwelling"},"frame_type":{"type":["string","null"],"enum":["ALUMINUM_FRAME","CONCRETE","CONCRETE_STEEL","CUSTOM","FIRE_RESISTANT","MASONRY","PRE_FAB","STEEL","TYPE_UNKNOWN","WOOD"],"description":"The frame type of the dwelling"},"roof_cover":{"type":["string","null"],"enum":["ALUMINUM","ASBESTOS","ASPHALT","AVERAGE_COMPOSITION_SHINGLE","BAR_TILE_SPANISH_STYLE","BI_METAL_TWO_PLY","BUILTUP_LAYERED_ASPHALT","CLAY_TILE","COMPOSITION_SHINGLE","CONCRETE","CONCRETE_TILE","ENAMEL","FIBERGLASS","GALVANIZED","GYPSUM","HEAVY_COMPOSITION_SHINGLE","LIGHT_COMPOSITION_SHINGLE","MASONITE_CEMENT_SHAKE","MEDIUM_SHAKE","METAL","NOT_AVAILABLE","NP","OTHER_NOT_CLASSIFIED","ROCK_GRAVEL","ROLL_COMPOSITION_ROLLED_MINERAL_ROOF","ROLL_PAPER_ROLLED_SMOOTH_ROOF","ROLL_TAR_GRAVEL","RUBBER_ELASTOMETRIC","SHAKE","SHINGLE","SLATE","SLATE_TILE","SYNTHETIC_TILE","TILE","UNKNOWN","UNKNOWN_OR_NOT_PROVIDED","URETHANE","WOOD","WOOD_SHAKE_SHINGLE","WOOD_SHINGLE"],"description":"The roof cover type of the dwelling"},"roof_shape":{"type":["string","null"],"enum":["A_FRAME","ARCHED","BARN","BARREL","BOWSTRING_TRUSS","BUBBLE","BUTTERFLY","CANOPY","CATHEDRAL_CLERESTORY","COMPLEX_CUSTOM","CONTEMPORARY","DORMER","FLAT","FRAME","GABLE","GABLE_HIP","GAMBREL","GAMBREL_MANSARD","GEODESIC_DOME","HIP","MANSARD","MONITOR","OTHER","PITCHED","PRESTRESS_CONCRETE","PYRAMID","REINFORCED_CONCRETE","RIGID_FRM_BAR_JT","SAWTOOTH","SHED","STEEL_FRM_TRUSS","SWISS_CHALET_ALPINE","WOOD_TRUSS"],"description":"The shape of the dwelling's roof"},"cooling_type":{"type":["string","null"],"enum":["AC_CENTRAL","AC_CENTRAL_AND_UNIT","AC_CENTRAL_PARTIAL","AC_COMMERCIAL_AC","AC_DUAL_UNIT","AC_EVAPORATIVE","AC_HEAT_PUMP","AC_NONE","AC_OFFICE_ONLY","AC_PACKAGE_ROOF","AC_PARTIAL","AC_REFRIGERATION","AC_REFRIGERATION_EVAPORATION","AC_SEPARATE_SYSTEM","AC_SOLAR","AC_SPLIT_SYSTEM","AC_WALL_UNIT","AC_WALL_WINDOW_UNIT","AC_WINDOW_UNIT","BYPASS","CENTRAL","CHILLED_WATER","EVAPORATIVE","EVAPORATIVE_WALL_UNIT","FAN_COOLING","GEO_THERMAL","NONE","NOT_AVAILABLE","NOT_PROVIDED","OTHER","PACKAGE","PARTIAL","REFRIGERATION_WALL_UNIT","REFRIGERATOR","REFRIGERATOR_EVAPORATIVE","SOLAR","UNKNOWN","WALL_UNIT","WINDOW_AC","WINDOW_EVAPORATIVE","YES"],"description":"The type of cooling the dwelling has"},"heating_type":{"type":["string","null"],"enum":["BASEBOARD","CEILING_CABLE","CEILING_FURNACE","CENTRAL","COAL","CONVECTION","ELECTRIC","FIREPLACE","FLOOR_FURNACE","FLOOR_WALL_FURNACE","FORCED_AIR","FORCED_AIR_WITH_AIR_CONDITIONING","GAS","GEO_THERMAL","GRAVITY","HEAT_PUMP","HOT_WATER","NONE","NOT_AVAILABLE","NP","OIL","OTHER","PACKAGE","PARTIAL","PROPANE","RADIANT","SOLAR","SPACE","STEAM","STOVE","UNKNOWN","WALL_GAS","WOOD_FURNACE","YES","ZONE"],"description":"The type of heating the dwelling has"},"heating_fuel":{"type":["string","null"],"enum":["COAL","ELECTRIC","ELECTRIC_HOT_WATER","GAS","GEO_THERMAL","HEAT_PUMP","LIQUEFIED_PETROLEUM_GAS","NONE","NOT_AVAILABLE","NOT_PROVIDED","OIL","OTHER","PROPANE","SOLAR","SOLID","TYPE_UNKNOWN","WOOD"],"description":"The type of heating fuel the dwelling uses"},"energy_type":{"type":["string","null"],"enum":["ABOVE_STANDARD","AVAILABLE","AVERAGE","BELOW_STANDARD","DEVELOPED","FAIR","GOOD","NO","NOT_AVAILABLE","NP","OVERHEAD","POOR","STANDARD","UNDERGROUND","UNKNOWN","YES"],"description":"The type of energy supplied to the dwelling"},"sewer_type":{"type":["string","null"],"enum":["BYPASS","CESSPOOL","COMMERCIAL","DEVELOPED","MUNICIPAL","NONE","NOT_AVAILABLE","NP","PRIVATE","PUBLIC","PUBLIC_SEPTIC","SANITARY","SEPTIC","STORM","UNKNOWN","YES"],"description":"The type of sewer the dwelling has"},"building_shape":{"type":["string","null"],"enum":["OTHER","COMPLEX","C_SHAPED","IRREGULAR","L_SHAPED","RECTANGLE","SLIGHTLY_IRREGULAR","SQUARE","VERY_IRREGULAR"],"description":"The shape of the dwelling"},"construction_quality":{"type":["string","null"],"enum":["AVERAGE","CABIN","EXCELLENT","FAIR","GOOD","HIGH_QUALITY_RESIDENTIAL","LOW","NOT_AVAILABLE","NP","OTHER","UNKNOWN","VERY_GOOD"],"description":"The construction quality of the dwelling"},"has_fireplace":{"type":["boolean","null"],"description":"Whether the dwelling has a fireplace"},"num_fireplaces":{"type":["integer","null"],"description":"The number of fireplaces the dwelling has"},"fireplace_type":{"type":["string","null"],"enum":["$1_STORY_BRICK","$2_STORY","$2_STORY_BRICK","BACKED","CEILING_HIGH_BRICK","CUSTOM","DOUBLE","ELECTRIC","FLUE_ONLY","GLASS_LOG","HEATER_CIRCLE","MASONRY","NOT_AVAILABLE","NOT_PROVIDED","NP","PREFAB","RAISED_HEARTH","SEE_THRU","SINGLE","STACKED","WOOD_STOVE","YES"],"description":"The type of fireplace the dwelling has"},"has_pool":{"type":["boolean","null"],"description":"Whether the dwelling has a pool"},"pool_type":{"type":["string","null"],"enum":["OTHER","ABOVE_GROUND_POOL","ADULT_KIDDIE_POOLS","BUMPER_BOAT","CONCRETE_VINYL","FISH_POND","HEATED_POOL_GUNITE","INDOOR_POOL","IN_GROUND_POOL","IN_GROUND_VINYL_POOL","KIDDIE_PLAY_POOL","LAGOON","LAP_POOL","MULTIPLE_POOLS_UNSPECIFIED","NO_POOL","NOT_STATED","POOL_SPA_WITH_DECK","POOL_CONCRETE_WITH_CABANA_POOL_HOUSE","POOL_CONCRETE_WITH_EQUIPMENT","POOL_CONCRETE_FENCED","POOL_GUNITE_WITH_HOT_TUB_SPA","POOL_GUNITE_WITH_PATIO","POOL_GUNITE_ENCLOSED","POOL_GUNITE_KIDNEY_SHAPED","POOL_IN_GROUND_WITH_HOT_TUB_SPA","POOL_UNSPECIFIED_WITH_COVER","POOL_UNSPECIFIED_WITH_DECK","POOL_UNSPECIFIED_ENCLOSED","POOL_UNSPECIFIED_FENCED","POOL_UNSPECIFIED_HEATED","POOL_VINYL_WITH_DECK","POOL_VINYL_WITH_PATIO","POOL_VINYL_KIDNEY_SHAPED","POOL_VINYL_L_SHAPED","POOL_VINYL_OVAL_SHAPED","POOL_WITH_BAR","POOL_WITH_CABANA_POOL_HOUSE","POOL_WITH_CANOPY","POOL_WITH_DIVING_BOARD","POOL_WITH_EQUIPMENT","POOL_WITH_FOUNTAIN","POOL_WITH_HOT_TUB_SPA","POOL_WITH_PATIO","POOL_WITH_SAUNA","POOL_WITH_WATERFALL","POOL_ARROW_SHAPED","POOL_BRICK_MASONRY_STONE","POOL_CIRCULAR","POOL_CONCRETE","POOL_FIBERGLASS","POOL_GUNITE","POOL_IRREGULAR_SHAPED","POOL_KIDNEY_SHAPED","POOL_L_SHAPED","POOL_METAL","POOL_OVAL_SHAPED","POOL_PLASTIC_VINYL_LINED","POOL_PRE_FABRICATED_VINYL","POOL_SOLAR_HEATED","POOL_STONE_GRANITE","POOL_VINYL_LINING_STEEL_WALLED","POOLS_THREE_PLUS_UNSPECIFIED","POOLS_TWO_UNSPECIFIED","PUBLIC_MUNICIPAL_COMMERCIAL","SAUNA_SPA_ONLY","SAUNA_ONLY","SPA_GAZEBO_ONLY","SPA_HOT_TUB_DECK_ONLY","SPA_HOT_TUB_ONLY","TYPE_NOT_SPECIFIED","WADING_POOL"],"description":"The type of pool the dwelling has"},"square_ft":{"type":["integer","null"],"description":"The square footage of the dwelling"},"num_beds":{"type":["integer","null"],"description":"The number of bedrooms the dwelling has"},"num_baths_full":{"type":["integer","null"],"description":"The number of full bathrooms the dwelling has"},"num_baths_partial":{"type":["integer","null"],"description":"The number of partial bathrooms the dwelling has"},"num_stories":{"type":["integer","null"],"description":"The number of stories the dwelling has"},"num_units":{"type":["integer","null"],"description":"The number of units the dwelling has"},"garage_type":{"type":["string","null"],"enum":["CARPORT_FINISHED","ATTACHED_1_CAR","ATTACHED_2_CAR","ATTACHED_3_PLUS_CAR","ATTACHED_FINISHED","ATTACHED_UNFINISHED","CARPORT_UNSPECIFIED","CARPORT_1_CAR","CARPORT_2_CAR","CARPORT_3_PLUS_CAR","CARPORT_ATTACHED","CARPORT_DETACHED","CARPORT_DETACHED_FINISHED","CARPORT_DETACHED_UNFINISHED","CARPORT_ENCLOSED","CARPORT_OPEN","CARPORT_UNFINISHED","COVERED","DETACHED_UNSPECIFIED","DETACHED_1_CAR","DETACHED_2_CAR","DETACHED_3_PLUS_CAR","DETACHED_FINISHED","DETACHED_UNFINISHED","GARAGE_AND_CARPORT","GARAGE_1_CAR","GARAGE_2_CAR","GARAGE_3_PLUS_CAR","GARAGE_ATTACHED","GARAGE_BASEMENT","GARAGE_BASEMENT_1_CAR","GARAGE_BASEMENT_2_CAR","GARAGE_BASEMENT_3_PLUS_CAR","GARAGE_BASEMENT_FINISHED","GARAGE_BASEMENT_FINISHED_1_CAR","GARAGE_BASEMENT_FINISHED_2_CAR","GARAGE_BASEMENT_FINISHED_3_PLUS_CAR","GARAGE_BASEMENT_UNFINISHED","GARAGE_BASEMENT_UNFINISHED_1_CAR","GARAGE_BASEMENT_UNFINISHED_2_CAR","GARAGE_BASEMENT_UNFINISHED_3_PLUS_CAR","GARAGE_BUILT_IN","GARAGE_BUILT_IN_1_CAR","GARAGE_BUILT_IN_2_CAR","GARAGE_BUILT_IN_FINISHED","GARAGE_BUILT_IN_UNFINISHED","GARAGE_DETACHED","GARAGE_ENCLOSED","GARAGE_FINISHED","GARAGE_HEATED","GARAGE_OPEN","GARAGE_TUCKUNDER","GARAGE_UNFINISHED","GARAGE_UNFINISHED_1_CAR","GARAGE_UNFINISHED_2_CAR","GARAGE_UNFINISHED_3_PLUS_CAR","MIXED","NO_GARAGE","NOT_AVAILABLE","NOT_PROVIDED","NOT_STATED","NP","PARKING_STRUCTURE","POLE_BUILDING_GARAGE","TYPE_NOT_SPECIFIED","UNKNOWN"],"description":"The type of garage the dwelling has"},"garage_square_ft":{"type":["integer","null"],"description":"The square footage of the dwelling's garage"},"num_parking_spaces":{"type":["integer","null"],"description":"The number of parking spaces the dwelling has"},"assessed_improvement_value_cents":{"type":["integer","null"],"description":"The assessed improvement value in cents"},"assessed_land_value_cents":{"type":["integer","null"],"description":"The assessed land value in cents"},"assessed_total_value_cents":{"type":["integer","null"],"description":"The assessed total value in cents"},"market_improvement_value_cents":{"type":["integer","null"],"description":"The market improvement value in cents"},"market_land_value_cents":{"type":["integer","null"],"description":"The market land value in cents"},"market_total_value_cents":{"type":["integer","null"],"description":"The market total value in cents"},"owner1_first_name":{"type":["string","null"],"description":"The first owner's first name"},"owner1_last_name":{"type":["string","null"],"description":"The first owner's last name"},"owner2_first_name":{"type":["string","null"],"description":"The second owner's first name"},"owner2_last_name":{"type":["string","null"],"description":"The second owner's last name"},"owner3_first_name":{"type":["string","null"],"description":"The third owner's first name"},"owner3_last_name":{"type":["string","null"],"description":"The third owner's last name"},"owner4_first_name":{"type":["string","null"],"description":"The fourth owner's first name"},"owner4_last_name":{"type":["string","null"],"description":"The fourth owner's last name"},"first_mortgage_amount_cents":{"type":["integer","null"],"description":"The first mortgage amount in cents"},"first_mortgage_lender":{"type":["string","null"],"description":"The first mortgage lender name"},"second_mortgage_amount_cents":{"type":["integer","null"],"description":"The second mortgage amount in cents"},"second_mortgage_lender":{"type":["string","null"],"description":"The second mortgage lender name"},"purchase_date":{"type":["string","null"],"description":"The date the dwelling was purchased","format":"date"},"purchase_price_cents":{"type":["integer","null"],"description":"The purchase price of the dwelling in cents"},"last_update_date":{"type":["string","null"],"description":"The last update date for the property data","format":"date"}}}]},"Claim":{"title":"Claim","type":"object","properties":{"claim_id":{"type":"string","format":"uuid","description":"ID of the claim"},"policy_id":{"type":["string","null"],"description":"ID of the policy the claim is related to","format":"uuid"},"dwelling_id":{"type":["string","null"],"description":"ID of the dwelling the claim is related to","format":"uuid"},"vehicle_id":{"type":["string","null"],"description":"ID of the vehicle the claim is related to","format":"uuid"},"address_id":{"type":["string","null"],"description":"ID of the address where the incident physically occurred","format":"uuid"},"driver_id":{"type":["string","null"],"description":"ID of the driver the claim is related to","format":"uuid"},"carrier_claim_identifier":{"type":["string","null"],"description":"The carrier's identifier for the claim"},"date_occurred":{"type":["string","null"],"description":"Date the claim occurred","format":"date-time"},"type":{"type":["string","null"],"enum":["WIND_AND_HAIL_DAMAGE","WATER_DAMAGE_AND_FREEZING","FIRE_AND_LIGHTNING_DAMAGE","OTHER_PROPERTY_DAMAGE","PERSONAL_LIABILITY","POWER_OUTAGE_OR_SURGE","THEFT","CAR_ACCIDENT","WINDSHIELD_DAMAGE","ANIMAL_COLLISION","VANDALISM","WEATHER","EMERGENCY_ROADSIDE_ASSISTANCE","MEDICAL","HURRICANE_DAMAGE","SEWAGE_BACKUP"],"description":"Claim type"},"status":{"type":["string","null"],"enum":["OPEN","CLOSED"],"description":"Claim status"},"date_closed":{"type":["string","null"],"description":"Date the claim was closed","format":"date-time"},"payout_cents":{"type":["integer","null"],"description":"Total payout of the claim in cents"},"representative_name":{"type":["string","null"],"description":"Claim representative name"},"representative_phone":{"type":["string","null"],"description":"Claim representative phone number"},"representative_email":{"type":["string","null"],"description":"Claim representative email address"}}},"DrivingRecord":{"title":"DrivingRecord","type":"object","properties":{"driving_record_id":{"type":"string","format":"uuid","description":"ID of the driving record"},"driver_id":{"type":["string","null"],"description":"ID of the driver the driving record is related to","format":"uuid"},"incident_date":{"type":["string","null"],"description":"Date the incident occurred","format":"date-time"},"incident_type":{"type":["string","null"],"enum":["ACCIDENT","VIOLATION"],"description":"Incident type"},"violation_type":{"type":["string","null"],"enum":["MOVING","SPEEDING","RECKLESS_DRIVING","DRIVING_WITHOUT_VALID_LICENSE","HIT_AND_RUN","DISTRACTED_DRIVING","DRIVING_UNDER_INFLUENCE","FAILURE_TO_YIELD","TAILGATING","OPEN_CONTAINER_OF_ALCOHOL"],"description":"Violation type, only exists if `incident_type` = `VIOLATION`"},"is_at_fault":{"type":["boolean","null"],"description":"Whether the driver was at fault"}}},"NamedInsured":{"title":"NamedInsured","type":"object","properties":{"named_insured_id":{"type":"string","format":"uuid","description":"ID of the named insured"},"first_name":{"type":["string","null"],"description":"First name of the insured"},"middle_name":{"type":["string","null"],"description":"Middle name of the insured"},"last_name":{"type":["string","null"],"description":"Last name of the insured"},"full_name":{"type":["string","null"],"description":"Full name of the insured"},"is_primary_named_insured":{"type":["boolean","null"],"description":"Whether the insured is the primary named insured"},"email":{"type":["string","null"],"description":"Email for the insured"},"home_phone":{"type":["string","null"],"description":"Home phone for the insured"},"mobile_phone":{"type":["string","null"],"description":"Mobile phone for the insured"},"work_phone":{"type":["string","null"],"description":"Work phone for the insured"},"work_phone_extension":{"type":["string","null"],"description":"Work phone exension for the insured"}}},"CommercialNamedInsured":{"title":"CommercialNamedInsured","type":"object","properties":{"commercial_named_insured_id":{"type":"string","format":"uuid","description":"ID of the commercial named insured"},"address_id":{"type":["string","null"],"description":"ID of the address for the insured","format":"uuid"},"location_id":{"type":["string","null"],"description":"ID of the location for the insured","format":"uuid"},"name":{"type":["string","null"],"description":"Name of the insured"},"form_of_business":{"type":["string","null"],"enum":["INDIVIDUAL","PARTNERSHIP","LIMITED_LIABILITY_COMPANY","S_CORPORATION","CORPORATION","JOINT_VENTURE","NOT_FOR_PROFIT_ORGANIZATION","TRUST"],"description":"The form of business of the insured"},"gl_code":{"type":["string","null"],"description":"General liability class code"},"sic_code":{"type":["string","null"],"description":"Standard industrial classification code"},"naics_code":{"type":["string","null"],"description":"North american industry classification system code"},"fein":{"type":["string","null"],"description":"Federal employer identification number"},"business_phone":{"type":["string","null"],"description":"Insured's business phone number"},"business_email":{"type":["string","null"],"description":"Insured's business email address"},"website_url":{"type":["string","null"],"description":"Insured's website url"},"is_primary_named_insured":{"type":["boolean","null"],"description":"Whether the insured is the primary insured"},"number_of_employees":{"type":["integer","null"],"description":"Number of employees"},"minimum_premium_cents":{"type":["integer","null"],"description":"Minimum premium, in cents (Workers' Compensation)"},"total_estimated_annual_premium_cents":{"type":["integer","null"],"description":"Total estimated annual premium, in cents (Workers' Compensation)"}}},"LossEvent":{"title":"LossEvent","type":"object","properties":{"loss_event_id":{"type":"string","format":"uuid","description":"ID of the loss event"},"policy_id":{"type":["string","null"],"description":"ID of the policy the loss event is related to"},"date_of_occurrence":{"type":["string","null"],"description":"Date the loss event occurred","format":"date-time"},"type":{"type":["string","null"],"enum":["BURGLARY_AND_THEFT","WATER_DAMAGE_AND_FREEZING_DAMAGE","WIND_AND_HAIL_DAMAGE","FIRE","CUSTOMER_SLIPS_AND_FALLS","CUSTOMER_INJURY_AND_DAMAGE","PERSONAL_AND_ADVERTISING_INJURY","EMPLOYEE_INJURY_OR_ILLNESS","PRODUCT_LIABILITY","STRUCK_BY_AN_OBJECT","REPUTATIONAL_HARM","VEHICULAR_ACCIDENT","WINDSHIELD_DAMAGE","STRIKE_RIOT_OR_CIVIL_COMMOTION","EMERGENCY_ROADSIDE_ASSISTANCE","VANDALISM_AND_MALICIOUS_MISCHIEF","EQUIPMENT_BREAKDOWN"],"description":"Loss event type"},"date_of_claim":{"type":["string","null"],"description":"Date of the claim","format":"date-time"},"amount_paid_cents":{"type":["integer","null"],"description":"Amount paid in cents"},"amount_reserved_cents":{"type":["integer","null"],"description":"Amount reserved in cents"},"is_subrogation":{"type":["boolean","null"],"description":"Whether subrogation was successful"},"is_claim_open":{"description":"Whether the claim is open","type":["boolean","null"]}}},"Monitoring":{"title":"Monitoring","type":"object","description":"A Monitoring is an object that manages the synchronization of Pulls","properties":{"monitoring_id":{"type":"string","format":"uuid","description":"ID of the Monitoring"},"latest_pull_id":{"type":"string","format":"uuid","description":"The latest Pull ID for the Monitored account"},"status":{"type":"string","description":"Status of the Monitoring","enum":["ACTIVE","STOPPED"]},"next_pull_date":{"type":["string","null"],"description":"When the Monitoring is active, this will be the next date-time the data will be refreshed","example":"2000-12-31T00:00:00.000Z","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$","format":"date-time"},"interval":{"type":"string","example":"P1M","format":"ISO-8601-duration","pattern":"^(-?)P(?=\\d|T\\d)(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)([DW]))?(?:T(?:(\\d+)H)?(?:(\\d+)M)?(?:(\\d+(?:\\.\\d+)?)S)?)?$","description":"How often the information should be refreshed. Must be >= 30 days. We accept ISO-8601 duration interval value and support days, months, and/or years."},"stop_after_date":{"type":["string","null"],"description":"Optional. Date after which monitoring should stop","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$","example":"2000-12-31T00:00:00.000Z","format":"date-time"}}},"MonitoringEvent":{"title":"MonitoringEvent","type":"object","description":"A MonitoringEvent is an event that occurred between the two most recent Pulls in the Monitoring.","properties":{"type":{"enum":["RENEWAL","EXPIRED","CANCELED","NEW_BUSINESS","REINSTATED","ENDORSEMENT","CLAIM_OPENED","CLAIM_CLOSED","CLAIM_REMOVED","DRIVINGRECORD_ADDED","DRIVINGRECORD_REMOVED"],"description":"The type of event that occurred."},"changes":{"type":"array","description":"An array of objects representing changes to Schema Objects between the two most recent Pulls in the Monitoring.","items":{"type":"object","properties":{"schema":{"enum":["POLICY","VEHICLE","DRIVER","VEHICLEDRIVER","VEHICLECOVERAGE","DWELLING","DWELLINGCOVERAGE","CLAIM","DRIVINGRECORD","BENEFICIARY"],"description":"The type of Schema Object that changed."},"type":{"enum":["CREATE","UPDATE","DELETE"],"description":"The type of change that occurred."},"before":{"type":["object","null"],"description":"The key/values from the previous Pull that changed between the current Pull and the previous Pull. For CREATE events, this value is null. DELETE events only contain the UUID of the deleted object and parent object(s)."},"after":{"type":["object","null"],"description":"The key/values from the most recent Pull that changed between the current Pull and the previous Pull. CREATE events only contain the UUID of the created object and parent object(s). For DELETE events, this value is null."}}}},"documents":{"type":"array","description":"An array of Documents corresponding with the event.","items":{"type":"object","properties":{"document_id":{"type":"string","format":"uuid","description":"The ID of the Document corresponding with the event."}}}}}},"Mortgagee":{"title":"Mortgagee","type":"object","properties":{"mortgagee_id":{"type":"string","format":"uuid","description":"ID of the mortgagee"},"mortgagee_name":{"type":["string","null"],"description":"Name of the mortgagee"},"mortgagee_address":{"type":["object","null"],"$ref":"#/components/schemas/Address","description":"Address of the mortgagee"},"mortgagee_type":{"type":["string","null"],"enum":["FIRST","SECOND","THIRD"],"description":"The type of mortgagee"},"mortgage_loan_number":{"type":["string","null"],"description":"Loan number of the mortgage"}}},"PolicyCheck":{"title":"PolicyCheck","type":"object","properties":{"status":{"type":"string","enum":["COMPLIANT","NOT_COMPLIANT","REVIEW_REQUIRED"],"description":"Policy Check Status"},"details":{"type":"object","description":"Detailed breakdown of individual Policy Check items","properties":{"status":{"type":"string","enum":["COMPLIANT","NOT_COMPLIANT","REVIEW_REQUIRED"],"description":"Policy Check Status of a check item"},"actual":{"description":"The actual value found during the Policy Check evaluation","type":"object"},"expected":{"description":"The expected value that the policy should meet for compliance","type":"object"}}}}},"PolicyCheckDwellingSetting":{"title":"PolicyCheckDwellingSetting","type":"object","properties":{"DWELLING_POLICY_NOT_ACTIVE":{"type":"boolean","description":"Verify whether the dwelling policy is active or inactive."},"LOSS_SETTLEMENT_TYPE_EQUALS_REPLACEMENT_COST":{"type":"boolean","description":"Verify the dwelling policy uses replacement cost for loss settlement type."},"REPLACEMENT_COST_EXCEEDS_DWELLING_LIMIT":{"type":"boolean","description":"Ensure that the replacement cost does not exceed the dwelling coverage limit."}}},"PolicyCheckPullVehicleSetting":{"title":"PolicyCheckPullVehicleSetting","type":"object","properties":{"DRIVER_NAME_MISMATCH":{"type":"array","description":"Array of driver names that are required to be included in the auto policy","uniqueItems":true,"items":{"type":"string"}},"VIN_MISMATCH":{"type":"array","description":"Array of vehicle VIN numbers that are required to be included in the auto policy","uniqueItems":true,"items":{"type":"string"}}}},"PolicyCheckVehicleSetting":{"title":"PolicyCheckVehicleSetting","type":"object","properties":{"POLICY_NOT_ACTIVE":{"type":"boolean","description":"Verify whether the auto policy is active or inactive"},"LIENHOLDER_NAME_MISMATCH":{"type":"array","description":"Array of lienholder names that are required to be included in the auto policy","uniqueItems":true,"items":{"type":"string"}},"DRIVER_REMOVED":{"type":"boolean","description":"Verify whether any driver was removed from the previous pull in the monitoring"},"VEHICLE_REMOVED":{"type":"boolean","description":"Verify whether any vehicle was removed from the previous pull in the monitoring"},"NO_COLLISION_COVERAGE":{"type":"boolean","description":"Verify whether collision coverage is included in the auto policy"},"NO_COMPREHENSIVE_COVERAGE":{"type":"boolean","description":"Verify whether comprehensive coverage is included in the auto policy"},"MAX_COLLISION_DEDUCTIBLE_CENTS":{"type":["number","null"],"description":"Verify that the collision deductible is below the specified limit"},"MAX_COMPREHENSIVE_DEDUCTIBLE_CENTS":{"type":["number","null"],"description":"Verify that the comprehensive deductible is below the specified limit"},"MIN_PROPERTY_DAMAGE_COVERAGE_CENTS":{"type":["number","null"],"description":"Verify that the property damage liability coverage is above the specified limit"},"MIN_BODILY_INJURY_COVERAGE":{"type":"object","properties":{"per_person_cents":{"type":["number","null"]},"per_accident_cents":{"type":["number","null"]}},"description":"Verify that the bodily injury liability coverage per person and/or per accident is above the specified limits"},"MIN_UNINSURED_MOTORIST_BODILY_INJURY_COVERAGE":{"type":"object","properties":{"per_person_cents":{"type":["number","null"]},"per_accident_cents":{"type":["number","null"]}},"description":"Verify that the uninsured motorist bodily injury coverage per person and/or per accident is above the specified limits"}}},"PolicyForm":{"title":"PolicyForm","type":"object","properties":{"policy_form_id":{"type":"string","description":"ID of the policy form. This ID is not specific to a pull so the form's attributes and its PDF content can be stored and reused if the ID matches.","format":"uuid"},"form_name":{"type":"string","description":"Name for the policy form.","example":"Agreement, Definitions & Policy Conditions"},"form_number":{"type":["string","null"],"description":"Number for the policy form. May include the form version.","example":"HQ-D77 CW (05-17)"},"form_type":{"type":["string","null"],"enum":["FORM","ENDORSEMENT"],"description":"Type of the policy form."},"endorsement_type":{"type":["string","null"],"enum":["SINKHOLE_COVERAGE","WATER_OR_STEAM_SEEPAGE_OR_LEAKAGE_COVERAGE","REFRIGERATED_PROPERTY_COVERAGE","SERVICE_LINE_COVERAGE","EXTENDED_REPLACEMENT_COST_COVERAGE","EXTENDED_ROOF_SURFACES_COVERAGE","ROOF_ACTUAL_CASH_VALUE_COVERAGE","ROOF_REPLACEMENT_COST_COVERAGE","SPECIAL_PERSONAL_PROPERTY_COVERAGE","IDENTITY_THEFT_COVERAGE","CREDIT_CARD_FRAUD_CHECK_FORGERY_OR_COUNTERFEIT_MONEY_COVERAGE","HOME_DAYCARE_COVERAGE","ASSISTED_LIVING_CARE_COVERAGE","LOSS_ASSESSEMENT_COVERAGE","SECONDARY_RESIDENCE_COVERAGE","INFLATION_GUARD_COVERAGE","PERSONAL_INJURY_COVERAGE","HOME_COMPUTER_COVERAGE","FUNCTIONAL_REPLACEMENT_COST_LOSS_SETTLEMENT","PERSONAL_PROPERTY_REPLACEMENT_COST_LOSS_SETTLEMENT","GAP_COVERAGE","ORIGINAL_EQUIPMENT_MANUFACTURER_COVERAGE","CUSTOM_EQUIPMENT_COVERAGE","NEW_CAR_REPLACEMENT_COVERAGE","RIDESHARE_COVERAGE","ACCIDENT_FORGIVENESS_COVERAGE","COMMERCIAL_USE_COVERAGE","UNINSURED_AND_UNDERINSURED_MOTORIST_COVERAGE","UNINSURED_MOTORIST_COVERAGE","UNDERINSURED_MOTORIST_COVERAGE","RENTAL_REIMBURSEMENT_COVERAGE","ROADSIDE_ASSISTANCE_COVERAGE","TOWING_AND_LABOR_COVERAGE","PERSONAL_INJURY_PROTECTION_COVERAGE","SINGLE_LIABILITY_LIMIT","ADDITIONAL_INSURED","FINE_ART_COVERAGE","THEFT_OF_MONEY_AND_SECURITIES_ON_PREMISES_COVERAGE","THEFT_OF_MONEY_AND_SECURITIES_OFF_PREMISES_COVERAGE","OTHER_THAN_THEFT_OF_MONEY_AND_SECURITIES_ON_PREMISES_COVERAGE","OTHER_THAN_THEFT_OF_MONEY_AND_SECURITIES_OFF_PREMISES_COVERAGE","ACCOUNTS_RECEIVABLE_COVERAGE","VALUABLE_PAPERS_AND_RECORDS_ON_PREMISES_COVERAGE","VALUABLE_PAPERS_AND_RECORDS_OFF_PREMISES_COVERAGE","ARSON_OR_THEFT_REWARD_COVERAGE","DEBRIS_REMOVAL_COVERAGE","OUTDOOR_SIGNS_COVERAGE","OUTDOOR_PROPERTY_COVERAGE","SPOILAGE_COVERAGE","EMPLOYMENT_PRACTICES_LIABILITY_COVERAGE","EMPLOYEE_BENEFITS_LIABILITY_COVERAGE","FIRE_DEPARTMENT_SERVICE_CHARGE_COVERAGE","LIQUOR_LIABILITY_COVERAGE","BUILDING_GLASS_COVERAGE","HIRED_AUTO_BODILY_INJURY_COVERAGE","HIRED_AUTO_PROPERTY_DAMAGE_COVERAGE","NON_OWNED_AUTO_COVERAGE","HIRED_AUTO_COVERAGE","HIRED_AND_NON_OWNED_AUTO_COVERAGE","DATA_COMPROMISE_COVERAGE","BAILEES_CUSTOMER_COVERAGE","PROPERTY_IN_TRANSIT_COVERAGE","EQUIPMENT_BREAKDOWN_COVERAGE","ORDINANCE_OR_LAW_COVERAGE","WINDSTORM_OR_HAIL_COVERAGE","EARTHQUAKE_COVERAGE","FLOOD_COVERAGE","WATER_BACKUP_COVERAGE","LIMITED_FUNGI_OR_MOLD_COVERAGE","PARTNERS_OFFICERS_AND_OTHER_EXCLUSION","EXPERIENCE_RATING_MODIFICATION_FACTOR","NOTIFICATION_OF_CHANGE_IN_OWNERSHIP","CATASTOPHE_OTHER_THAN_CERTIFIED_ACTS_OF_TERRORISM_PREMIUM","TERRORISM_RISK_INSURANCE_PROGRAM_REAUTHORIZATION_ACT_DISCLOSURE","AUDIT_NONCOMPLIANCE_CHARGE","PENDING_RATE_CHANGE","PREMIUM_DUE_DATE","DESIGNATED_WORKPLACES_EXCLUSIION","WAIVER_OF_RIGHTS_TO_RECOVER_FROM_OTHERS","PREMIUM_DISCOUNT","EMPLOYER_LIABILITY_COVERAGE","TERMINAL_COVERAGE"],"description":"Type of endorsement form. Only applicable if the `form_type` is `ENDORSEMENT`."},"is_exclusion_endorsement":{"type":["boolean","null"],"description":"Indicates whether or not the endorsement is an exclusion. Only applicable if the `form_type` is `ENDORSEMENT`."},"pdf_available":{"type":"boolean","description":"Indicates whether or not a PDF is available for the form. A form that does not currently have a PDF available may have one available at a future time."}}},"PremiumGroup":{"title":"PremiumGroup","type":"object","properties":{"premium_group_id":{"type":"string","description":"ID of the premium group"},"premium_cents":{"type":["integer","null"],"description":"Premium paid for group of coverage items, in cents"},"vehicle_coverage_ids":{"type":"string","description":"IDs of vehicle coverages apart of the premium group"}}},"ServicingAction":{"title":"ServicingAction","examples":[{"servicing_action_id":"a082368f-fa48-48d3-9b0a-f3941c81511d","type":"ADD_MORTGAGEE","payload":{},"confirmation_data":{},"status":"QUEUED","validation_error_type":"INVALID_POLICY_NUMBER"}],"allOf":[{"type":"object","properties":{"servicing_action_id":{"type":"string","format":"uuid","description":"ID of the `ServicingAction`."},"status":{"enum":["QUEUED","IN_PROGRESS","INTERNAL_ERROR","PROVIDER_ERROR","VALIDATION_ERROR","WAITING_FOR_CONSUMER_CONFIRMATION","SUBMITTING_CONFIRMATION","UNCONFIRMED","SUCCESS"]},"validation_error_type":{"type":["string","null"],"enum":["INVALID_POLICY_NUMBER","INVALID_POLICY_TYPE","INVALID_MORTGAGEE_NAME","INVALID_MORTGAGEE_ADDRESS","DUPLICATE_MORTGAGEE_NAME","DUPLICATE_MORTGAGEE_TYPE","INVALID_MORTGAGEE_TYPE","POLICY_UNAVAILABLE_FOR_SERVICING","VEHICLE_UNAVAILABLE_FOR_SERVICING","REPLACING_VIN_NOT_FOUND","PRIMARY_DRIVER_NOT_FOUND","INVALID_VIN","INVALID_VEHICLE_ACQUISITION_DATE","REGISTERED_OWNER_NOT_FOUND","INVALID_FINANCING_COMPANY","INVALID_GARAGING_ADDRESS","GARAGING_ADDRESS_OUT_OF_STATE","CUSTOMER_SERVICE_REQUIRED","FINANCING_COMPANY_NOT_FOUND","DUPLICATE_FINANCING_COMPANY","OTHER_PARTIES_TO_NOTIFY_NOT_SUPPORTED","CANNOT_ADD_NEW_DRIVER","CANNOT_ADD_NEW_REGISTERED_OWNER","INVALID_SAFETY_RESTRAINT_DEVICE","ANTI_THEFT_DEVICE_REQUIRED","INVALID_COVERAGE_SELECTION","INVALID_PRIMARY_USE_TYPE","MULTIPLE_FINANCING_COMPANIES_NOT_ALLOWED"],"description":"Only present if `status` is `VALIDATION_ERROR`."}},"required":["servicing_action_id","status"]},{"title":"ServicingAction","oneOf":[{"type":"object","title":"AddMortgagee","allOf":[{"title":"AddMortgageePayload","type":"object","properties":{"type":{"enum":["ADD_MORTGAGEE"]},"payload":{"type":"object","description":"Input required for a `ServicingAction`. Corresponds with the `type`.","required":["carrier_policy_number","name","address","loan_number","mortgagee_type"],"properties":{"carrier_policy_number":{"type":"string","example":"HO132483"},"name":{"type":"string","example":"JP MORGAN CHASE BANK NA ISAOA ATIMA"},"address":{"type":"string","example":"PO BOX 47020, ATLANTA, GA 30362"},"loan_number":{"type":"string","example":"1234567890"},"mortgagee_type":{"enum":["FIRST","SECOND","THIRD"]}}}},"required":["type","payload"]},{"type":"object","properties":{"confirmation_data":{"type":"object","properties":{"carrier_policy_number":{"type":"string","example":"HO132483"},"before":{"type":["null"]},"after":{"type":"object","required":["name","address","loan_number","mortgagee_type"],"description":"The new mortgagee after the change is applied.","properties":{"name":{"type":"string","example":"JP MORGAN CHASE BANK NA ISAOA ATIMA"},"address":{"type":"string","example":"PO BOX 47020, ATLANTA, GA 30362"},"loan_number":{"type":"string","example":"1234567890"},"mortgagee_type":{"enum":["FIRST","SECOND","THIRD"]}}}},"required":["carrier_policy_number","before","after"],"description":"Output provided for confirmation. Corresponds with the `type`."}}}]},{"type":"object","title":"EditMortgagee","allOf":[{"title":"EditMortgageePayload","type":"object","properties":{"type":{"enum":["EDIT_MORTGAGEE"]},"payload":{"type":"object","description":"Input required for a `ServicingAction`. Corresponds with the `type`.","required":["carrier_policy_number","name","address","loan_number","mortgagee_type"],"properties":{"carrier_policy_number":{"type":"string","example":"HO132483"},"name":{"type":"string","example":"JP MORGAN CHASE BANK NA ISAOA ATIMA"},"address":{"type":"string","example":"PO BOX 47020, ATLANTA, GA 30362"},"loan_number":{"type":"string","example":"1234567890"},"mortgagee_type":{"enum":["FIRST","SECOND","THIRD"]}}}},"required":["type","payload"]},{"type":"object","properties":{"confirmation_data":{"type":"object","properties":{"carrier_policy_number":{"type":"string","example":"HO132483"},"before":{"type":"object","required":["name","address","loan_number","mortgagee_type"],"description":"The old mortgagee before the change is applied.","properties":{"name":{"type":"string","example":"JP MORGAN CHASE BANK NA ISAOA ATIMA"},"address":{"type":"string","example":"PO BOX 47020, ATLANTA, GA 30362"},"loan_number":{"type":"string","example":"1234567890"},"mortgagee_type":{"enum":["FIRST","SECOND","THIRD"]}}},"after":{"type":"object","required":["name","address","loan_number","mortgagee_type"],"description":"The new mortgagee after the change is applied.","properties":{"name":{"type":"string","example":"JP MORGAN CHASE BANK NA ISAOA ATIMA"},"address":{"type":"string","example":"PO BOX 47020, ATLANTA, GA 30362"},"loan_number":{"type":"string","example":"1234567890"},"mortgagee_type":{"enum":["FIRST","SECOND","THIRD"]}}}},"required":["carrier_policy_number","before","after"],"description":"Output provided for confirmation. Corresponds with the `type`."}}}]},{"type":"object","title":"RemoveMortgagee","allOf":[{"title":"RemoveMortgageePayload","type":"object","properties":{"type":{"enum":["REMOVE_MORTGAGEE"]},"payload":{"type":"object","description":"Input required for a `ServicingAction`. Corresponds with the `type`.","required":["carrier_policy_number","mortgagee_type"],"properties":{"carrier_policy_number":{"type":"string","example":"HO132483"},"mortgagee_type":{"enum":["FIRST","SECOND","THIRD"]}}}},"required":["type","payload"]},{"type":"object","properties":{"confirmation_data":{"type":"object","properties":{"carrier_policy_number":{"type":"string","example":"HO132483"},"before":{"type":"object","description":"The old mortgagee before the change is applied.","required":["name","address","loan_number","mortgagee_type"],"properties":{"name":{"type":"string","example":"JP MORGAN CHASE BANK NA ISAOA ATIMA"},"address":{"type":"string","example":"PO BOX 47020, ATLANTA, GA 30362"},"loan_number":{"type":"string","example":"1234567890"},"mortgagee_type":{"enum":["FIRST","SECOND","THIRD"]}}},"after":{"type":["null"]}},"required":["carrier_policy_number","before","after"],"description":"Output provided for confirmation. Corresponds with the `type`."}}}]},{"type":"object","title":"AddVehicle","allOf":[{"title":"AddVehiclePayload","type":"object","properties":{"type":{"enum":["ADD_VEHICLE"]},"payload":{"description":"Input required for a `ServicingAction`. Corresponds with the `type`.","type":"object","required":["carrier_policy_number","vehicle","registered_owner_full_name","registered_state","garaging_address","is_customized","primary_use","primary_driver_full_name","annual_mileage","current_mileage","coverage_selections","safety_restraint_device","anti_theft_device","daytime_running_lights","tracking_device","vehicle_acquisition_date","vehicle_ownership"],"properties":{"carrier_policy_number":{"type":"string","example":"AU192837"},"vehicle":{"properties":{"type":{"enum":["PRIVATE_PASSENGER","ANTIQUE_AUTO","BOAT","COMMERCIAL_AUTO","MOTORCYCLE_OR_ATV","RV_MOTORHOME_OR_TRAILER","MOBILE_HOME","SNOWMOBILE","GOLF_CART"]},"model_year":{"type":"integer","example":2012},"vin":{"type":"string","example":"3N1AB6AP0CL704240"},"make":{"type":"string","example":"NISSAN"},"model":{"type":"string","example":"Sentra"}},"required":["type","model_year","vin","make","model"],"type":"object"},"replacing_vin":{"type":"string","description":"The VIN of the vehicle being replaced, if applicable.","example":"3FAHP0HA8CR128394"},"registered_owner_full_name":{"type":"string","example":"John Smith"},"registered_co_owner_full_name":{"type":"string","example":"Alice Smith"},"registered_state":{"enum":["AL","AK","AS","AZ","AR","CA","CO","CT","DE","DC","FM","FL","GA","GU","HI","ID","IL","IN","IA","KS","KY","LA","ME","MH","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","MP","OH","OK","OR","PW","PA","PR","RI","SC","SD","TN","TX","UT","VT","VI","VA","WA","WV","WI","WY"]},"garaging_address":{"type":"string","example":"344 Clinton Street, Brooklyn, NY, 11231"},"is_customized":{"type":"boolean"},"primary_use":{"oneOf":[{"title":"Commute, Work, or School","properties":{"type":{"enum":["COMMUTE","WORK","SCHOOL"]},"days_driven_per_week":{"type":"integer","maximum":7,"minimum":1},"miles_driven_each_way":{"type":"integer","minimum":1}},"required":["type","days_driven_per_week","miles_driven_each_way"]},{"title":"Personal, Pleasure, or Farm","properties":{"type":{"enum":["PERSONAL","PLEASURE","FARM"]}},"required":["type"]}],"type":"object"},"primary_driver_full_name":{"type":"string"},"annual_mileage":{"type":"number","example":10000},"current_mileage":{"type":"number","example":2000},"coverage_selections":{"type":"object","required":["BODILY_INJURY_LIABILITY","PROPERTY_DAMAGE_LIABILITY","PERSONAL_INJURY_PROTECTION","UNINSURED_MOTORISTS","UNDERINSURED_MOTORISTS","COLLISION","COMPREHENSIVE","EMERGENCY_ROAD_SERVICE","RENTAL_REIMBURSEMENT"],"properties":{"BODILY_INJURY_LIABILITY":{"type":"object","required":["per_person_limit_cents","per_incident_limit_cents"],"properties":{"per_person_limit_cents":{"type":"integer","example":10000000},"per_incident_limit_cents":{"type":"integer","example":30000000}}},"PROPERTY_DAMAGE_LIABILITY":{"type":"object","required":["per_incident_limit_cents"],"properties":{"per_incident_limit_cents":{"type":"integer","example":50000}}},"PERSONAL_INJURY_PROTECTION":{"anyOf":[{"title":"Declined","properties":{"is_declined":{"enum":[true]}},"required":["is_declined"]},{"title":"Accepted","properties":{"is_declined":{"enum":[false]},"per_person_limit_cents":{"type":"integer","example":2500000},"deductible_cents":{"type":"integer","example":50000}},"required":["is_declined","per_person_limit_cents"]}],"type":"object"},"UNINSURED_MOTORISTS":{"anyOf":[{"title":"Declined","properties":{"is_declined":{"enum":[true]}},"required":["is_declined"]},{"title":"Accepted","properties":{"is_declined":{"enum":[false]},"per_person_limit_cents":{"type":"integer","example":2500000},"per_incident_limit_cents":{"type":"integer","example":5000000}},"required":["is_declined","per_person_limit_cents","per_incident_limit_cents"]}],"type":"object"},"UNDERINSURED_MOTORISTS":{"anyOf":[{"title":"Declined","properties":{"is_declined":{"enum":[true]}},"required":["is_declined"]},{"title":"Accepted","properties":{"is_declined":{"enum":[false]},"per_person_limit_cents":{"type":"integer","example":2500000},"per_incident_limit_cents":{"type":"integer","example":5000000}},"required":["is_declined","per_person_limit_cents","per_incident_limit_cents"]}],"type":"object"},"COLLISION":{"anyOf":[{"title":"Declined","properties":{"is_declined":{"enum":[true]}},"required":["is_declined"]},{"title":"Accepted","properties":{"is_declined":{"enum":[false]},"deductible_cents":{"type":"integer","example":50000}},"required":["is_declined","deductible_cents"]}],"type":"object"},"COMPREHENSIVE":{"anyOf":[{"title":"Declined","properties":{"is_declined":{"enum":[true]}},"required":["is_declined"]},{"title":"Accepted","properties":{"is_declined":{"enum":[false]},"deductible_cents":{"type":"integer","example":50000}},"required":["is_declined","deductible_cents"]}],"type":"object"},"EMERGENCY_ROAD_SERVICE":{"type":"object","required":["is_declined"],"properties":{"is_declined":{"type":"boolean"}}},"RENTAL_REIMBURSEMENT":{"anyOf":[{"title":"Declined","properties":{"is_declined":{"enum":[true]}},"required":["is_declined"]},{"title":"Accepted","properties":{"is_declined":{"enum":[false]},"per_day_limit_cents":{"type":"integer","example":3000},"max_days":{"type":"integer","example":30}},"required":["is_declined","per_day_limit_cents","max_days"]}],"type":"object"}}},"safety_restraint_device":{"enum":["NONE","AUTOMATIC_SEAT_BELTS","DRIVER_SIDE_AIR_BAG","FULL_FRONT_AIR_BAG"]},"anti_theft_device":{"enum":["UNKNOWN","NONE","ALARM_ONLY","NON_PASSIVE_DISABLING_DEVICE","PASSIVE_DISABLING_DEVICE","VEHICLE_RECOVERY_SYSTEM","VEHICLE_RECOVERY_SYSTEM_PASSIVE_DISABLING_DEVICE","ELECTRONIC_HOMING_DEVICE"]},"daytime_running_lights":{"type":"boolean"},"tracking_device":{"type":"boolean"},"vehicle_acquisition_date":{"type":"string","format":"date","example":"2023-08-16"},"vehicle_ownership":{"anyOf":[{"properties":{"type":{"enum":["OWN"]},"financing_companies":{"type":"array","items":{"type":"object","properties":{"type":{"enum":["LIEN_HOLDER","OTHER_PARTY_TO_NOTIFY"]},"name":{"type":"string","example":"Metropolis Bank"},"address":{"type":"string","example":"620 Atlantic Avenue, Brooklyn, NY, 11217"}},"required":["type","name","address"]}}},"required":["type","financing_companies"]},{"properties":{"type":{"enum":["LEASE","FINANCE"]},"financing_companies":{"type":"array","items":{"type":"object","properties":{"type":{"enum":["LIEN_HOLDER","OTHER_PARTY_TO_NOTIFY"]},"name":{"type":"string","example":"Metropolis Bank"},"address":{"type":"string","example":"620 Atlantic Avenue, Brooklyn, NY, 11217"}},"required":["type","name","address"]}},"loan_duration_months":{"type":"integer","example":60}},"required":["type","financing_companies","loan_duration_months"]}],"type":"object"}}}},"required":["type","payload"]},{"type":"object","properties":{"confirmation_data":{"anyOf":[{"title":"Agent Required","properties":{"requires_agent":{"enum":[true],"description":"Change requires intervention from the policy's agent."},"coverage_selections":{"type":"object","propertyNames":{"title":"VehicleCoverageTypes","type":"string","enum":["SINGLE_LIMIT_LIABILITY","BODILY_INJURY_LIABILITY","PROPERTY_DAMAGE_LIABILITY","SUPPLEMENTAL_SPOUSAL_LIABILITY","SUPPLEMENTAL_SPOUSAL_BODILY_INJURY_LIABILITY","SUPPLEMENTAL_SPOUSAL_PROPERTY_DAMAGE_LIABILITY","PERSONAL_INJURY_PROTECTION","COMPREHENSIVE","FULL_GLASS","COLLISION_DEDUCTIBLE_WAIVER","COLLISION","UNINSURED_MOTORISTS","UNINSURED_MOTORIST_BODILY_INJURY_LIABILITY","UNINSURED_MOTORIST_PROPERTY_DAMAGE_LIABILITY","UNINSURED_MOTORIST_BODILY_INJURY_AND_PROPERTY_DAMAGE_LIABILITY","UNDERINSURED_MOTORISTS","UNDERINSURED_MOTORIST_BODILY_INJURY_LIABILITY","UNDERINSURED_MOTORIST_PROPERTY_DAMAGE_LIABILITY","UNDERINSURED_MOTORIST_BODILY_INJURY_AND_PROPERTY_DAMAGE_LIABILITY","UNINSURED_AND_UNDERINSURED_MOTORISTS","UNINSURED_AND_UNDERINSURED_MOTORIST_BODILY_INJURY_LIABILITY","UNINSURED_AND_UNDERINSURED_MOTORIST_PROPERTY_DAMAGE_LIABILITY","UNINSURED_AND_UNDERINSURED_MOTORIST_BODILY_INJURY_AND_PROPERTY_DAMAGE_LIABILITY","TOWING_AND_LABOR","LOAN_OR_LEASE_ASSISTANCE","RIDESHARE_GAP_PROTECTION","MEDICAL_PAYMENTS","EMERGENCY_ROAD_SERVICE","RENTAL_REIMBURSEMENT","CAR_RENTAL_AND_TRAVEL_EXPENSES","PORTABLE_ELECTRONICS","MECHANICAL_BREAKDOWN","SUPPLEMENTAL_UNINSURED_AND_UNDERINSURED_MOTORISTS","EMERGENCY_EXPENSE","REPLACEMENT_COST_PERSONAL_EFFECTS","VACATION_LIABILITY_COVERAGE","RV_MEDICAL","EXTENDED_BENEFITS","WAGE_EARNER_DISABILITY_BENEFITS","ESSENTIAL_SERVICES_DISABILITY_BENEFITS","DEATH_BENEFIT","CAR_REPLACEMENT_ASSISTANCE","FULL_TORT","LIMITED_TORT","COMBINED_SINGLE_LIMIT","SPARE_PARTS","OPTIONAL_BODILY_INJURY_LIABILITY","MOTOR_CARGO","ON_HOOK","FIRST_PARTY_BENEFIT","FIRST_PARTY_BENEFIT_MEDICAL_EXPENSE","FIRST_PARTY_BENEFIT_ACCIDENTAL_DEATH","FIRST_PARTY_BENEFIT_INCOME_LOSS","FIRST_PARTY_BENEFIT_FUNERAL_EXPENSE","FIRST_PARTY_BENEFIT_EXTRAORDINARY_MEDICAL","FIRST_PARTY_BENEFIT_SURVIVORS_LOSS","CUSTOM_PARTS_AND_EQUIPMENT","VEHICLE_PROTECTION","FUNERAL_BENEFIT","SURVIVORS_LOSS_BENEFIT"]},"additionalProperties":{"title":"ConfirmedCoverageSelection","type":"object","properties":{"per_person_limit_cents":{"type":["integer","null"]},"per_incident_limit_cents":{"type":["integer","null"]},"per_day_limit_cents":{"type":["integer","null"]},"max_days":{"type":["integer","null"]},"deductible_cents":{"type":["integer","null"]},"premium_cents":{"type":["integer","null"]},"is_declined":{"type":["boolean","null"]},"is_policy_level":{"type":["boolean","null"],"description":"Indicates if the coverage applies to all vehicles on the policy or only the vehicle being added."},"is_changed":{"type":["boolean","null"],"description":"Indicates if the coverage selection was changed from its previous value."}}},"description":"The keys may be any of `VehicleCoverageTypes` (see [VehicleCoverage.name](https://docs.usecanopy.com/reference/schemas-vehiclecoverage)).","properties":{"BODILY_INJURY_LIABILITY":{"$ref":"#/components/schemas/ServicingAction/allOf/1/oneOf/3/allOf/1/properties/confirmation_data/anyOf/0/properties/coverage_selections/additionalProperties"},"PROPERTY_DAMAGE_LIABILITY":{"$ref":"#/components/schemas/ServicingAction/allOf/1/oneOf/3/allOf/1/properties/confirmation_data/anyOf/0/properties/coverage_selections/additionalProperties"},"PERSONAL_INJURY_PROTECTION":{"$ref":"#/components/schemas/ServicingAction/allOf/1/oneOf/3/allOf/1/properties/confirmation_data/anyOf/0/properties/coverage_selections/additionalProperties"},"UNINSURED_MOTORISTS":{"$ref":"#/components/schemas/ServicingAction/allOf/1/oneOf/3/allOf/1/properties/confirmation_data/anyOf/0/properties/coverage_selections/additionalProperties"},"UNDERINSURED_MOTORISTS":{"$ref":"#/components/schemas/ServicingAction/allOf/1/oneOf/3/allOf/1/properties/confirmation_data/anyOf/0/properties/coverage_selections/additionalProperties"},"COLLISION":{"$ref":"#/components/schemas/ServicingAction/allOf/1/oneOf/3/allOf/1/properties/confirmation_data/anyOf/0/properties/coverage_selections/additionalProperties"},"COMPREHENSIVE":{"$ref":"#/components/schemas/ServicingAction/allOf/1/oneOf/3/allOf/1/properties/confirmation_data/anyOf/0/properties/coverage_selections/additionalProperties"},"EMERGENCY_ROAD_SERVICE":{"$ref":"#/components/schemas/ServicingAction/allOf/1/oneOf/3/allOf/1/properties/confirmation_data/anyOf/0/properties/coverage_selections/additionalProperties"},"RENTAL_REIMBURSEMENT":{"$ref":"#/components/schemas/ServicingAction/allOf/1/oneOf/3/allOf/1/properties/confirmation_data/anyOf/0/properties/coverage_selections/additionalProperties"}}},"adjusted_policy_premium_cents":{"type":"integer","example":86750,"description":"New total premium for the entire term (not the remainder)."}},"required":["requires_agent"]},{"title":"Agent Not Required","properties":{"requires_agent":{"enum":[false],"description":"Change does not require intervention from the policy's agent."},"coverage_selections":{"type":"object","propertyNames":{"$ref":"#/components/schemas/ServicingAction/allOf/1/oneOf/3/allOf/1/properties/confirmation_data/anyOf/0/properties/coverage_selections/propertyNames"},"additionalProperties":{"$ref":"#/components/schemas/ServicingAction/allOf/1/oneOf/3/allOf/1/properties/confirmation_data/anyOf/0/properties/coverage_selections/additionalProperties"},"description":"The keys may be any of `VehicleCoverageTypes` (see [VehicleCoverage.name](https://docs.usecanopy.com/reference/schemas-vehiclecoverage)).","properties":{"BODILY_INJURY_LIABILITY":{"$ref":"#/components/schemas/ServicingAction/allOf/1/oneOf/3/allOf/1/properties/confirmation_data/anyOf/0/properties/coverage_selections/additionalProperties"},"PROPERTY_DAMAGE_LIABILITY":{"$ref":"#/components/schemas/ServicingAction/allOf/1/oneOf/3/allOf/1/properties/confirmation_data/anyOf/0/properties/coverage_selections/additionalProperties"},"PERSONAL_INJURY_PROTECTION":{"$ref":"#/components/schemas/ServicingAction/allOf/1/oneOf/3/allOf/1/properties/confirmation_data/anyOf/0/properties/coverage_selections/additionalProperties"},"UNINSURED_MOTORISTS":{"$ref":"#/components/schemas/ServicingAction/allOf/1/oneOf/3/allOf/1/properties/confirmation_data/anyOf/0/properties/coverage_selections/additionalProperties"},"UNDERINSURED_MOTORISTS":{"$ref":"#/components/schemas/ServicingAction/allOf/1/oneOf/3/allOf/1/properties/confirmation_data/anyOf/0/properties/coverage_selections/additionalProperties"},"COLLISION":{"$ref":"#/components/schemas/ServicingAction/allOf/1/oneOf/3/allOf/1/properties/confirmation_data/anyOf/0/properties/coverage_selections/additionalProperties"},"COMPREHENSIVE":{"$ref":"#/components/schemas/ServicingAction/allOf/1/oneOf/3/allOf/1/properties/confirmation_data/anyOf/0/properties/coverage_selections/additionalProperties"},"EMERGENCY_ROAD_SERVICE":{"$ref":"#/components/schemas/ServicingAction/allOf/1/oneOf/3/allOf/1/properties/confirmation_data/anyOf/0/properties/coverage_selections/additionalProperties"},"RENTAL_REIMBURSEMENT":{"$ref":"#/components/schemas/ServicingAction/allOf/1/oneOf/3/allOf/1/properties/confirmation_data/anyOf/0/properties/coverage_selections/additionalProperties"}}},"adjusted_policy_premium_cents":{"type":"integer","example":86750,"description":"New total premium for the entire term (not the remainder)."}},"required":["requires_agent","coverage_selections","adjusted_policy_premium_cents"]}],"description":"Output provided for confirmation. Corresponds with the `type`.","type":"object"}}}]}]}]},"LifePolicy":{"title":"LifePolicy","type":["object","null"],"properties":{"life_policy_details":{"type":["object","null"],"description":"Life policy details","$ref":"#/components/schemas/LifePolicyDetails"},"life_policy_riders":{"type":"array","description":"List of life policy riders","items":{"$ref":"#/components/schemas/LifePolicyRider"}},"life_policy_beneficiaries":{"type":"array","description":"List of life policy beneficiaries","items":{"$ref":"#/components/schemas/LifePolicyBeneficiary"}}}},"LifePolicyBeneficiary":{"title":"LifePolicyBeneficiary","type":"object","properties":{"life_policy_beneficiary_id":{"type":"string","description":"ID of the life policy beneficiary record","format":"uuid"},"policy_id":{"type":"string","format":"uuid","description":"ID of the policy this record belongs to"},"pull_id":{"type":"string","format":"uuid","description":"ID of the pull this record belongs to"},"name_insured_id":{"type":"string","format":"uuid","description":"ID of the named insured associated with this beneficiary"},"type":{"type":"string","enum":["PRIMARY","CONTINGENT","IRREVOCABLE","REVOCABLE"],"description":"Type of beneficiary"},"first_name":{"type":["string","null"],"description":"Beneficiary's first name"},"middle_name":{"type":["string","null"],"description":"Beneficiary's middle name"},"last_name":{"type":["string","null"],"description":"Beneficiary's last name"},"full_name":{"type":["string","null"],"description":"Beneficiary's full name"},"relationship_to_insured":{"type":["string","null"],"enum":["SELF","SPOUSE","DOMESTIC_PARTNER","PARENT","CHILD","SIBLING","OTHER_RELATIVE","LANDLORD","TENANT","EMPLOYEE","EMPLOYER","LIENHOLDER","LENDER","LESSOR","BUSINESS_PARTNER","MEMBER","OTHER"],"description":"Relationship of beneficiary to insured"},"designation":{"type":["string","null"],"enum":["PER_STIRPES","PER_CAPITA"],"description":"Beneficiary designation"},"distribution_percent":{"type":["number","null"],"description":"Distribution percentage for the beneficiary"}}},"LifePolicyDetails":{"title":"LifePolicyDetails","type":"object","properties":{"life_policy_details_id":{"type":"string","format":"uuid","description":"ID of the life policy details record"},"policy_id":{"type":"string","format":"uuid","description":"ID of the policy this record belongs to"},"pull_id":{"type":"string","description":"ID of the pull this record belongs to","format":"uuid"},"face_amount_cents":{"type":["integer","null"],"description":"Face amount of the life insurance policy in cents"},"death_benefit_amount_cents":{"type":["integer","null"],"description":"Death benefit amount in cents"},"total_cash_value_cents":{"type":["integer","null"],"description":"Total cash value in cents"},"total_loan_balance_cents":{"type":["integer","null"],"description":"Total loan balance in cents"},"dividend_option":{"type":["string","null"],"enum":["CASH","PAID_UP_ADDITIONS","REDUCE_PREMIUMS","ACCUMULATE_WITH_INTEREST","FIFTH_DIVIDEND_OPTION","ONE_YEAR_TERM_INSURANCE"],"description":"Dividend option for the policy"},"total_accumulated_dividend_cents":{"type":["integer","null"],"description":"Total accumulated dividend in cents"},"total_surrender_value_cents":{"type":["integer","null"],"description":"Total surrender value in cents"},"loan_variable_interest_rate_percent":{"type":["number","null"],"description":"Loan variable interest rate as a percentage"},"paid_up_date":{"type":["string","null"],"format":"date-time","description":"Date when the policy was paid up"},"total_accumulated_dividend_on_date":{"type":["string","null"],"format":"date-time","description":"Date for the total accumulated dividend amount"},"total_loan_balance_on_date":{"type":["string","null"],"format":"date-time","description":"Date for the total loan balance amount"},"total_cash_value_on_date":{"type":["string","null"],"format":"date-time","description":"Date for the total cash value amount"},"total_surrender_value_on_date":{"type":["string","null"],"format":"date-time","description":"Date for the total surrender value amount"},"policy_owner_first_name":{"type":["string","null"],"description":"Policy owner's first name"},"policy_owner_middle_name":{"type":["string","null"],"description":"Policy owner's middle name"},"policy_owner_last_name":{"type":["string","null"],"description":"Policy owner's last name"},"policy_owner_full_name":{"type":["string","null"],"description":"Policy owner's full name"},"policy_payor_first_name":{"type":["string","null"],"description":"Policy payor's first name"},"policy_payor_middle_name":{"type":["string","null"],"description":"Policy payor's middle name"},"policy_payor_last_name":{"type":["string","null"],"description":"Policy payor's last name"},"policy_payor_full_name":{"type":["string","null"],"description":"Policy payor's full name"},"policy_owner_address":{"type":["null","object"],"$ref":"#/components/schemas/Address","description":"Policy owner's address"},"policy_payor_address":{"type":["null","object"],"$ref":"#/components/schemas/Address","description":"Policy payor's address"}}},"LifePolicyRider":{"title":"LifePolicyRider","type":"object","properties":{"life_policy_rider_id":{"type":"string","description":"ID of the life policy rider record","format":"uuid"},"policy_id":{"type":"string","format":"uuid","description":"ID of the policy this record belongs to"},"pull_id":{"type":"string","description":"ID of the pull this record belongs to","format":"uuid"},"name":{"type":"string","enum":["GUARANTEED_INSURABILITY","ACCIDENTAL_DEATH","DISABILITY_INCOME","WAIVER_OF_PREMIUM","TERM_INSURANCE","CHILD_TERM_RIDER","ADDITIONAL_INSURED_RIDER","PAID_UP_ADDITIONS","LONG_TERM_CARE","ACCELERATED_DEATH_BENEFIT","RETURN_OF_PREMIUM","COST_OF_LIVING_ADJUSTMENT","CRITICAL_ILLNESS","UNEMPLOYMENT_WAIVER","EXTENDED_TERM_INSURANCE","REDUCED_PAID_UP_INSURANCE","AUTOMATIC_PREMIUM_LOAN","ACCIDENTAL_DEATH_BENEFIT_PLUS","DISABILITY_WAIVER_OF_PREMIUM_PLUS"],"description":"Name of the rider/benefit"},"friendly_name":{"type":["string","null"],"description":"Human-friendly name of the rider"},"effective_date":{"type":["string","null"],"format":"date-time","description":"Date when the rider becomes effective"},"expiry_date":{"type":["string","null"],"format":"date-time","description":"Date when the rider expires"}}},"Location":{"title":"Location","type":"object","properties":{"location_id":{"type":"string","format":"uuid","description":"ID of the location"},"address":{"type":"object","$ref":"#/components/schemas/Address","description":"Address of the location"},"coverages":{"type":"array","uniqueItems":true,"description":"List of location coverage objects","items":{"$ref":"#/components/schemas/LocationCoverage"}},"operations":{"type":"array","uniqueItems":true,"description":"List of location operation objects","items":{"$ref":"#/components/schemas/LocationOperation"}},"mortgagees":{"type":"array","uniqueItems":true,"description":"List of mortgagee objects","items":{"$ref":"#/components/schemas/Mortgagee"}},"property_data":{"type":["object","null"],"$ref":"#/components/schemas/PropertyData","description":"Location property data. Your plan must include property data in order to access this API in production. For more information, contact your Canopy Connect representative."},"carrier_location_identifier":{"type":["string","null"],"description":"Carrier-specific identifier for the location"},"loss_settlement_type":{"type":["string","null"],"description":"The loss settlement provision for the location","enum":["REPLACEMENT_COST","ACTUAL_CASH_VALUE"]}}},"LocationCoverage":{"title":"LocationCoverage","type":"object","properties":{"location_coverage_id":{"type":"string","format":"uuid","description":"ID of the location coverage"},"name":{"type":"string","enum":["GENERAL_AGGREGATE","PRODUCTS_AND_COMPLETED_OPERATIONS_AGGREGATE","BUILDING","BUSINESS_PERSONAL_PROPERTY","PERSONAL_PROPERTY_OF_OTHERS","BUILDING_PROPERTY_OF_OTHERS","DAMAGE_TO_PREMISES_RENTED_TO_YOU","PROPERTY_DAMAGE_LIABILITY","TENANTS_IMPROVEMENTS_AND_BETTERMENTS","LIABILITY_AND_MEDICAL_EXPENSES","MEDICAL_EXPENSE","BUSINESS_INCOME_AND_EXTRA_EXPENSE","EMPLOYEE_DISHONESTY_INCLUDING_FORGERY_AND_ALTERATION","PERSONAL_AND_ADVERTISING_INJURY","FINE_ART","THEFT_OF_MONEY_AND_SECURITIES_ON_PREMISES","THEFT_OF_MONEY_AND_SECURITIES_OFF_PREMISES","OTHER_THAN_THEFT_OF_MONEY_AND_SECURITIES_ON_PREMISES","OTHER_THAN_THEFT_OF_MONEY_AND_SECURITIES_OFF_PREMISES","EQUIPMENT_BREAKDOWN","ACCOUNTS_RECEIVABLE","VALUABLE_PAPERS_AND_RECORDS_ON_PREMISES","VALUABLE_PAPERS_AND_RECORDS_OFF_PREMISES","ARSON_OR_THEFT_REWARD","DEBRIS_REMOVAL","OUTDOOR_SIGNS","OUTDOOR_PROPERTY","ORDINANCE_OR_LAW","WATER_BACKUP_AND_SUMP_OVERFLOW","SEWER_AND_DRAIN_BACKUP","SPOILAGE","EMPLOYMENT_PRACTICES_LIABILITY","EMPLOYEE_BENEFITS_LIABILITY","FIRE_DEPARTMENT_SERVICE_CHARGE","LIQUOR_LIABILITY","ALL_OTHER_PERILS","WINDSTORM_OR_HAIL","EARTHQUAKE","FLOOD","BUILDING_GLASS","HIRED_AUTO_BODILY_INJURY","HIRED_AUTO_PROPERTY_DAMAGE","NON_OWNED_AUTO","HIRED_AUTO","HIRED_AND_NON_OWNED_AUTO","FUNGI_BACTERIA_AND_MOLD","DATA_COMPROMISE","BAILEES_CUSTOMER","PROPERTY_IN_TRANSIT","EMPLOYER_LIABILITY","TERMINAL","ANIMAL_DAMAGE_TO_BUILDING","BRANDS_AND_LABELS","BUSINESS_CARD_FRAUD","BUSINESS_INCOME_CIVIL_AUTHORITY","BUSINESS_INCOME_OFF_PREMISES_UTILITY_SERVICE_INTERRUPTION","BUSINESS_INCOME_DEPENDENT_PROPERTIES","BUSINESS_INCOME_OFF_PREMISES_OPERATIONS","BUSINESS_INCOME_WEBSITES","CLAIM_EXPENSE","COLLAPSE","COMPUTER_FRAUD","COMPUTERS_WORLDWIDE","CONTRACT_PENALTIES","CYBER_EVENT_VIRUS_MALWARE","DETACHED_GARAGE_STORAGE_BUILDING","ELECTRONIC_DATA","FIRE_EXTINGUISHER_RECHARGE","FORGERY_ALTERATION","FUNDS_TRANSFER_FRAUD","IDENTITY_THEFT_RECOVERY","INTERRUPTION_OF_COMPUTER_OPERATIONS","LEASE_ASSESSMENT","LOCK_AND_KEY_REPLACEMENT","LOST_KEYS","NEWLY_ACQUIRED_OR_CONSTRUCTED_PROPERTY","NONOWNED_DETACHED_TRAILERS","OFF_PREMISES_UTILITY_SERVICES","PAIRS_OR_SETS","PAVED_SURFACES","PERSONAL_EFFECTS","POLLUTANTS_CONTAMINANTS_CLEANUP","PRESERVATION_OF_PROPERTY","PROPERTY_OFF_PREMISES","PROPERTY_ON_OTHER_PREMISES","SALESPERSONS_SAMPLES","TEMPERATURE_CHANGE_SPOILAGE","TENANT_BUILDING_BPP_COVERAGE","THEFT_DAMAGE_TO_BUILDING","TRANSIT_BUSINESS_INCOME","TRANSIT_COVERAGE","VALUATION_CHANGES","WATER_OR_OTHER_MATERIAL_DAMAGE","BLANKET_ADDITIONAL_INSURED","CYBER_EVENT_VIRUS_MALWARE_DIGITAL_RANSOM_EXTORTION_SUBLIMIT","EXPEDITING_EXPENSES","TENANT_MOVE_BACK_EXPENSES","LEASE_CANCELLATION","EQUIPMENT_BREAKDOWN_EXPEDITING_EXPENSES_SUBLIMIT","EQUIPMENT_BREAKDOWN_HAZARDOUS_SUBSTANCE_CLEANUP_SUBLIMIT","EQUIPMENT_BREAKDOWN_LEGAL_DEFENSE_SUBLIMIT","EQUIPMENT_BREAKDOWN_SUPPLEMENTARY_PAYMENTS_SUBLIMIT","EQUIPMENT_BREAKDOWN_COMPUTERS_AND_DATA_RESTORATION_SUBLIMIT","EQUIPMENT_BREAKDOWN_SPOILAGE_SUBLIMIT","EQUIPMENT_BREAKDOWN_CFC_REFRIGERANT_SUBLIMIT","EQUIPMENT_BREAKDOWN_AMMONIA_CONTAMINATION_SUBLIMIT","EQUIPMENT_BREAKDOWN_WATER_DAMAGE_SUBLIMIT","EQUIPMENT_BREAKDOWN_SERVICE_INTERRUPTION","ORDINANCE_OR_LAW_INCREASED_CONSTRUCTION_COST_SUBLIMIT","ORDINANCE_OR_LAW_UNDAMAGED_PORTION_SUBLIMIT","ORDINANCE_OR_LAW_DEMOLITION_COST_SUBLIMIT","ORDINANCE_OR_LAW_INCREASED_PERIOD_OF_RESTORATION_SUBLIMIT","ORDINANCE_OR_LAW_EQUIPMENT_SUBLIMIT","IDENTITY_THEFT_RECOVERY_LOST_WAGES_CARE_EXPENSE_SUBLIMIT","IDENTITY_THEFT_RECOVERY_MENTAL_HEALTH_TREATMENT_SUBLIMIT","NEWLY_ACQUIRED_PROPERTY_BUSINESS_INCOME_SUBLIMIT","NEWLY_ACQUIRED_PROPERTY_PERSONAL_PROPERTY_SUBLIMIT","DATA_COMPROMISE_RESPONSE_EXPENSES_SUBLIMIT","DATA_COMPROMISE_EXTORTION_THREATS_SUBLIMIT","DATA_COMPROMISE_DEFENSE_AND_LIABILITY_SUBLIMIT","DATA_COMPROMISE_FINES_AND_PENALTIES_SUBLIMIT","DATA_COMPROMISE_PCI_LOSS_SUBLIMIT","LEASEHOLD_IMPROVEMENTS","MONEY_ORDERS_AND_COUNTERFEIT_CURRENCY","DIRECTORS_AND_OFFICERS_LIABILITY","FOOD_CONTAMINATION","TELEPHONE_FRAUD","KIDNAP_AND_RANSOM","SEXUAL_MISCONDUCT_ABUSE_LIABILITY","MOTEL_WATERCRAFT_LIABILITY","SWIMMING_POOL","SOCIAL_ENGINEERING_FRAUD","LOSS_OF_RENTAL_VALUE","MEDIA_LIABILITY","CYBER_LIABILITY","LEGAL_EXPENSE","VIOLENT_INCIDENT_RESPONSE","VIOLENT_INCIDENT_RESPONSE_INDIVIDUAL_COUNSELING_SUBLIMIT","VIOLENT_INCIDENT_RESPONSE_MEDICAL_EXPENSES_SUBLIMIT","VIOLENT_INCIDENT_RESPONSE_INDIVIDUAL_EXPENSES_SUBLIMIT","VIOLENT_INCIDENT_RESPONSE_ORGANIZATIONAL_EXPENSES_SUBLIMIT","CONFERENCE_CANCELLATION","DONATION_ASSURANCE","EMERGENCY_REAL_ESTATE_CONSULTING_FEE","FUNDRAISING_EVENT_BLACKOUT","IMAGE_RESTORATION_COUNSELING","POLITICAL_UNREST","TEMPORARY_MEETING_SPACE","TERRORISM_TRAVEL_REIMBURSEMENT","TRAVEL_ACCIDENT_BENEFIT","TRAVEL_DELAY_REIMBURSEMENT","BODILY_INJURY_BY_ACCIDENT","BODILY_INJURY_BY_DISEASE","ERRORS_AND_OMISSIONS"],"description":"Name of coverage item"},"friendly_name":{"type":"string","enum":["General Aggregate","Products and Completed Operations Aggregate","Building","Business Personal Property","Personal Property of Others","Building Property of Others","Damage to Premises Rented to You","Property Damage Liability","Tenants Improvements and Betterments","Liability and Medical Expenses","Medical Expense","Business Income and Extra Expense","Employee Dishonesty Including Forgery and Alteration","Personal and Advertising Injury","Fine Art","Theft of Money and Securities on Premises","Theft of Money and Securities off Premises","Other Than Theft of Money and Securities on Premises","Other Than Theft of Money and Securities off Premises","Equipment Breakdown","Accounts Receivable","Valuable Papers and Records on Premises","Valuable Papers and Records off Premises","Arson or Theft Reward","Debris Removal","Outdoor Signs","Outdoor Property","Ordinance or Law","Water Backup and Sump Overflow","Backup of Sewers and Drains","Spoilage","Employment Practices Liability","Employee Benefits Liability","Fire Department Service Charge","Liquor Liability","All Other Perils","Windstorm or Hail","Earthquake","Flood","Building Glass","Hired Auto Bodily Injury","Hired Auto Property Damage","Non-Owned Auto","Hired Auto","Hired and Non-Owned Auto","Fungi, Bacteria, and Mold","Data Compromise","Bailee's Customer","Property in Transit","Employer Liability","Terminal","Animal Damage to Building","Brands and Labels","Business Card Fraud","Business Income from Civil Authority","Business Income from Off-Premises Utility Service Interruption","Business Income from Dependent Properties","Business Income from Off-Premises Operations","Business Income from Websites","Claim Expense","Collapse","Computer Fraud","Computers Worldwide","Contract Penalties","Cyber Event / Virus and Malware","Detached Garage / Storage Building","Electronic Data","Fire Extinguisher Recharge","Forgery or Alteration","Funds Transfer Fraud","Identity Theft Recovery","Interruption of Computer Operations","Lease Assessment","Lock and Key Replacement","Lost Keys","Newly Acquired or Constructed Property","Non-Owned Detached Trailers","Off-Premises Utility Services","Pairs or Sets","Paved Surfaces","Personal Effects","Pollutants and Contaminants Cleanup","Preservation of Property","Property Off-Premises","Property on Other Premises","Salespersons Samples","Spoilage from Temperature Change of Autos Owned, Rented, or Operated","Tenant Building/Business Personal Property Coverage","Theft Damage to Building","Transit Business Income","Transit Coverage","Valuation Changes","Water Damage or Other Material Damage","Blanket Additional Insured","Cyber Event: Digital Ransom and Extortion Threat Sublimit","Expediting Expenses","Lessor's Tenant Move Back Expenses","Lessor's Lease Cancellation","Equipment Breakdown: Expediting Expenses Sublimit","Equipment Breakdown: Hazardous Substance Cleanup Sublimit","Equipment Breakdown: Legal Defense Sublimit","Equipment Breakdown: Supplementary Payments Sublimit","Equipment Breakdown: Computers and Data Restoration Sublimit","Equipment Breakdown: Spoilage Sublimit","Equipment Breakdown: CFC Refrigerant Sublimit","Equipment Breakdown: Ammonia Contamination Sublimit","Equipment Breakdown: Water Damage","Equipment Breakdown: Service Interruption","Ordinance or Law: Increased Construction Cost Sublimit","Ordinance or Law: Undamaged Portion Sublimit","Ordinance or Law: Demolition Cost Sublimit","Ordinance or Law: Increased Period of Restoration Sublimit","Ordinance or Law: Equipment Coverage Sublimit","Identity Theft Recovery: Lost Wages/Care Expense Sublimit","Identity Theft Recovery: Mental Health Treatment Sublimit","Newly Acquired Property: Business Income Sublimit","Newly Acquired Property: Personal Property Sublimit","Data Compromise: Response Expenses Sublimit","Data Compromise: Extortion Threats Sublimit","Data Compromise: Defense and Liability Sublimit","Data Compromise: Fines and Penalties Sublimit","Data Compromise: PCI Loss Sublimit","Leasehold Improvements","Money Orders and Counterfeit Money/Currency","Directors & Officers Liability","Food Contamination","Telephone (Toll) Fraud","Kidnap and Ransom","Sexual Misconduct/Abuse Liability","Motel Watercraft Liability","Swimming Pool","Social Engineering Fraud","Loss of Rental Value","Media Liability","Cyber Liability","Legal Expense","Violent Incident Response","Violent Incident Response: Individual Counseling Sublimit","Violent Incident Response: Medical Expenses Sublimit","Violent Incident Response: Individual Expenses Sublimit","Violent Incident Response: Organizational Expenses Sublimit","Conference Cancellation","Donation Assurance","Emergency Real Estate Consulting Fee","Fundraising Event Blackout","Image Restoration and Counseling","Political Unrest","Temporary Meeting Space","Terrorism Travel Reimbursement","Travel Accident Benefit","Travel Delay Reimbursement","Bodily Injury by Accident","Bodily Injury by Disease","Errors & Omissions"],"description":"Friendly name of coverage item"},"premium_cents":{"type":["integer","null"],"description":"Premium paid for coverage item, in cents"},"per_person_limit_cents":{"type":["integer","null"],"format":"int64","minimum":0,"maximum":9007199254740991,"description":"Per-person limit, in cents"},"per_incident_limit_cents":{"type":["integer","null"],"format":"int64","minimum":0,"maximum":9007199254740991,"description":"Per-incident limit, in cents"},"per_term_limit_cents":{"type":["integer","null"],"format":"int64","minimum":0,"maximum":9007199254740991,"description":"Per-term (aggregate) limit, in cents"},"per_policy_year_limit_cents":{"type":["integer","null"],"format":"int64","minimum":0,"maximum":9007199254740991,"description":"Per-policy-year limit, in cents"},"per_day_limit_cents":{"type":["integer","null"],"format":"int64","minimum":0,"maximum":9007199254740991,"description":"Per-day limit, in cents"},"business_income_limit_cents":{"type":["integer","null"],"format":"int64","minimum":0,"maximum":9007199254740991,"description":"Business income limit, in cents"},"per_employee_limit_cents":{"type":["integer","null"],"format":"int64","minimum":0,"maximum":9007199254740991,"description":"Per-employee limit, in cents"},"als_months":{"type":["integer","null"],"description":"Actual loss sustained limit, in months"},"seasonal_increase_percent":{"type":["integer","null"],"description":"Percentage automatic limit increase per season"},"extended_business_income_duration":{"type":["string","null"],"description":"Duration of extended business income coverage (ISO 8601). Example: `P60D` = 60 days","example":"P60D"},"period_of_restoration_duration":{"type":["string","null"],"description":"Period of restoration (ISO 8601). Example: `P12M` = 12 months","example":"P12M"},"duration_of_coverage_duration":{"type":["string","null"],"description":"Duration of coverage (ISO 8601). Example: `P30D` = 30 days","example":"P30D"},"waiting_period_duration":{"type":["string","null"],"description":"Waiting period (ISO 8601). Example: `PT12H` = 12 hours","example":"PT12H"},"limit_percent":{"type":["string","null"],"description":"Percentage covered. Example: `80.000`","example":"80.000"},"deductible_cents":{"type":["integer","null"],"description":"Deductible, in cents"},"deductible_percent":{"type":["string","null"],"description":"Percentage of Building limit. Example: `2.500`","example":"2.500"},"is_declined":{"type":"boolean","description":"If true, this coverage item was declined"}}},"LocationOperation":{"title":"LocationOperation","type":"object","properties":{"location_operation_id":{"type":"string","format":"uuid","description":"ID of the location operation"},"class_code":{"type":"string","description":"Three or four-digit Workers' Compensation class code"},"description":{"type":["string","null"],"description":"Human-readable description of the operation"},"estimated_annual_remunerations_cents":{"type":"integer","description":"Payroll amount for the given operation, in cents"},"rate_cents":{"type":"integer","description":"Rate per $100 of remuneration"},"estimated_annual_premium_cents":{"type":"integer","description":"Total estimated annual premium, in cents<br/><br/>Can be calculated by multiplying `estimated_annual_remunerations_cents` * `rate_cents`<br/><br/>E.g. if `estimated_annual_remunerations_cents` = 100_000_00 ($100k) and `rate_cents` = 500 ($5), then `estimated_annual_premium_cents` = 5_000_00 ($5k)"}}},"Widget":{"title":"Widget","type":"object","properties":{"widget_id":{"type":"string","format":"uuid","description":"A unique identifier for the Widget."},"intro_title":{"type":"string","description":"The message displayed upon the introduction of the Widget flow."},"public_alias":{"type":"string","description":"The public identifier for the Widget (eg. demo => https://app.usecanopy.com/c/demo). When not explicitly set, a public_alias will be auto generated."},"company_name":{"type":"string","description":"The company name presented in the Widget flow."},"success_message":{"type":"string","description":"The message displayed upon successful completion of the Widget flow."},"on_success_redirect_url":{"type":["string","null"],"description":"The URL the user is taken to upon successful completion of the Widget flow."},"is_sandbox":{"type":"boolean","description":"Whether or not the Widget is in sandbox mode (as opposed to production mode)."},"brand_color_hex":{"type":"string","description":"RRGGBB hexadecimal string used for color theming in the Widget flow."},"cobranded_intro_screen":{"type":"boolean","description":"Whether the enhanced “cobranded” introduction screen is enabled for the Widget flow."},"public_url":{"type":"string","description":"The fully qualified public URL for the Widget flow (eg. https://app.usecanopy.com/c/demo)."},"logo_src":{"type":["string","null"],"description":"The fully qualified public URL for the logo image displayed in the Widget flow."},"icon_src":{"type":["string","null"],"description":"The fully qualified public URL for the icon image shown in the Widget flow when cobranded_intro_screen is enabled."},"agents":{"type":"array","description":"List of agents","items":{"$ref":"#/components/schemas/Agent"}}}},"WebhookBody":{"type":"object","title":"Webhook Body","properties":{"widget_id":{"type":"string","format":"uuid"},"team_id":{"type":"string","format":"uuid"},"pull_id":{"type":"string","format":"uuid"},"status":{"$ref":"#/components/schemas/Pull/properties/status"},"meta_data":{"type":"object"},"event_type":{"enum":["COMPLETE","POLICIES_AVAILABLE","POLICY_AVAILABLE","AUTH_STATUS","ERROR","MONITORING_RECONNECT","DATA_UPDATED","SERVICING_WAITING_FOR_CONSUMER_CONFIRMATION","VALIDATION_COMPLETE"]},"account_identifier":{"type":["string","null"],"description":"Unique identifier for online account holder that will stay the same across PULLING_DATA pulls"},"is_monitored":{"type":"boolean"},"monitoring":{"description":"This will only exist when `is_monitored` is true","type":["object","null"],"properties":{"initial_pull_id":{"type":"string","format":"uuid"},"monitoring_id":{"type":"string","format":"uuid"}}},"data":{"anyOf":[{"title":"Data Updated Webhook","type":"object","properties":{"updates":{"type":"array","items":{"anyOf":[{"title":"Driver Added","type":"object","description":"Triggers when a consumer adds a driver within the link flow","properties":{"type":{"enum":["DRIVER_ADDED"]},"driver":{"$ref":"#/components/schemas/Driver"}}},{"title":"Driver Updated","type":"object","properties":{"type":{"enum":["DRIVER_UPDATED"]},"driver":{"$ref":"#/components/schemas/Driver"}},"description":"Triggers when a consumer updates an existing driver within the link flow"},{"title":"Contact Updated","type":"object","description":"Triggers when a consumer updates contact information within the link flow","properties":{"type":{"enum":["CONTACT_UPDATED"]},"data":{"type":"object","description":"Fields are nullable unless marked as required in the link flow config","properties":{"first_name":{"type":["string","null"]},"last_name":{"type":["string","null"]},"mobile_phone":{"type":["string","null"],"description":"10 digit phone number with no country code","example":"8885550000"},"email":{"type":["string","null"]}}}}},{"title":"Demographics Updated","type":"object","description":"Triggers when a consumer updates demographic information within the link flow","properties":{"type":{"enum":["DEMOGRAPHICS_UPDATED"]},"data":{"type":"object","description":"Fields are nullable unless marked as required in the link flow config","properties":{"gender":{"title":"Gender","enum":["MALE","FEMALE","NONBINARY",null]},"marital_status":{"title":"MaritalStatus","type":["string","null"],"enum":["SINGLE","MARRIED","SEPARATED","DIVORCED","WIDOWED","CIVIL_UNION","DOMESTIC_PARTNERSHIP"]},"education":{"title":"EducationLevel","enum":["LESS_THAN_HIGH_SCHOOL","HIGH_SCHOOL","SOME_COLLEGE","BACHELORS","DOCTORS","ASSOCIATES","MASTERS","LAW","VOCATIONAL","PHD","HIGH_SCHOOL_GED","COLLEGE_DEGREE","IN_COLLEGE","GRADUATE_WORK",null]},"occupation":{"type":["string","null"]}}}}},{"title":"Answers Updated","type":"object","description":"Triggers when a consumer answers questions within custom sections in the link flow","properties":{"type":{"enum":["ANSWERS_UPDATED"]},"data":{"$ref":"#/components/schemas/AnswerSection"}}}]}}}},{"$ref":"#/components/schemas/ValidationCompleteBody"}],"description":"Data type will match the `event_type`"}}},"ValidationCompleteBody":{"title":"Validation Complete Webhook","type":"object","description":"Payload delivered on the parent document-upload pull's webhook when its document validation finalizes (reaches a terminal status). Fires in addition to (not in place of) the existing webhook events such as `POLICIES_AVAILABLE`.","properties":{"document_validation_id":{"type":"string","format":"uuid","description":"ID of the document validation that finalized."},"status":{"title":"DocumentValidationStatus","enum":["PENDING","RUNNING","VERIFIED","POLICY_INACTIVE","POLICY_NOT_FOUND","CARRIER_UNSUPPORTED","MISSING_REQUIRED_INFORMATION","UNABLE_TO_VALIDATE"],"description":"Status of a document upload policy validation. `PENDING` and `RUNNING` are transient. The remaining six statuses are terminal:<br>- `VERIFIED`, `POLICY_INACTIVE`, and `POLICY_NOT_FOUND` are confirmed verdicts from the carrier's system of record.<br>- `CARRIER_UNSUPPORTED`, `MISSING_REQUIRED_INFORMATION`, and `UNABLE_TO_VALIDATE` indicate that no definitive verdict could be reached.<br>Meanings:<br>- `PENDING`: Validation has been created but has not yet started.<br>- `RUNNING`: Validation is in progress.<br>- `VERIFIED`: Carrier confirmed the policy exists and is active.<br>- `POLICY_INACTIVE`: Carrier confirmed the policy exists but is cancelled, expired, or rescinded.<br>- `POLICY_NOT_FOUND`: Carrier definitively reported the policy does not exist in their system of record.<br>- `CARRIER_UNSUPPORTED`: The carrier on the document could not be verified by Canopy.<br>- `MISSING_REQUIRED_INFORMATION`: Required information needed to verify the policy could not be extracted from the uploaded document.<br>- `UNABLE_TO_VALIDATE`: Validation completed without producing a definitive verdict."},"completed_at":{"type":"string","format":"date-time","description":"ISO timestamp at which the validation reached its terminal status."}}}}},"security":[{"BasicAuth":[]}],"tags":[{"name":"Accounts API","description":"Get account data"},{"name":"Whitelabel API","description":"Allows you to create a fully whitelabeled experience"},{"name":"Consent API","description":"Collect consent to skip the consent page in the SDK"},{"name":"Enrichment API","description":"Allows you to look up driver/household data"},{"name":"Misc API","description":"Collection of miscellaneous API routes"},{"name":"Monitorings API","description":"Manage synced accounts"},{"name":"Policy Data API","description":"Lookup property data for a given address"},{"name":"Policy Forms API","description":"Used to get policy form data"},{"name":"Policy Check Team Setting API","description":"Manage Policy Check team setting"},{"name":"Pulls API","description":"Get Pull data and download documents"},{"name":"Servicings API","description":"Manage servicing actions"},{"name":"Teams API","description":"Get, create, delete Teams"},{"name":"Widgets API","description":"Get, create, update, and delete Widgets"},{"name":"Webhooks API","description":"Get, create, update and delete Webhooks"},{"name":"Policy Search API","description":"Search verified Auto ID Cards, Auto insurance policies and Home insurance policies from major insurance carriers without the need for login credentials."}],"paths":{"/teams/{teamId}/pulls/{pullId}":{"get":{"summary":"GET /pulls/:pullId","description":"Used to get all of the available data for a pull","operationId":"get-pull-by-id","responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"examples":{"Personal Example Response":{"value":{"success":true,"pull":{"pull_id":"59ced597-b48f-49e3-9756-799e4c6f79a0","status":"SUCCESS","first_name":"Clark","middle_name":"Joseph","last_name":"Kent","email":null,"account_email":"clark.kent@theplanet.com","phone":"8885550000","mobile_phone":"8885550000","home_phone":"","work_phone":"8885555555","work_phone_extension":"","insurance_provider_name":"statefarm","team_id":"394661bc-6361-46f0-8b11-4106d6146cb4","widget_id":"d2bb6d56-15ff-4760-a27c-362f9bce645a","meta_data":{},"is_archived":false,"created_at":"2023-01-12T20:59:42.811Z","public_alias":"demo","deleted_at":null,"public_url":"https://app.usecanopy.com/c/demo","no_policies":false,"no_drivers":false,"no_documents":false,"no_claims":false,"no_loss_events":false,"skipped_product_types":["commercial"],"type":"PULLING_DATA","policies":[{"policy_id":"a5c3eac9-537c-4146-8de9-99fb55455126","name":"HOME HO132483","description":"Effective 12/13/2022 - 12/13/2023","carrier_policy_number":"HO132483","policy_type":"HOMEOWNERS","effective_date":"2022-12-13T06:00:00.000Z","expiry_date":"2023-12-13T06:00:00.000Z","renewal_date":null,"canceled_date":null,"total_premium_cents":175349,"carrier_name":"statefarm","status":"ACTIVE","limited_access":false,"form_of_business":null,"deductible_cents":null,"paid_in_full":true,"is_monoline":false,"dwellings":[{"dwelling_id":"dddac0de-99c0-461f-a729-2d4362d343f4","mortgagee_name":"Metropolis Bank","mortgage_loan_number":"123456789","replacement_cost_cents":50000000,"cash_value_cents":50000000,"property_data_fetched":true,"loss_settlement_type":"REPLACEMENT_COST","extended_replacement_cost_percent":50,"address":{"address_id":"b321cd10-16f0-4738-bc5d-eb3a49e39722","full_address":"344 Clinton Street, Apartment 3D, Brooklyn, NY, 11231","country":null,"address_nature":"PHYSICAL","number":"344","street":"Clinton","type":"St","city":"Brooklyn","state":"NY","sec_unit_type":"Apartment","sec_unit_num":"3D","zip":"11231"},"coverages":[{"dwelling_coverage_id":"7985df7e-6811-43fd-b8d3-71d98a9c9766","name":"DWELLING","friendly_name":"Dwelling Liability","premium_cents":140675,"per_person_limit_cents":null,"per_incident_limit_cents":28838000,"deductible_cents":null,"is_declined":false},{"dwelling_coverage_id":"d548b535-fe40-47da-92cd-ab3d970e241b","name":"OTHER_STRUCTURES","friendly_name":"Other Structures Liability","premium_cents":4896,"per_person_limit_cents":null,"per_incident_limit_cents":2883800,"per_incident_limit_percent":10,"deductible_cents":null,"is_declined":false},{"dwelling_coverage_id":"0b4994c4-5671-483e-bb26-2196a05bbaed","name":"PERSONAL_PROPERTY","friendly_name":"Personal Property Liability","premium_cents":23062,"per_person_limit_cents":null,"per_incident_limit_cents":14419000,"per_incident_limit_percent":50,"deductible_cents":null,"is_declined":false},{"dwelling_coverage_id":"4c0d5002-ad58-4cc2-ac01-8c0314b909d2","name":"LOSS_OF_USE","friendly_name":"Loss of Use","premium_cents":2437,"per_person_limit_cents":null,"per_incident_limit_cents":5767600,"per_incident_limit_percent":20,"deductible_cents":null,"is_declined":false},{"dwelling_coverage_id":"5528e164-b896-4e4b-9721-5769f3afc221","name":"PERSONAL_LIABILITY","friendly_name":"Personal Liability","premium_cents":2969,"per_person_limit_cents":null,"per_incident_limit_cents":10000000,"deductible_cents":null,"is_declined":false},{"dwelling_coverage_id":"7724d31b-1323-4058-9333-e28c8716a643","name":"MEDICAL_PAYMENTS","friendly_name":"Medical Payments","premium_cents":1310,"per_incident_limit_cents":null,"per_person_limit_cents":100000,"deductible_cents":null,"is_declined":false},{"dwelling_coverage_id":"e3fd64bf-ea70-4f2d-a43f-c428114e75c1","name":"ALL_OTHER_PERILS","friendly_name":"All Other Perils","premium_cents":null,"per_person_limit_cents":null,"per_incident_limit_cents":null,"deductible_cents":288380,"deductible_percent":1,"is_declined":false},{"dwelling_coverage_id":"c2ac825a-6ada-486f-b531-a4d8596c844d","name":"WINDSTORM_OR_HAIL","friendly_name":"Windstorm or Hail","premium_cents":null,"per_person_limit_cents":null,"per_incident_limit_cents":null,"deductible_cents":576760,"deductible_percent":2,"is_declined":false}],"mortgagee_address":{"address_id":"6ce95d67-5b4f-4351-9fdc-9c76e64d425e","full_address":"620 Atlantic Avenue, Brooklyn, NY, 11217","country":null,"address_nature":"MORTGAGEE","number":"620","street":"Atlantic","type":"Ave","city":"Brooklyn","state":"NY","zip":"11217"},"property_data":{"property_data_id":"0a8e5811-6610-4525-aa53-cba4f41a4cc3","dwelling_id":"dddac0de-99c0-461f-a729-2d4362d343f4","apn":"02192-04-018-000","class":"SINGLE_FAMILY_RESIDENCE_TOWNHOUSE","sub_type":"RESIDENTIAL","year_built":1950,"construction_type":"BRICK","wall_type":"BRICK","foundation_type":"CONCRETE","frame_type":"WOOD","roof_cover":"SHINGLE","roof_shape":"PYRAMID","cooling_type":"CENTRAL","heating_type":"CENTRAL","heating_fuel":"GAS","energy_type":"GOOD","sewer_type":"MUNICIPAL","building_shape":"L_SHAPED","construction_quality":"EXCELLENT","has_fireplace":true,"num_fireplaces":1,"fireplace_type":"YES","has_pool":false,"pool_type":"NO_POOL","square_ft":934,"num_beds":2,"num_baths_full":2,"num_baths_partial":1,"num_stories":2,"num_units":1,"garage_type":"ATTACHED_1_CAR","garage_square_ft":240,"num_parking_spaces":1,"assessed_improvement_value_cents":1423000,"assessed_land_value_cents":2291000,"assessed_total_value_cents":3714000,"market_improvement_value_cents":19900000,"market_land_value_cents":32040000,"market_total_value_cents":51940000,"owner1_first_name":"Clark Joseph","owner1_last_name":"Kent","owner2_first_name":"Lois","owner2_last_name":"Lane","owner3_first_name":null,"owner3_last_name":null,"owner4_first_name":null,"owner4_last_name":null,"first_mortgage_amount_cents":null,"first_mortgage_lender":null,"second_mortgage_amount_cents":null,"second_mortgage_lender":null,"purchase_date":"2016-06-29","purchase_price_cents":500000,"last_update_date":"2022-04-14"}}],"vehicles":[],"commercial_named_insureds":[],"named_insureds":[{"named_insured_id":"6100a170-aa1d-4ec4-b33c-b7436bb0c761","first_name":"Clark","middle_name":"Joseph","last_name":"Kent","full_name":"Clark Joseph Kent","is_primary_named_insured":true}],"forms_and_endorsements":[{"policy_form_id":"5eb50ce4-300b-45ae-b44f-44fa4662eaa7","form_name":"Your Nationwide Homeowners Policy","form_number":"H 00 03","form_type":"FORM","endorsement_type":null,"is_exclusion_endorsement":null,"pdf_available":true},{"policy_form_id":"40c5eb19-9a2a-4bf2-b715-90e4ee55963f","form_name":"Limited Water Back-Up and Sump Discharge or Overflow Coverage","form_number":"H 02 03","form_type":"ENDORSEMENT","endorsement_type":"WATER_BACKUP_COVERAGE","is_exclusion_endorsement":false,"pdf_available":true}]},{"policy_id":"b3e00891-29d4-4ac6-a906-9b6a162f6a09","name":"AUTO AU192837","description":"Effective 12/13/2022 - 06/13/2023","carrier_policy_number":"AU192837","policy_type":"AUTO","effective_date":"2022-12-13T06:00:00.000Z","expiry_date":"2023-06-13T05:00:00.000Z","renewal_date":null,"canceled_date":null,"total_premium_cents":50781,"carrier_name":"statefarm","status":"ACTIVE","limited_access":false,"form_of_business":null,"deductible_cents":null,"paid_in_full":false,"is_monoline":false,"dwellings":[],"vehicles":[{"vehicle_id":"e94fd52e-e22c-4536-8fcf-1f436b880dc0","year":2018,"make":"CHEVROLET","model":"Camaro","series":"ZL1","series2":null,"type":"PASSENGER CAR","annual_mileage":null,"vin":"1G1FK1R62J0158884","uses":null,"purchase_date":null,"ownership_type":null,"features":null,"lien_holder":"Metropolis Bank","is_removed":false,"garaging_address":{"address_id":"b321cd10-16f0-4738-bc5d-eb3a49e39722","full_address":"344 Clinton Street, Apartment 3D, Brooklyn, NY, 11231","country":null,"address_nature":"PHYSICAL","number":"344","street":"Clinton","type":"St","city":"Brooklyn","state":"NY","sec_unit_type":"Apartment","sec_unit_num":"3D","zip":"11231"},"lien_holder_address":{"address_id":"4772146c-f12e-4173-9624-5ab4920b7d8c","full_address":"620 Atlantic Avenue, Brooklyn, NY, 11217","country":null,"address_nature":"LIENHOLDER","number":"620","street":"Atlantic","type":"Ave","city":"Brooklyn","state":"NY","zip":"11217"},"coverages":[{"vehicle_coverage_id":"c56b9feb-aef6-4e15-9307-ed52667416a8","name":"COLLISION","friendly_name":"Collision","premium_cents":16439,"per_person_limit_cents":null,"per_incident_limit_cents":null,"per_day_limit_cents":null,"deductible_cents":50000,"is_declined":false,"per_mile_premium_tenth_of_cents":null},{"vehicle_coverage_id":"46d22c39-c280-4508-94cc-6ae28483463e","name":"COMPREHENSIVE","friendly_name":"Comprehensive","premium_cents":9731,"per_person_limit_cents":null,"per_incident_limit_cents":null,"per_day_limit_cents":null,"deductible_cents":50000,"is_declined":false,"per_mile_premium_tenth_of_cents":null},{"vehicle_coverage_id":"72cfca2d-7195-4f47-8794-be1c94565d89","name":"BODILY_INJURY_LIABILITY","friendly_name":"Bodily Injury Liability","premium_cents":11430,"per_person_limit_cents":10000000,"per_incident_limit_cents":30000000,"per_day_limit_cents":null,"deductible_cents":null,"is_declined":false,"per_mile_premium_tenth_of_cents":null},{"vehicle_coverage_id":"15f98e11-5345-4494-96c4-0dc3152194fa","name":"PROPERTY_DAMAGE_LIABILITY","friendly_name":"Property Damage Liability","premium_cents":10406,"per_person_limit_cents":null,"per_incident_limit_cents":5000000,"per_day_limit_cents":null,"deductible_cents":null,"is_declined":false,"per_mile_premium_tenth_of_cents":null},{"vehicle_coverage_id":"6bc73ca3-977e-424b-843b-3c1ba68ed249","name":"UNINSURED_MOTORISTS","friendly_name":"Uninsured Motorists","premium_cents":2775,"per_person_limit_cents":1500000,"per_incident_limit_cents":3000000,"per_day_limit_cents":null,"deductible_cents":null,"is_declined":false,"per_mile_premium_tenth_of_cents":null}],"drivers":[{"first_name":"Clark","middle_name":"Joseph","last_name":"Kent","drivers_license":"SUP1234017","drivers_license_state":"DC","date_of_birth_str":"05/03/1987","gender":"MALE","marital_status":"SINGLE","relationship_to_insured":"INSURED","age":null,"age_on_date":null,"education":null,"occupation":"Superhero","age_licensed":null,"driver_id":"1394c681-ebfe-475d-b390-d7157e33a895","is_excluded":false}],"GaragingAddress":{"address_id":"b321cd10-16f0-4738-bc5d-eb3a49e39722","full_address":"344 Clinton Street, Apartment 3D, Brooklyn, NY, 11231","country":null,"address_nature":"PHYSICAL","number":"344","street":"Clinton","type":"St","city":"Brooklyn","state":"NY","sec_unit_type":"Apartment","sec_unit_num":"3D","zip":"11231"},"LienHolderAddress":{"address_id":"4772146c-f12e-4173-9624-5ab4920b7d8c","full_address":"620 Atlantic Avenue, Brooklyn, NY, 11217","country":null,"address_nature":"LIENHOLDER","number":"620","street":"Atlantic","type":"Ave","city":"Brooklyn","state":"NY","zip":"11217"}}],"commercial_named_insureds":[],"named_insureds":[{"named_insured_id":"c0f07575-e9af-4144-9635-2c97ac729c95","first_name":"Clark","middle_name":"Joseph","last_name":"Kent","full_name":"Clark Joseph Kent","is_primary_named_insured":true}],"forms_and_endorsements":[{"policy_form_id":"0cf0c270-6b59-423c-8733-e2aaaca4efe6","form_name":"Roadside Assistance Coverage","form_number":"A 4568 07 16","form_type":"ENDORSEMENT","endorsement_type":"ROADSIDE_ASSISTANCE_COVERAGE","is_exclusion_endorsement":false,"pdf_available":true},{"policy_form_id":"3f8527c7-8b19-46dc-8ff3-45eb693d42f2","form_name":"Your Nationwide Auto Policy","form_number":"A 4500 07 16","form_type":"FORM","endorsement_type":null,"is_exclusion_endorsement":null,"pdf_available":true}]},{"policy_id":"8c9d0e1f-2a3b-4c5d-6e7f-8a9b0c1d2e3f","name":"TERM LIFE TL456789","description":"Effective 01/01/2024 - 01/01/2044","carrier_policy_number":"TL456789","policy_type":"TERM_LIFE","effective_date":"2024-01-01T06:00:00.000Z","expiry_date":"2044-01-01T06:00:00.000Z","renewal_date":null,"canceled_date":null,"total_premium_cents":125000,"carrier_name":"statefarm","carrier_friendly_name":"State Farm","status":"ACTIVE","limited_access":false,"form_of_business":null,"deductible_cents":null,"paid_in_full":false,"amount_paid_cents":62500,"amount_due_cents":62500,"is_monoline":false,"dwellings":[],"locations":[],"vehicles":[],"commercial_named_insureds":[],"named_insureds":[{"named_insured_id":"7b8c9d0e-1f2a-3b4c-5d6e-7f8a9b0c1d2e","first_name":"Clark","middle_name":"Joseph","last_name":"Kent","full_name":"Clark Joseph Kent","is_primary_named_insured":true}],"life":{"life_policy_details":[{"life_policy_details_id":"9d0e1f2a-3b4c-5d6e-7f8a-9b0c1d2e3f4a","policy_id":"8c9d0e1f-2a3b-4c5d-6e7f-8a9b0c1d2e3f","pull_id":"f2d3e4a5-b6c7-8d9e-0f1a-2b3c4d5e6f7a","face_amount_cents":100000000,"death_benefit_amount_cents":100000000,"total_cash_value_cents":null,"total_loan_balance_cents":null,"dividend_option":null,"total_accumulated_dividend_cents":null,"total_surrender_value_cents":null,"loan_variable_interest_rate_percent":null,"paid_up_date":null,"total_accumulated_dividend_on_date":null,"total_loan_balance_on_date":null,"total_cash_value_on_date":null,"total_surrender_value_on_date":null,"policy_owner_first_name":"Clark","policy_owner_middle_name":"Joseph","policy_owner_last_name":"Kent","policy_owner_full_name":"Clark Joseph Kent","policy_payor_first_name":"Clark","policy_payor_middle_name":"Joseph","policy_payor_last_name":"Kent","policy_payor_full_name":"Clark Joseph Kent","policy_owner_address":{"address_id":"a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d","full_address":"344 Clinton Street, Apartment 3D, Brooklyn, NY, 11231","country":null,"address_nature":"MAILING","number":"344","street":"Clinton","type":"St","city":"Brooklyn","state":"NY","sec_unit_type":"Apartment","sec_unit_num":"3D","zip":"11231"},"policy_payor_address":{"address_id":"b2c3d4e5-f6a7-8b9c-0d1e-2f3a4b5c6d7e","full_address":"344 Clinton Street, Apartment 3D, Brooklyn, NY, 11231","country":null,"address_nature":"MAILING","number":"344","street":"Clinton","type":"St","city":"Brooklyn","state":"NY","sec_unit_type":"Apartment","sec_unit_num":"3D","zip":"11231"}}],"life_policy_riders":[{"life_policy_rider_id":"c3d4e5f6-a7b8-9c0d-1e2f-3a4b5c6d7e8f","policy_id":"8c9d0e1f-2a3b-4c5d-6e7f-8a9b0c1d2e3f","pull_id":"f2d3e4a5-b6c7-8d9e-0f1a-2b3c4d5e6f7a","name":"ACCIDENTAL_DEATH","friendly_name":"Accidental Death Benefit","effective_date":"2024-01-01T06:00:00.000Z","expiry_date":"2044-01-01T06:00:00.000Z"},{"life_policy_rider_id":"d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f9a","policy_id":"8c9d0e1f-2a3b-4c5d-6e7f-8a9b0c1d2e3f","pull_id":"f2d3e4a5-b6c7-8d9e-0f1a-2b3c4d5e6f7a","name":"WAIVER_OF_PREMIUM","friendly_name":"Waiver of Premium","effective_date":"2024-01-01T06:00:00.000Z","expiry_date":"2044-01-01T06:00:00.000Z"}],"life_policy_beneficiaries":[{"life_policy_beneficiary_id":"e5f6a7b8-c9d0-1e2f-3a4b-5c6d7e8f9a0b","policy_id":"8c9d0e1f-2a3b-4c5d-6e7f-8a9b0c1d2e3f","pull_id":"f2d3e4a5-b6c7-8d9e-0f1a-2b3c4d5e6f7a","name_insured_id":"7b8c9d0e-1f2a-3b4c-5d6e-7f8a9b0c1d2e","type":"PRIMARY","first_name":"Lois","middle_name":null,"last_name":"Lane","full_name":"Lois Lane","relationship_to_insured":"SPOUSE","designation":"PER_STIRPES","distribution_percent":100}]}}],"drivers":[{"first_name":"Clark","middle_name":"Joseph","last_name":"Kent","drivers_license":"SUP1234017","drivers_license_state":"DC","date_of_birth_str":"05/03/1987","gender":"MALE","marital_status":"SINGLE","relationship_to_insured":"INSURED","age":null,"age_on_date":null,"education":null,"occupation":"Superhero","age_licensed":null,"driver_id":"1394c681-ebfe-475d-b390-d7157e33a895"}],"documents":[{"document_id":"4f9e5a60-8799-4e07-88e5-572fa6742a08","title":"12-13-2022 - AUTO AU192837 - Declarations","date_added":"2022-12-13T06:00:00.000Z","document_type":"DECLARATIONS","policy_id":"b3e00891-29d4-4ac6-a906-9b6a162f6a09","mime_type":"application/pdf"},{"document_id":"addf2ad6-8dc3-4bee-a980-a94933c8548a","title":"06-13-2022 - AUTO AU192837 - Declarations","date_added":"2022-06-13T05:00:00.000Z","document_type":"DECLARATIONS","policy_id":"b3e00891-29d4-4ac6-a906-9b6a162f6a09","mime_type":"application/pdf"},{"document_id":"227811c1-73a0-49b0-bc68-e81b835aa86c","title":"12-13-2022 - AUTO AU192837 - Insurance ID Card","date_added":"2022-12-13T06:00:00.000Z","document_type":"INSURANCE_ID_CARD","policy_id":"b3e00891-29d4-4ac6-a906-9b6a162f6a09","mime_type":"application/pdf"},{"document_id":"729d5c88-2d5c-4e3d-94a4-1037b297fb35","title":"06-13-2022 - AUTO AU192837 - Insurance ID Card","date_added":"2022-06-13T05:00:00.000Z","document_type":"INSURANCE_ID_CARD","policy_id":"b3e00891-29d4-4ac6-a906-9b6a162f6a09","mime_type":"application/pdf"},{"document_id":"d67929e8-b0b5-4030-a4fe-1ddaa1326d5f","title":"12-13-2022 - HOME HO132483 - Declarations","date_added":"2022-12-13T06:00:00.000Z","document_type":"DECLARATIONS","policy_id":"a5c3eac9-537c-4146-8de9-99fb55455126","mime_type":"application/pdf"},{"document_id":"ce00477d-5f58-46ae-96a0-0f3e624a9fee","title":"12-13-2021 - HOME HO132483 - Declarations","date_added":"2021-12-13T06:00:00.000Z","document_type":"DECLARATIONS","policy_id":"a5c3eac9-537c-4146-8de9-99fb55455126","mime_type":"application/pdf"}],"addresses":[{"address_id":"c64fd268-472a-4793-a5b5-c9ccaef8f89a","full_address":"344 Clinton Street, Apartment 3D, Brooklyn, NY, 11231","country":null,"address_nature":"MAILING","number":"344","street":"Clinton","type":"St","city":"Brooklyn","state":"NY","sec_unit_type":"Apartment","sec_unit_num":"3D","zip":"11231"},{"address_id":"b321cd10-16f0-4738-bc5d-eb3a49e39722","full_address":"344 Clinton Street, Apartment 3D, Brooklyn, NY, 11231","country":null,"address_nature":"PHYSICAL","number":"344","street":"Clinton","type":"St","city":"Brooklyn","state":"NY","sec_unit_type":"Apartment","sec_unit_num":"3D","zip":"11231"},{"address_id":"ef1faf3d-b09f-4edb-8784-6a1f91e02a68","full_address":"344 Clinton Street, Apartment 3D, Brooklyn, NY, 11231","country":null,"address_nature":"INCIDENT_LOCATION","number":"344","street":"Clinton","type":"St","city":"Brooklyn","state":"NY","sec_unit_type":"Apartment","sec_unit_num":"3D","zip":"11231"},{"address_id":"4772146c-f12e-4173-9624-5ab4920b7d8c","full_address":"620 Atlantic Avenue, Brooklyn, NY, 11217","country":null,"address_nature":"LIENHOLDER","number":"620","street":"Atlantic","type":"Ave","city":"Brooklyn","state":"NY","zip":"11217"},{"address_id":"4089002f-a2fb-4349-aad1-90710ad6a7a6","full_address":"1 Times Sq, New York, NY 10036","country":null,"address_nature":"AGENCY_LOCATION","number":"1","street":"Times","type":"Sq","city":"New York","state":"NY","zip":"10036"},{"address_id":"6ce95d67-5b4f-4351-9fdc-9c76e64d425e","full_address":"620 Atlantic Avenue, Brooklyn, NY, 11217","country":null,"address_nature":"MORTGAGEE","number":"620","street":"Atlantic","type":"Ave","city":"Brooklyn","state":"NY","zip":"11217"}],"claims":[{"claim_id":"0f86ca7f-89b4-40bf-9514-2aa6f685cf38","policy_id":"a5c3eac9-537c-4146-8de9-99fb55455126","dwelling_id":"dddac0de-99c0-461f-a729-2d4362d343f4","vehicle_id":null,"address_id":"ef1faf3d-b09f-4edb-8784-6a1f91e02a68","carrier_claim_identifier":"HO-12345","date_occurred":"2022-11-13T06:00:00.000Z","type":"WIND_AND_HAIL_DAMAGE","status":"OPEN","date_closed":null,"payout_cents":null,"representative_name":"Lois Lane","representative_phone":"8885553333","representative_email":"lois.lane@theplanet.com","driver_id":null},{"claim_id":"c260066b-b6ba-47bc-9fca-e70fec507b70","policy_id":"b3e00891-29d4-4ac6-a906-9b6a162f6a09","dwelling_id":null,"vehicle_id":"e94fd52e-e22c-4536-8fcf-1f436b880dc0","address_id":"ef1faf3d-b09f-4edb-8784-6a1f91e02a68","carrier_claim_identifier":"AU-54321","date_occurred":"2021-12-13T06:00:00.000Z","type":"THEFT","status":"CLOSED","date_closed":"2022-04-13T05:00:00.000Z","payout_cents":2750000,"representative_name":"Jimmy Olsen","representative_phone":"8885554444","representative_email":"jimmy.olsen@theplanet.com","driver_id":"1394c681-ebfe-475d-b390-d7157e33a895"}],"driving_records":[{"driving_record_id":"1019dcff-ee37-4103-8b28-3f2d168835c1","incident_date":"2021-06-13T05:00:00.000Z","incident_type":"ACCIDENT","violation_type":null,"is_at_fault":false,"driver_id":"1394c681-ebfe-475d-b390-d7157e33a895"},{"driving_record_id":"fb1ae829-52c9-4754-a842-464d562e027e","incident_date":"2020-12-13T06:00:00.000Z","incident_type":"VIOLATION","violation_type":"SPEEDING","is_at_fault":null,"driver_id":"1394c681-ebfe-475d-b390-d7157e33a895"}],"loss_events":[],"agents":[{"agent_info_id":"a690aa3c-348d-4811-b0f4-83a576e4d6d6","address_id":"4089002f-a2fb-4349-aad1-90710ad6a7a6","agency_name":"Metropolis Insurance Agency","agent_full_name":"Sam Lane","phone_number":"8885552222","email":"sam.lane@theplanet.com","policy_ids":["b3e00891-29d4-4ac6-a906-9b6a162f6a09","a5c3eac9-537c-4146-8de9-99fb55455126"]}]}}},"Commercial Example Response":{"value":{"success":true,"pull":{"pull_id":"ab15384c-c3e9-410b-b73a-bea4a6d8f91e","status":"SUCCESS","first_name":"Clark","middle_name":"Joseph","last_name":"Kent","email":null,"account_email":"clark.kent@theplanet.com","phone":"8885550000","mobile_phone":"8885550000","home_phone":"","work_phone":"8885555555","work_phone_extension":"","insurance_provider_name":"statefarm","team_id":"394661bc-6361-46f0-8b11-4106d6146cb4","widget_id":"d2bb6d56-15ff-4760-a27c-362f9bce645a","meta_data":{},"is_archived":false,"created_at":"2024-02-08T15:00:44.754Z","public_alias":"demo","public_url":"https://app.usecanopy.com/c/demo","no_policies":false,"no_drivers":false,"no_documents":false,"no_claims":false,"no_loss_events":false,"skipped_product_types":null,"type":"PULLING_DATA","policies":[{"policy_id":"2ae5f757-b53f-4200-a26d-fd357ec277a2","name":"COMMERCIAL AUTO AU192837","description":"Effective 01/09/2024 - 07/09/2024","carrier_policy_number":"AU192837","policy_type":"COMMERCIAL_AUTO","effective_date":"2024-01-09T05:00:00.000Z","expiry_date":"2024-07-09T04:00:00.000Z","renewal_date":null,"canceled_date":null,"total_premium_cents":540348,"carrier_name":"statefarm","status":"ACTIVE","limited_access":false,"form_of_business":"CORPORATION","deductible_cents":null,"paid_in_full":false,"amount_due_cents":null,"amount_paid_cents":null,"total_estimated_annual_premium_cents":null,"total_minimum_premium_cents":null,"total_deposit_premium_cents":null,"is_monoline":false,"dwellings":[],"locations":[{"location_id":"5467b202-7e9a-4be1-8db1-04cacb990142","carrier_location_identifier":null,"loss_settlement_type":null,"property_data_fetched":true,"address":{"address_id":"904ed43a-807c-4e52-8811-c8da5e62f63e","full_address":"344 Clinton Street, Unit 3D, Brooklyn, NY, 11231","country":null,"address_nature":"PHYSICAL","number":"344","street":"Clinton","type":"St","city":"Brooklyn","state":"NY","sec_unit_type":"Unit","sec_unit_num":"3D","zip":"11231"},"coverages":[],"operations":[],"mortgagees":[],"property_data":{"property_data_id":"5011516d-973b-4b74-9e8b-76b893dbc164","apn":"02192-04-018-000","class":"COMMERCIAL","sub_type":"COMMERCIAL","year_built":1950,"construction_type":"BRICK","wall_type":"BRICK","foundation_type":"CONCRETE","frame_type":"WOOD","roof_cover":"SHINGLE","roof_shape":"PYRAMID","cooling_type":"CENTRAL","heating_type":"CENTRAL","heating_fuel":"GAS","energy_type":"GOOD","sewer_type":"MUNICIPAL","building_shape":"L_SHAPED","construction_quality":"EXCELLENT","has_fireplace":false,"num_fireplaces":null,"fireplace_type":null,"has_pool":false,"pool_type":"NO_POOL","square_ft":2934,"num_beds":null,"num_baths_full":2,"num_baths_partial":1,"num_stories":2,"num_units":1,"garage_type":"NO_GARAGE","garage_square_ft":null,"num_parking_spaces":5,"assessed_improvement_value_cents":1423000,"assessed_land_value_cents":2291000,"assessed_total_value_cents":3714000,"market_improvement_value_cents":19900000,"market_land_value_cents":32040000,"market_total_value_cents":51940000,"owner1_first_name":"Clark Joseph","owner1_last_name":"Kent","owner2_first_name":"Lois","owner2_last_name":"Lane","owner3_first_name":null,"owner3_last_name":null,"owner4_first_name":null,"owner4_last_name":null,"first_mortgage_amount_cents":null,"first_mortgage_lender":null,"second_mortgage_amount_cents":null,"second_mortgage_lender":null,"purchase_date":"2016-06-29","purchase_price_cents":50000000,"last_update_date":"2022-04-14"}}],"vehicles":[{"vehicle_id":"ec13962f-75ff-4968-8984-89d678b3744f","year":2005,"make":"CHEVROLET","model":"Express","series":"3500","series2":null,"type":"CARGO VAN","annual_mileage":null,"vin":"1GAHG39U651194937","hin":null,"serial_number":null,"uses":null,"purchase_date":null,"ownership_type":null,"features":null,"lien_holder":"Metropolis Bank","is_removed":false,"garaging_address":{"address_id":"904ed43a-807c-4e52-8811-c8da5e62f63e","full_address":"344 Clinton Street, Unit 3D, Brooklyn, NY, 11231","country":null,"address_nature":"PHYSICAL","number":"344","street":"Clinton","type":"St","city":"Brooklyn","state":"NY","sec_unit_type":"Unit","sec_unit_num":"3D","zip":"11231"},"lien_holder_address":{"address_id":"04236b0e-1a19-42a7-b713-3d23035e122a","full_address":"620 Atlantic Avenue, Brooklyn, NY, 11217","country":null,"address_nature":"LIENHOLDER","number":"620","street":"Atlantic","type":"Ave","city":"Brooklyn","state":"NY","zip":"11217"},"coverages":[{"vehicle_coverage_id":"bec34121-97f7-4584-8f2a-93fc5c964c52","name":"COLLISION","friendly_name":"Collision","premium_cents":195841,"per_person_limit_cents":null,"per_person_unlimited":false,"per_incident_limit_cents":null,"per_incident_unlimited":false,"per_day_limit_cents":null,"deductible_cents":50000,"actual_cash_value":false,"is_declined":false,"per_mile_premium_tenth_of_cents":null,"max_days":null},{"vehicle_coverage_id":"6579500c-45b9-4c43-92a4-85f33fa1e438","name":"COMPREHENSIVE","friendly_name":"Comprehensive","premium_cents":90266,"per_person_limit_cents":null,"per_person_unlimited":false,"per_incident_limit_cents":null,"per_incident_unlimited":false,"per_day_limit_cents":null,"deductible_cents":50000,"actual_cash_value":false,"is_declined":false,"per_mile_premium_tenth_of_cents":null,"max_days":null},{"vehicle_coverage_id":"812a38bd-803c-46af-8856-7550c8e0f1d3","name":"BODILY_INJURY_LIABILITY","friendly_name":"Bodily Injury Liability","premium_cents":123837,"per_person_limit_cents":10000000,"per_person_unlimited":false,"per_incident_limit_cents":30000000,"per_incident_unlimited":false,"per_day_limit_cents":null,"deductible_cents":null,"actual_cash_value":false,"is_declined":false,"per_mile_premium_tenth_of_cents":null,"max_days":null},{"vehicle_coverage_id":"4c44e684-eb20-4f4b-b016-75c61d3d1216","name":"PROPERTY_DAMAGE_LIABILITY","friendly_name":"Property Damage Liability","premium_cents":114441,"per_person_limit_cents":null,"per_person_unlimited":false,"per_incident_limit_cents":5000000,"per_incident_unlimited":false,"per_day_limit_cents":null,"deductible_cents":null,"actual_cash_value":false,"is_declined":false,"per_mile_premium_tenth_of_cents":null,"max_days":null},{"vehicle_coverage_id":"f755875a-b0a5-48e5-9d45-97ab4e0d00ba","name":"UNINSURED_MOTORISTS","friendly_name":"Uninsured Motorists","premium_cents":15963,"per_person_limit_cents":1500000,"per_person_unlimited":false,"per_incident_limit_cents":3000000,"per_incident_unlimited":false,"per_day_limit_cents":null,"deductible_cents":null,"actual_cash_value":false,"is_declined":false,"per_mile_premium_tenth_of_cents":null,"max_days":null}],"drivers":[{"first_name":"Clark","middle_name":"Joseph","last_name":"Kent","drivers_license":"SUP1234017","drivers_license_state":"DC","date_of_birth_str":"05/03/1987","gender":"MALE","marital_status":"SINGLE","relationship_to_insured":"INSURED","age":null,"age_on_date":null,"education":null,"occupation":"Superhero","age_licensed":null,"driver_id":"8341256f-7826-4c71-96ac-b6b7af99874b","is_excluded":false}],"GaragingAddress":{"address_id":"904ed43a-807c-4e52-8811-c8da5e62f63e","full_address":"344 Clinton Street, Unit 3D, Brooklyn, NY, 11231","country":null,"address_nature":"PHYSICAL","number":"344","street":"Clinton","type":"St","city":"Brooklyn","state":"NY","sec_unit_type":"Unit","sec_unit_num":"3D","zip":"11231"},"LienHolderAddress":{"address_id":"04236b0e-1a19-42a7-b713-3d23035e122a","full_address":"620 Atlantic Avenue, Brooklyn, NY, 11217","country":null,"address_nature":"LIENHOLDER","number":"620","street":"Atlantic","type":"Ave","city":"Brooklyn","state":"NY","zip":"11217"}}],"commercial_named_insureds":[{"commercial_named_insured_id":"4fac92b9-ddce-48a6-86b9-8ae87018af81","address_id":"e15cc319-f712-4208-beae-543830d05960","location_id":"5467b202-7e9a-4be1-8db1-04cacb990142","name":"Metropolis Bank","form_of_business":"CORPORATION","gl_code":"1110","sic_code":"602","naics_code":"522110","fein":"01-2345678","business_phone":"8885550000","business_email":"hello@metropolis.com","website_url":"https://www.metropolis.com","is_primary_named_insured":true,"number_of_employees":null,"minimum_premium_cents":null,"total_estimated_annual_premium_cents":null}],"named_insureds":[],"forms_and_endorsements":[{"policy_form_id":"a5980b1c-a69b-4fe9-8cac-d003d82fc5e0","form_name":"Business Auto Coverage Form","form_number":"CA 00 01 03 10","form_type":"FORM","endorsement_type":null,"is_exclusion_endorsement":null,"pdf_available":true},{"policy_form_id":"77cdc302-45cb-4ec0-ab0c-4ad4ae9ed6aa","form_name":"Additional Insured Endorsement","form_number":"00 CA0070 00 09 06","form_type":"ENDORSEMENT","endorsement_type":"ADDITIONAL_INSURED","is_exclusion_endorsement":false,"pdf_available":true}]},{"policy_id":"b4ec17a7-6a8c-461b-b86a-622a821a6dd4","name":"BUSINESS OWNERS BO132483","description":"Effective 01/09/2024 - 01/09/2025","carrier_policy_number":"BO132483","policy_type":"BUSINESS_OWNERS","effective_date":"2024-01-09T05:00:00.000Z","expiry_date":"2025-01-09T05:00:00.000Z","renewal_date":null,"canceled_date":null,"total_premium_cents":525345,"carrier_name":"statefarm","status":"ACTIVE","limited_access":false,"form_of_business":"CORPORATION","deductible_cents":50000,"paid_in_full":false,"amount_due_cents":null,"amount_paid_cents":null,"total_estimated_annual_premium_cents":null,"total_minimum_premium_cents":null,"total_deposit_premium_cents":null,"is_monoline":false,"dwellings":[],"locations":[{"location_id":"689fd30c-96d5-4b2b-9341-774f5c51dc61","carrier_location_identifier":null,"loss_settlement_type":null,"property_data_fetched":true,"address":{"address_id":"904ed43a-807c-4e52-8811-c8da5e62f63e","full_address":"344 Clinton Street, Unit 3D, Brooklyn, NY, 11231","country":null,"address_nature":"PHYSICAL","number":"344","street":"Clinton","type":"St","city":"Brooklyn","state":"NY","sec_unit_type":"Unit","sec_unit_num":"3D","zip":"11231"},"coverages":[{"location_coverage_id":"2a8cd167-12c2-4442-a261-19158e15a123","name":"BUILDING","friendly_name":"Building","premium_cents":null,"per_person_limit_cents":null,"per_incident_limit_cents":100000000,"per_term_limit_cents":null,"per_employee_limit_cents":null,"als_months":null,"deductible_cents":null,"deductible_percent":null,"is_declined":false},{"location_coverage_id":"95150350-4f3f-4969-a5bc-68266b98c564","name":"BUSINESS_PERSONAL_PROPERTY","friendly_name":"Business Personal Property","premium_cents":null,"per_person_limit_cents":null,"per_incident_limit_cents":25000000,"per_term_limit_cents":null,"per_employee_limit_cents":null,"als_months":null,"deductible_cents":null,"deductible_percent":null,"is_declined":false},{"location_coverage_id":"ac99dbcc-526e-48fe-8722-b45d3eef9ef0","name":"GENERAL_AGGREGATE","friendly_name":"General Aggregate","premium_cents":null,"per_person_limit_cents":null,"per_incident_limit_cents":null,"per_term_limit_cents":100000000,"per_employee_limit_cents":null,"als_months":null,"deductible_cents":null,"deductible_percent":null,"is_declined":false},{"location_coverage_id":"318b5411-473b-4a06-8c55-888ea6395e3b","name":"PRODUCTS_AND_COMPLETED_OPERATIONS_AGGREGATE","friendly_name":"Products and Completed Operations Aggregate","premium_cents":null,"per_person_limit_cents":null,"per_incident_limit_cents":100000000,"per_term_limit_cents":null,"per_employee_limit_cents":null,"als_months":null,"deductible_cents":null,"deductible_percent":null,"is_declined":false},{"location_coverage_id":"6566c550-3577-4a1f-885a-22d8969fe1d2","name":"PERSONAL_AND_ADVERTISING_INJURY","friendly_name":"Personal and Advertising Injury","premium_cents":null,"per_person_limit_cents":null,"per_incident_limit_cents":50000000,"per_term_limit_cents":null,"per_employee_limit_cents":null,"als_months":null,"deductible_cents":null,"deductible_percent":null,"is_declined":false},{"location_coverage_id":"6885beed-b7a5-4322-aa99-4a8214c367f4","name":"MEDICAL_EXPENSE","friendly_name":"Medical Expense","premium_cents":null,"per_person_limit_cents":500000,"per_incident_limit_cents":null,"per_term_limit_cents":null,"per_employee_limit_cents":null,"als_months":null,"deductible_cents":null,"deductible_percent":null,"is_declined":false},{"location_coverage_id":"4f73da4c-7c90-4b63-accc-bff0380ca8f9","name":"BUSINESS_INCOME_AND_EXTRA_EXPENSE","friendly_name":"Business Income and Extra Expense","premium_cents":null,"per_person_limit_cents":null,"per_incident_limit_cents":null,"per_term_limit_cents":null,"per_employee_limit_cents":null,"als_months":12,"deductible_cents":null,"deductible_percent":null,"is_declined":false},{"location_coverage_id":"c1d2d343-cdcf-4220-8c7a-d11636154e01","name":"ACCOUNTS_RECEIVABLE","friendly_name":"Accounts Receivable","premium_cents":null,"per_person_limit_cents":null,"per_incident_limit_cents":2500000,"per_term_limit_cents":null,"per_employee_limit_cents":null,"als_months":null,"deductible_cents":null,"deductible_percent":null,"is_declined":false},{"location_coverage_id":"0c27e5e1-71de-4749-be07-6513213f833d","name":"VALUABLE_PAPERS_AND_RECORDS_ON_PREMISES","friendly_name":"Valuable Papers and Records on Premises","premium_cents":null,"per_person_limit_cents":null,"per_incident_limit_cents":2500000,"per_term_limit_cents":null,"per_employee_limit_cents":null,"als_months":null,"deductible_cents":null,"deductible_percent":null,"is_declined":false},{"location_coverage_id":"1ed9bc44-49e4-4cf0-8c4a-d11a26738c1e","name":"ALL_PERILS","friendly_name":"All Perils","premium_cents":null,"per_person_limit_cents":null,"per_incident_limit_cents":null,"per_term_limit_cents":null,"per_employee_limit_cents":null,"als_months":null,"deductible_cents":500000,"deductible_percent":null,"is_declined":false}],"operations":[],"mortgagees":[],"property_data":{"property_data_id":"b89e4e6f-4d63-432e-817f-892166509ada","apn":"02192-04-018-000","class":"COMMERCIAL","sub_type":"COMMERCIAL","year_built":1950,"construction_type":"BRICK","wall_type":"BRICK","foundation_type":"CONCRETE","frame_type":"WOOD","roof_cover":"SHINGLE","roof_shape":"PYRAMID","cooling_type":"CENTRAL","heating_type":"CENTRAL","heating_fuel":"GAS","energy_type":"GOOD","sewer_type":"MUNICIPAL","building_shape":"L_SHAPED","construction_quality":"EXCELLENT","has_fireplace":false,"num_fireplaces":null,"fireplace_type":null,"has_pool":false,"pool_type":"NO_POOL","square_ft":2934,"num_beds":null,"num_baths_full":2,"num_baths_partial":1,"num_stories":2,"num_units":1,"garage_type":"NO_GARAGE","garage_square_ft":null,"num_parking_spaces":5,"assessed_improvement_value_cents":1423000,"assessed_land_value_cents":2291000,"assessed_total_value_cents":3714000,"market_improvement_value_cents":19900000,"market_land_value_cents":32040000,"market_total_value_cents":51940000,"owner1_first_name":"Clark Joseph","owner1_last_name":"Kent","owner2_first_name":"Lois","owner2_last_name":"Lane","owner3_first_name":null,"owner3_last_name":null,"owner4_first_name":null,"owner4_last_name":null,"first_mortgage_amount_cents":null,"first_mortgage_lender":null,"second_mortgage_amount_cents":null,"second_mortgage_lender":null,"purchase_date":"2016-06-29","purchase_price_cents":50000000,"last_update_date":"2022-04-14"}}],"vehicles":[],"commercial_named_insureds":[{"commercial_named_insured_id":"f65870e1-79c0-4433-a761-56052c2f3e33","address_id":"e15cc319-f712-4208-beae-543830d05960","location_id":"689fd30c-96d5-4b2b-9341-774f5c51dc61","name":"Metropolis Bank","form_of_business":"CORPORATION","gl_code":"1110","sic_code":"602","naics_code":"522110","fein":"01-2345678","business_phone":"8885550000","business_email":"hello@metropolis.com","website_url":"https://www.metropolis.com","is_primary_named_insured":true,"number_of_employees":null,"minimum_premium_cents":null,"total_estimated_annual_premium_cents":null}],"named_insureds":[],"forms_and_endorsements":[{"policy_form_id":"c22b4f28-7c88-4b5a-b56a-e17a97c695ea","form_name":"Businessowners Coverage Form","form_number":"BP 00 03 01 10","form_type":"FORM","endorsement_type":null,"is_exclusion_endorsement":null,"pdf_available":true},{"policy_form_id":"218e5261-0b76-44ca-b3b4-752bb6214459","form_name":"Additional Coverage - Accounts Receivable","form_number":"UND 1201 08 15","form_type":"ENDORSEMENT","endorsement_type":"ACCOUNTS_RECEIVABLE_COVERAGE","is_exclusion_endorsement":false,"pdf_available":true}]},{"policy_id":"7c017c39-6239-4b4f-a07a-3666f0400707","name":"WORKERS_COMPENSATION WC142648","description":"Effective 01/09/2024 - 01/09/2025","carrier_policy_number":"WC142648","policy_type":"WORKERS_COMPENSATION","effective_date":"2024-01-09T05:00:00.000Z","expiry_date":"2025-01-09T05:00:00.000Z","renewal_date":null,"canceled_date":null,"total_premium_cents":382550,"carrier_name":"statefarm","status":"ACTIVE","limited_access":false,"form_of_business":"CORPORATION","deductible_cents":50000,"paid_in_full":false,"amount_due_cents":null,"amount_paid_cents":null,"total_estimated_annual_premium_cents":382550,"total_minimum_premium_cents":76510,"total_deposit_premium_cents":null,"is_monoline":false,"dwellings":[],"locations":[{"location_id":"f6c212d3-90de-40d3-a812-f22e69dc5db7","carrier_location_identifier":null,"loss_settlement_type":null,"property_data_fetched":true,"address":{"address_id":"904ed43a-807c-4e52-8811-c8da5e62f63e","full_address":"344 Clinton Street, Unit 3D, Brooklyn, NY, 11231","country":null,"address_nature":"PHYSICAL","number":"344","street":"Clinton","type":"St","city":"Brooklyn","state":"NY","sec_unit_type":"Unit","sec_unit_num":"3D","zip":"11231"},"coverages":[{"location_coverage_id":"d1de6d97-fed4-4a78-ab7b-3949c8b93581","name":"BODILY_INJURY_BY_ACCIDENT","friendly_name":"Bodily Injury by Accident","premium_cents":null,"per_person_limit_cents":null,"per_incident_limit_cents":50000000,"per_term_limit_cents":null,"per_employee_limit_cents":null,"als_months":null,"deductible_cents":null,"deductible_percent":null,"is_declined":false},{"location_coverage_id":"4221650b-2acc-45fe-9ede-d1fe9e34e143","name":"BODILY_INJURY_BY_DISEASE","friendly_name":"Bodily Injury by Disease","premium_cents":null,"per_person_limit_cents":null,"per_incident_limit_cents":null,"per_term_limit_cents":50000000,"per_employee_limit_cents":50000000,"als_months":null,"deductible_cents":null,"deductible_percent":null,"is_declined":false}],"operations":[{"location_operation_id":"f51f537b-24e9-46fe-9008-ae150b5b5547","class_code":"8855","description":"Banks And Trust Companies-—All Employees, Salespersons, Drivers & Clerical","estimated_annual_remunerations_cents":100000000,"rate_cents":35,"estimated_annual_premium_cents":350000}],"mortgagees":[],"property_data":{"property_data_id":"0738d79b-7eb9-4fcb-bb1c-fe88ffa43910","apn":"02192-04-018-000","class":"COMMERCIAL","sub_type":"COMMERCIAL","year_built":1950,"construction_type":"BRICK","wall_type":"BRICK","foundation_type":"CONCRETE","frame_type":"WOOD","roof_cover":"SHINGLE","roof_shape":"PYRAMID","cooling_type":"CENTRAL","heating_type":"CENTRAL","heating_fuel":"GAS","energy_type":"GOOD","sewer_type":"MUNICIPAL","building_shape":"L_SHAPED","construction_quality":"EXCELLENT","has_fireplace":false,"num_fireplaces":null,"fireplace_type":null,"has_pool":false,"pool_type":"NO_POOL","square_ft":2934,"num_beds":null,"num_baths_full":2,"num_baths_partial":1,"num_stories":2,"num_units":1,"garage_type":"NO_GARAGE","garage_square_ft":null,"num_parking_spaces":5,"assessed_improvement_value_cents":1423000,"assessed_land_value_cents":2291000,"assessed_total_value_cents":3714000,"market_improvement_value_cents":19900000,"market_land_value_cents":32040000,"market_total_value_cents":51940000,"owner1_first_name":"Clark Joseph","owner1_last_name":"Kent","owner2_first_name":"Lois","owner2_last_name":"Lane","owner3_first_name":null,"owner3_last_name":null,"owner4_first_name":null,"owner4_last_name":null,"first_mortgage_amount_cents":null,"first_mortgage_lender":null,"second_mortgage_amount_cents":null,"second_mortgage_lender":null,"purchase_date":"2016-06-29","purchase_price_cents":50000000,"last_update_date":"2022-04-14"}}],"vehicles":[],"commercial_named_insureds":[{"commercial_named_insured_id":"057a0300-7cb9-4949-a416-abe9d4092330","address_id":"e15cc319-f712-4208-beae-543830d05960","location_id":"f6c212d3-90de-40d3-a812-f22e69dc5db7","name":"Metropolis Bank","form_of_business":"CORPORATION","gl_code":"1110","sic_code":"602","naics_code":"522110","fein":"01-2345678","business_phone":"8885550000","business_email":"hello@metropolis.com","website_url":"https://www.metropolis.com","is_primary_named_insured":true,"number_of_employees":10,"minimum_premium_cents":76510,"total_estimated_annual_premium_cents":382550}],"named_insureds":[],"forms_and_endorsements":[{"policy_form_id":"cc6484da-eb3f-4fc7-a496-87c880c215ba","form_name":"Workers Compensation and Employers Liability Insurance Policy","form_number":"WC 00 00 00 B","form_type":"FORM","endorsement_type":null,"is_exclusion_endorsement":null,"pdf_available":true},{"policy_form_id":"1ef5e8e4-a14b-4ee0-af9c-a5e17a2eff27","form_name":"90-Day Reporting Requirement-Notification of Change in Ownership Endorsement","form_number":"WC 00 04 14 A","form_type":"ENDORSEMENT","endorsement_type":"NOTIFICATION_OF_CHANGE_IN_OWNERSHIP","is_exclusion_endorsement":false,"pdf_available":true}]}],"drivers":[{"first_name":"Clark","middle_name":"Joseph","last_name":"Kent","drivers_license":"SUP1234017","drivers_license_state":"DC","date_of_birth_str":"05/03/1987","gender":"MALE","marital_status":"SINGLE","relationship_to_insured":"INSURED","age":null,"age_on_date":null,"education":null,"occupation":"Superhero","age_licensed":null,"driver_id":"8341256f-7826-4c71-96ac-b6b7af99874b"}],"documents":[{"document_id":"e7ca95d1-58d3-427a-a3ec-a420371395b2","title":"01-09-2024 - COMMERCIAL AUTO AU192837 - Declarations","date_added":"2024-01-09T05:00:00.000Z","document_type":"DECLARATIONS","policy_id":"2ae5f757-b53f-4200-a26d-fd357ec277a2","mime_type":"application/pdf"},{"document_id":"6eb6cb4b-d8cc-4821-a1cf-7f41e165ee0a","title":"07-09-2023 - COMMERCIAL AUTO AU192837 - Declarations","date_added":"2023-07-09T04:00:00.000Z","document_type":"DECLARATIONS","policy_id":"2ae5f757-b53f-4200-a26d-fd357ec277a2","mime_type":"application/pdf"},{"document_id":"e4719383-2d0e-4728-a5e7-3132011a1ed8","title":"01-09-2024 - COMMERCIAL AUTO AU192837 - Insurance ID Card","date_added":"2024-01-09T05:00:00.000Z","document_type":"INSURANCE_ID_CARD","policy_id":"2ae5f757-b53f-4200-a26d-fd357ec277a2","mime_type":"application/pdf"},{"document_id":"f3f1d884-353a-4798-a2b3-9acbb2e7338a","title":"07-09-2023 - COMMERCIAL AUTO AU192837 - Insurance ID Card","date_added":"2023-07-09T04:00:00.000Z","document_type":"INSURANCE_ID_CARD","policy_id":"2ae5f757-b53f-4200-a26d-fd357ec277a2","mime_type":"application/pdf"},{"document_id":"883a60e4-02a2-4281-94ff-699e2e83cfde","title":"01-09-2024 - BUSINESS OWNERS BO132483 - Declarations","date_added":"2024-01-09T05:00:00.000Z","document_type":"DECLARATIONS","policy_id":"b4ec17a7-6a8c-461b-b86a-622a821a6dd4","mime_type":"application/pdf"},{"document_id":"325906b9-a495-475f-a8d1-e8da159861ec","title":"01-09-2023 - BUSINESS OWNERS BO132483 - Declarations","date_added":"2023-01-09T05:00:00.000Z","document_type":"DECLARATIONS","policy_id":"b4ec17a7-6a8c-461b-b86a-622a821a6dd4","mime_type":"application/pdf"},{"document_id":"3ec315d9-f0ca-4026-8be9-638ef6b35fd2","title":"01-09-2024 - WORKERS_COMPENSATION WC142648 - Declarations","date_added":"2024-01-09T05:00:00.000Z","document_type":"DECLARATIONS","policy_id":"7c017c39-6239-4b4f-a07a-3666f0400707","mime_type":"application/pdf"},{"document_id":"5d8d4f96-4bd3-47ce-94d0-ff5bd5785e9f","title":"01-09-2023 - WORKERS_COMPENSATION WC142648 - Declarations","date_added":"2023-01-09T05:00:00.000Z","document_type":"DECLARATIONS","policy_id":"7c017c39-6239-4b4f-a07a-3666f0400707","mime_type":"application/pdf"},{"document_id":"7a900d27-3905-44ff-a221-464df02604f4","title":"02-08-2024 - WORKERS_COMPENSATION WC142648 - Loss Run Report","date_added":"2024-02-08T15:01:21.347Z","document_type":"LOSS_RUN","policy_id":"7c017c39-6239-4b4f-a07a-3666f0400707","mime_type":"application/pdf"},{"document_id":"5d20e2eb-3529-474e-b001-2e8ebd305574","title":"02-08-2024 - COMMERCIAL AUTO AU192837 - Loss Run Report","date_added":"2024-02-08T15:01:21.348Z","document_type":"LOSS_RUN","policy_id":"2ae5f757-b53f-4200-a26d-fd357ec277a2","mime_type":"application/pdf"},{"document_id":"c32f8c8f-016a-4c87-ba4f-5bbdaff1fb4d","title":"02-08-2024 - BUSINESS OWNERS BO132483 - Loss Run Report","date_added":"2024-02-08T15:01:21.358Z","document_type":"LOSS_RUN","policy_id":"b4ec17a7-6a8c-461b-b86a-622a821a6dd4","mime_type":"application/pdf"}],"addresses":[{"address_id":"e15cc319-f712-4208-beae-543830d05960","full_address":"344 Clinton Street, Unit 3D, Brooklyn, NY, 11231","country":null,"address_nature":"MAILING","number":"344","street":"Clinton","type":"St","city":"Brooklyn","state":"NY","sec_unit_type":"Unit","sec_unit_num":"3D","zip":"11231"},{"address_id":"904ed43a-807c-4e52-8811-c8da5e62f63e","full_address":"344 Clinton Street, Unit 3D, Brooklyn, NY, 11231","country":null,"address_nature":"PHYSICAL","number":"344","street":"Clinton","type":"St","city":"Brooklyn","state":"NY","sec_unit_type":"Unit","sec_unit_num":"3D","zip":"11231"},{"address_id":"76f61caa-e981-4ee2-975b-81315e2f095b","full_address":"344 Clinton Street, Unit 3D, Brooklyn, NY, 11231","country":null,"address_nature":"INCIDENT_LOCATION","number":"344","street":"Clinton","type":"St","city":"Brooklyn","state":"NY","sec_unit_type":"Unit","sec_unit_num":"3D","zip":"11231"},{"address_id":"04236b0e-1a19-42a7-b713-3d23035e122a","full_address":"620 Atlantic Avenue, Brooklyn, NY, 11217","country":null,"address_nature":"LIENHOLDER","number":"620","street":"Atlantic","type":"Ave","city":"Brooklyn","state":"NY","zip":"11217"},{"address_id":"214ef93f-3933-42cf-b775-7b669e88d23f","full_address":"1 Times Sq, New York, NY 10036","country":null,"address_nature":"AGENCY_LOCATION","number":"1","street":"Times","type":"Sq","city":"New York","state":"NY","zip":"10036"}],"claims":[],"driving_records":[],"loss_events":[{"loss_event_id":"fcb424bb-a2c4-4d3a-88b0-a82262203862","policy_id":"2ae5f757-b53f-4200-a26d-fd357ec277a2","date_of_occurrence":"2023-12-10T05:00:00.000Z","type":"BURGLARY_AND_THEFT","date_of_claim":"2023-12-12T05:00:00.000Z","amount_paid_cents":2750000,"amount_reserved_cents":500000,"is_subrogation":false,"is_claim_open":false},{"loss_event_id":"93728672-baed-45b5-9872-6cb5e9ca968c","policy_id":"7c017c39-6239-4b4f-a07a-3666f0400707","date_of_occurrence":"2023-01-09T05:00:00.000Z","type":"EMPLOYEE_INJURY_OR_ILLNESS","date_of_claim":"2023-01-24T05:00:00.000Z","amount_paid_cents":4000000,"amount_reserved_cents":null,"is_subrogation":false,"is_claim_open":true}],"agents":[{"agent_info_id":"a866ebfc-e94e-4ce8-9792-10feea7500ce","address_id":"214ef93f-3933-42cf-b775-7b669e88d23f","agency_name":"Metropolis Insurance Agency","agent_full_name":"Sam Lane","phone_number":"8885552222","email":"sam.lane@theplanet.com","policy_ids":["2ae5f757-b53f-4200-a26d-fd357ec277a2","b4ec17a7-6a8c-461b-b86a-622a821a6dd4","7c017c39-6239-4b4f-a07a-3666f0400707"]}]}}}},"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"pull":{"$ref":"#/components/schemas/Pull"}}}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":{"error":"VALIDATION_ERROR"}}},"schema":{"type":"object","properties":{"error":{"type":"string","enum":["NOT_FOUND","VALIDATION_ERROR"]}}}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}}},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["SUBSCRIPTION_INACTIVE"]}}},"examples":{"Example Response":{"value":{"error":"SUBSCRIPTION_INACTIVE"}}}}}}},"deprecated":false,"tags":["Pulls API"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"withPropertyData","description":"'true' to fetch property data if it does not already exist"}]},"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"teamId","in":"path","required":true,"description":"ID of Team that requested Pull belongs to"},{"schema":{"type":"string","format":"uuid"},"name":"pullId","in":"path","required":true,"description":"ID of Pull to return"}],"patch":{"summary":"PATCH /pulls/:pullId","operationId":"patch-pull-by-id","responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}},"examples":{"Example Response":{"value":{"success":true}}}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["INCORRECT_API_KEY_TYPE","INVALID_INPUT"]}},"required":["error"]}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}},"required":["error"]}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["SUBSCRIPTION_INACTIVE"]}},"required":["error"]}}}},"404":{"description":"404 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["NOT_FOUND"]}},"required":["error"]}}}}},"description":"Used to edit a pull","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"is_archived":{"type":"boolean","description":"Whether the pull is archived"}}}}}},"tags":["Pulls API"]}},"/teams/{teamId}/pulls":{"get":{"summary":"GET /pulls","description":"Used to get a list of pulls","operationId":"get-pulls","responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":{"total_pulls":2,"pulls":[{"pull_id":"59ced597-b48f-49e3-9756-799e4c6f79a0","status":"SUCCESS","first_name":"Clark","middle_name":"Joseph","last_name":"Kent","email":null,"account_email":"clark.kent@theplanet.com","phone":"8885550000","mobile_phone":"8885550000","home_phone":"","work_phone":"8885555555","work_phone_extension":"","insurance_provider_name":"statefarm","team_id":"394661bc-6361-46f0-8b11-4106d6146cb4","widget_id":"d2bb6d56-15ff-4760-a27c-362f9bce645a","meta_data":{},"is_archived":false,"created_at":"2023-01-12T20:59:42.811Z","public_alias":"demo","deleted_at":null,"public_url":"https://app.usecanopy.com/c/demo","no_policies":false,"no_drivers":false,"no_documents":false,"no_claims":false,"no_loss_events":false,"skipped_product_types":null,"type":"PULLING_DATA","policies":[{"policy_id":"a5c3eac9-537c-4146-8de9-99fb55455126","name":"HOME HO132483","description":"Effective 12/13/2022 - 12/13/2023","carrier_policy_number":"HO132483","policy_type":"HOMEOWNERS","effective_date":"2022-12-13T06:00:00.000Z","expiry_date":"2023-12-13T06:00:00.000Z","renewal_date":null,"canceled_date":null,"total_premium_cents":175349,"carrier_name":"statefarm","status":"ACTIVE","limited_access":false,"form_of_business":null,"deductible_cents":null,"paid_in_full":true,"is_monoline":false,"dwellings":[{"dwelling_id":"dddac0de-99c0-461f-a729-2d4362d343f4","mortgagee_name":"Metropolis Bank","mortgage_loan_number":"123456789","replacement_cost_cents":50000000,"cash_value_cents":50000000,"property_data_fetched":true,"loss_settlement_type":"REPLACEMENT_COST","extended_replacement_cost_percent":50,"address":{"address_id":"b321cd10-16f0-4738-bc5d-eb3a49e39722","full_address":"344 Clinton Street, Apartment 3D, Brooklyn, NY, 11231","country":null,"address_nature":"PHYSICAL","number":"344","street":"Clinton","type":"St","city":"Brooklyn","state":"NY","sec_unit_type":"Apartment","sec_unit_num":"3D","zip":"11231"},"coverages":[{"dwelling_coverage_id":"7985df7e-6811-43fd-b8d3-71d98a9c9766","name":"DWELLING","friendly_name":"Dwelling Liability","premium_cents":140675,"per_person_limit_cents":null,"per_incident_limit_cents":28838000,"deductible_cents":null,"is_declined":false},{"dwelling_coverage_id":"d548b535-fe40-47da-92cd-ab3d970e241b","name":"OTHER_STRUCTURES","friendly_name":"Other Structures Liability","premium_cents":4896,"per_person_limit_cents":null,"per_incident_limit_cents":2883800,"per_incident_limit_percent":10,"deductible_cents":null,"is_declined":false},{"dwelling_coverage_id":"0b4994c4-5671-483e-bb26-2196a05bbaed","name":"PERSONAL_PROPERTY","friendly_name":"Personal Property Liability","premium_cents":23062,"per_person_limit_cents":null,"per_incident_limit_cents":14419000,"per_incident_limit_percent":50,"deductible_cents":null,"is_declined":false},{"dwelling_coverage_id":"4c0d5002-ad58-4cc2-ac01-8c0314b909d2","name":"LOSS_OF_USE","friendly_name":"Loss of Use","premium_cents":2437,"per_person_limit_cents":null,"per_incident_limit_cents":5767600,"per_incident_limit_percent":20,"deductible_cents":null,"is_declined":false},{"dwelling_coverage_id":"5528e164-b896-4e4b-9721-5769f3afc221","name":"PERSONAL_LIABILITY","friendly_name":"Personal Liability","premium_cents":2969,"per_person_limit_cents":null,"per_incident_limit_cents":10000000,"deductible_cents":null,"is_declined":false},{"dwelling_coverage_id":"7724d31b-1323-4058-9333-e28c8716a643","name":"MEDICAL_PAYMENTS","friendly_name":"Medical Payments","premium_cents":1310,"per_incident_limit_cents":null,"per_person_limit_cents":100000,"deductible_cents":null,"is_declined":false},{"dwelling_coverage_id":"e3fd64bf-ea70-4f2d-a43f-c428114e75c1","name":"ALL_OTHER_PERILS","friendly_name":"All Other Perils","premium_cents":null,"per_person_limit_cents":null,"per_incident_limit_cents":null,"deductible_cents":288380,"deductible_percent":1,"is_declined":false},{"dwelling_coverage_id":"c2ac825a-6ada-486f-b531-a4d8596c844d","name":"WINDSTORM_OR_HAIL","friendly_name":"Windstorm or Hail","premium_cents":null,"per_person_limit_cents":null,"per_incident_limit_cents":null,"deductible_cents":576760,"deductible_percent":2,"is_declined":false}],"mortgagee_address":{"address_id":"6ce95d67-5b4f-4351-9fdc-9c76e64d425e","full_address":"620 Atlantic Avenue, Brooklyn, NY, 11217","country":null,"address_nature":"MORTGAGEE","number":"620","street":"Atlantic","type":"Ave","city":"Brooklyn","state":"NY","zip":"11217"},"property_data":{"property_data_id":"0a8e5811-6610-4525-aa53-cba4f41a4cc3","dwelling_id":"dddac0de-99c0-461f-a729-2d4362d343f4","apn":"02192-04-018-000","class":"SINGLE_FAMILY_RESIDENCE_TOWNHOUSE","sub_type":"RESIDENTIAL","year_built":1950,"construction_type":"BRICK","wall_type":"BRICK","foundation_type":"CONCRETE","frame_type":"WOOD","roof_cover":"SHINGLE","roof_shape":"PYRAMID","cooling_type":"CENTRAL","heating_type":"CENTRAL","heating_fuel":"GAS","energy_type":"GOOD","sewer_type":"MUNICIPAL","building_shape":"L_SHAPED","construction_quality":"EXCELLENT","has_fireplace":true,"num_fireplaces":1,"fireplace_type":"YES","has_pool":false,"pool_type":"NO_POOL","square_ft":934,"num_beds":2,"num_baths_full":2,"num_baths_partial":1,"num_stories":2,"num_units":1,"garage_type":"ATTACHED_1_CAR","garage_square_ft":240,"num_parking_spaces":1,"assessed_improvement_value_cents":1423000,"assessed_land_value_cents":2291000,"assessed_total_value_cents":3714000,"market_improvement_value_cents":19900000,"market_land_value_cents":32040000,"market_total_value_cents":51940000,"owner1_first_name":"Clark Joseph","owner1_last_name":"Kent","owner2_first_name":"Lois","owner2_last_name":"Lane","owner3_first_name":null,"owner3_last_name":null,"owner4_first_name":null,"owner4_last_name":null,"first_mortgage_amount_cents":null,"first_mortgage_lender":null,"second_mortgage_amount_cents":null,"second_mortgage_lender":null,"purchase_date":"2016-06-29","purchase_price_cents":500000,"last_update_date":"2022-04-14"}}],"vehicles":[],"commercial_named_insureds":[],"named_insureds":[{"named_insured_id":"6100a170-aa1d-4ec4-b33c-b7436bb0c761","first_name":"Clark","middle_name":"Joseph","last_name":"Kent","full_name":"Clark Joseph Kent","is_primary_named_insured":true}]},{"policy_id":"b3e00891-29d4-4ac6-a906-9b6a162f6a09","name":"AUTO AU192837","description":"Effective 12/13/2022 - 06/13/2023","carrier_policy_number":"AU192837","policy_type":"AUTO","effective_date":"2022-12-13T06:00:00.000Z","expiry_date":"2023-06-13T05:00:00.000Z","renewal_date":null,"canceled_date":null,"total_premium_cents":50781,"carrier_name":"statefarm","status":"ACTIVE","limited_access":false,"form_of_business":null,"deductible_cents":null,"paid_in_full":false,"is_monoline":false,"dwellings":[],"vehicles":[{"vehicle_id":"e94fd52e-e22c-4536-8fcf-1f436b880dc0","year":2018,"make":"CHEVROLET","model":"Camaro","series":"ZL1","series2":null,"type":"PASSENGER CAR","annual_mileage":null,"vin":"1G1FK1R62J0158884","uses":null,"purchase_date":null,"ownership_type":null,"features":null,"lien_holder":"Metropolis Bank","is_removed":false,"garaging_address":{"address_id":"b321cd10-16f0-4738-bc5d-eb3a49e39722","full_address":"344 Clinton Street, Apartment 3D, Brooklyn, NY, 11231","country":null,"address_nature":"PHYSICAL","number":"344","street":"Clinton","type":"St","city":"Brooklyn","state":"NY","sec_unit_type":"Apartment","sec_unit_num":"3D","zip":"11231"},"lien_holder_address":{"address_id":"4772146c-f12e-4173-9624-5ab4920b7d8c","full_address":"620 Atlantic Avenue, Brooklyn, NY, 11217","country":null,"address_nature":"LIENHOLDER","number":"620","street":"Atlantic","type":"Ave","city":"Brooklyn","state":"NY","zip":"11217"},"coverages":[{"vehicle_coverage_id":"c56b9feb-aef6-4e15-9307-ed52667416a8","name":"COLLISION","friendly_name":"Collision","premium_cents":16439,"per_person_limit_cents":null,"per_incident_limit_cents":null,"per_day_limit_cents":null,"deductible_cents":50000,"is_declined":false,"per_mile_premium_tenth_of_cents":null},{"vehicle_coverage_id":"46d22c39-c280-4508-94cc-6ae28483463e","name":"COMPREHENSIVE","friendly_name":"Comprehensive","premium_cents":9731,"per_person_limit_cents":null,"per_incident_limit_cents":null,"per_day_limit_cents":null,"deductible_cents":50000,"is_declined":false,"per_mile_premium_tenth_of_cents":null},{"vehicle_coverage_id":"72cfca2d-7195-4f47-8794-be1c94565d89","name":"BODILY_INJURY_LIABILITY","friendly_name":"Bodily Injury Liability","premium_cents":11430,"per_person_limit_cents":10000000,"per_incident_limit_cents":30000000,"per_day_limit_cents":null,"deductible_cents":null,"is_declined":false,"per_mile_premium_tenth_of_cents":null},{"vehicle_coverage_id":"15f98e11-5345-4494-96c4-0dc3152194fa","name":"PROPERTY_DAMAGE_LIABILITY","friendly_name":"Property Damage Liability","premium_cents":10406,"per_person_limit_cents":null,"per_incident_limit_cents":5000000,"per_day_limit_cents":null,"deductible_cents":null,"is_declined":false,"per_mile_premium_tenth_of_cents":null},{"vehicle_coverage_id":"6bc73ca3-977e-424b-843b-3c1ba68ed249","name":"UNINSURED_MOTORISTS","friendly_name":"Uninsured Motorists","premium_cents":2775,"per_person_limit_cents":1500000,"per_incident_limit_cents":3000000,"per_day_limit_cents":null,"deductible_cents":null,"is_declined":false,"per_mile_premium_tenth_of_cents":null}],"drivers":[{"first_name":"Clark","middle_name":"Joseph","last_name":"Kent","drivers_license":"SUP1234017","drivers_license_state":"DC","date_of_birth_str":"05/03/1987","gender":"MALE","marital_status":"SINGLE","relationship_to_insured":"INSURED","age":null,"age_on_date":null,"education":null,"occupation":"Superhero","age_licensed":null,"driver_id":"1394c681-ebfe-475d-b390-d7157e33a895","is_excluded":false}],"GaragingAddress":{"address_id":"b321cd10-16f0-4738-bc5d-eb3a49e39722","full_address":"344 Clinton Street, Apartment 3D, Brooklyn, NY, 11231","country":null,"address_nature":"PHYSICAL","number":"344","street":"Clinton","type":"St","city":"Brooklyn","state":"NY","sec_unit_type":"Apartment","sec_unit_num":"3D","zip":"11231"},"LienHolderAddress":{"address_id":"4772146c-f12e-4173-9624-5ab4920b7d8c","full_address":"620 Atlantic Avenue, Brooklyn, NY, 11217","country":null,"address_nature":"LIENHOLDER","number":"620","street":"Atlantic","type":"Ave","city":"Brooklyn","state":"NY","zip":"11217"}}],"commercial_named_insureds":[],"named_insureds":[{"named_insured_id":"c0f07575-e9af-4144-9635-2c97ac729c95","first_name":"Clark","middle_name":"Joseph","last_name":"Kent","full_name":"Clark Joseph Kent","is_primary_named_insured":true}]}],"drivers":[{"first_name":"Clark","middle_name":"Joseph","last_name":"Kent","drivers_license":"SUP1234017","drivers_license_state":"DC","date_of_birth_str":"05/03/1987","gender":"MALE","marital_status":"SINGLE","relationship_to_insured":"INSURED","age":null,"age_on_date":null,"education":null,"occupation":"Superhero","age_licensed":null,"driver_id":"1394c681-ebfe-475d-b390-d7157e33a895"}],"documents":[{"document_id":"4f9e5a60-8799-4e07-88e5-572fa6742a08","title":"12-13-2022 - AUTO AU192837 - Declarations","date_added":"2022-12-13T06:00:00.000Z","document_type":"DECLARATIONS","policy_id":"b3e00891-29d4-4ac6-a906-9b6a162f6a09"},{"document_id":"addf2ad6-8dc3-4bee-a980-a94933c8548a","title":"06-13-2022 - AUTO AU192837 - Declarations","date_added":"2022-06-13T05:00:00.000Z","document_type":"DECLARATIONS","policy_id":"b3e00891-29d4-4ac6-a906-9b6a162f6a09"},{"document_id":"227811c1-73a0-49b0-bc68-e81b835aa86c","title":"12-13-2022 - AUTO AU192837 - Insurance ID Card","date_added":"2022-12-13T06:00:00.000Z","document_type":"INSURANCE_ID_CARD","policy_id":"b3e00891-29d4-4ac6-a906-9b6a162f6a09"},{"document_id":"729d5c88-2d5c-4e3d-94a4-1037b297fb35","title":"06-13-2022 - AUTO AU192837 - Insurance ID Card","date_added":"2022-06-13T05:00:00.000Z","document_type":"INSURANCE_ID_CARD","policy_id":"b3e00891-29d4-4ac6-a906-9b6a162f6a09"},{"document_id":"d67929e8-b0b5-4030-a4fe-1ddaa1326d5f","title":"12-13-2022 - HOME HO132483 - Declarations","date_added":"2022-12-13T06:00:00.000Z","document_type":"DECLARATIONS","policy_id":"a5c3eac9-537c-4146-8de9-99fb55455126"},{"document_id":"ce00477d-5f58-46ae-96a0-0f3e624a9fee","title":"12-13-2021 - HOME HO132483 - Declarations","date_added":"2021-12-13T06:00:00.000Z","document_type":"DECLARATIONS","policy_id":"a5c3eac9-537c-4146-8de9-99fb55455126"}],"addresses":[{"address_id":"c64fd268-472a-4793-a5b5-c9ccaef8f89a","full_address":"344 Clinton Street, Apartment 3D, Brooklyn, NY, 11231","country":null,"address_nature":"MAILING","number":"344","street":"Clinton","type":"St","city":"Brooklyn","state":"NY","sec_unit_type":"Apartment","sec_unit_num":"3D","zip":"11231"},{"address_id":"b321cd10-16f0-4738-bc5d-eb3a49e39722","full_address":"344 Clinton Street, Apartment 3D, Brooklyn, NY, 11231","country":null,"address_nature":"PHYSICAL","number":"344","street":"Clinton","type":"St","city":"Brooklyn","state":"NY","sec_unit_type":"Apartment","sec_unit_num":"3D","zip":"11231"},{"address_id":"ef1faf3d-b09f-4edb-8784-6a1f91e02a68","full_address":"344 Clinton Street, Apartment 3D, Brooklyn, NY, 11231","country":null,"address_nature":"INCIDENT_LOCATION","number":"344","street":"Clinton","type":"St","city":"Brooklyn","state":"NY","sec_unit_type":"Apartment","sec_unit_num":"3D","zip":"11231"},{"address_id":"4772146c-f12e-4173-9624-5ab4920b7d8c","full_address":"620 Atlantic Avenue, Brooklyn, NY, 11217","country":null,"address_nature":"LIENHOLDER","number":"620","street":"Atlantic","type":"Ave","city":"Brooklyn","state":"NY","zip":"11217"},{"address_id":"4089002f-a2fb-4349-aad1-90710ad6a7a6","full_address":"1 Times Sq, New York, NY 10036","country":null,"address_nature":"AGENCY_LOCATION","number":"1","street":"Times","type":"Sq","city":"New York","state":"NY","zip":"10036"},{"address_id":"6ce95d67-5b4f-4351-9fdc-9c76e64d425e","full_address":"620 Atlantic Avenue, Brooklyn, NY, 11217","country":null,"address_nature":"MORTGAGEE","number":"620","street":"Atlantic","type":"Ave","city":"Brooklyn","state":"NY","zip":"11217"}],"claims":[{"claim_id":"0f86ca7f-89b4-40bf-9514-2aa6f685cf38","policy_id":"a5c3eac9-537c-4146-8de9-99fb55455126","dwelling_id":"dddac0de-99c0-461f-a729-2d4362d343f4","vehicle_id":null,"address_id":"ef1faf3d-b09f-4edb-8784-6a1f91e02a68","carrier_claim_identifier":"HO-12345","date_occurred":"2022-11-13T06:00:00.000Z","type":"WIND_AND_HAIL_DAMAGE","status":"OPEN","date_closed":null,"payout_cents":null,"representative_name":"Lois Lane","representative_phone":"8885553333","representative_email":"lois.lane@theplanet.com","driver_id":null},{"claim_id":"c260066b-b6ba-47bc-9fca-e70fec507b70","policy_id":"b3e00891-29d4-4ac6-a906-9b6a162f6a09","dwelling_id":null,"vehicle_id":"e94fd52e-e22c-4536-8fcf-1f436b880dc0","address_id":"ef1faf3d-b09f-4edb-8784-6a1f91e02a68","carrier_claim_identifier":"AU-54321","date_occurred":"2021-12-13T06:00:00.000Z","type":"THEFT","status":"CLOSED","date_closed":"2022-04-13T05:00:00.000Z","payout_cents":2750000,"representative_name":"Jimmy Olsen","representative_phone":"8885554444","representative_email":"jimmy.olsen@theplanet.com","driver_id":"1394c681-ebfe-475d-b390-d7157e33a895"}],"driving_records":[{"driving_record_id":"1019dcff-ee37-4103-8b28-3f2d168835c1","incident_date":"2021-06-13T05:00:00.000Z","incident_type":"ACCIDENT","violation_type":null,"is_at_fault":false,"driver_id":"1394c681-ebfe-475d-b390-d7157e33a895"},{"driving_record_id":"fb1ae829-52c9-4754-a842-464d562e027e","incident_date":"2020-12-13T06:00:00.000Z","incident_type":"VIOLATION","violation_type":"SPEEDING","is_at_fault":null,"driver_id":"1394c681-ebfe-475d-b390-d7157e33a895"}],"loss_events":[],"agents":[{"agent_info_id":"a690aa3c-348d-4811-b0f4-83a576e4d6d6","address_id":"4089002f-a2fb-4349-aad1-90710ad6a7a6","agency_name":"Metropolis Insurance Agency","agent_full_name":"Sam Lane","phone_number":"8885552222","email":"sam.lane@theplanet.com","policy_ids":["b3e00891-29d4-4ac6-a906-9b6a162f6a09","a5c3eac9-537c-4146-8de9-99fb55455126"]}]},{"pull_id":"7f292c71-5942-4abb-a58a-d39b4f29f669","status":"SUCCESS","first_name":"Clark","middle_name":"Joseph","last_name":"Kent","email":null,"account_email":"clark.kent@theplanet.com","phone":null,"mobile_phone":"8885550000","home_phone":"","work_phone":"8885555555","work_phone_extension":null,"insurance_provider_name":"statefarm","team_id":"394661bc-6361-46f0-8b11-4106d6146cb4","widget_id":"d2bb6d56-15ff-4760-a27c-362f9bce645a","meta_data":null,"created_at":"2022-10-13T19:10:00.438Z","public_alias":"demo","public_url":"https://app.usecanopy.com/c/demo","no_policies":false,"no_drivers":false,"no_documents":false,"no_claims":false,"no_loss_events":false,"type":"PULLING_DATA","skipped_product_types":["personal"],"policies":[{"policy_id":"9cf2ec82-2dd8-489b-9868-ef856136b146","name":"BUSINESS_OWNERS BO132483","description":"Effective 11/03/2021 - 11/03/2022","carrier_policy_number":"BO132483","policy_type":"BUSINESS_OWNERS","effective_date":"2021-11-03T05:00:00.000Z","expiry_date":"2022-11-03T05:00:00.000Z","renewal_date":null,"canceled_date":null,"total_premium_cents":525345,"carrier_name":"statefarm","status":"ACTIVE","limited_access":false,"form_of_business":"CORPORATION","deductible_cents":50000,"paid_in_full":false,"is_monoline":false,"dwellings":[],"vehicles":[],"commercial_named_insureds":[{"commercial_named_insured_id":"0b3eba9a-65fe-4092-b538-37f821188f7d","address_id":"8cd5da8f-0d20-4902-8f30-76419eba44e6","name":"Metropolis Bank","form_of_business":"CORPORATION","gl_code":"1110","sic_code":"602","naics_code":"522110","fein":"01-2345678","business_phone":"8885550000","business_email":"hello@metropolis.com","website_url":"https://www.metropolis.com","is_primary_named_insured":true}],"named_insureds":[]},{"policy_id":"edf6b64a-a54d-4426-9cfb-39f45664ff9b","name":"COMMERCIAL_AUTO AU192837","description":"Effective 11/03/2021 - 05/03/2022","carrier_policy_number":"AU192837","policy_type":"COMMERCIAL_AUTO","effective_date":"2022-05-03T05:00:00.000Z","expiry_date":"2022-11-03T05:00:00.000Z","renewal_date":null,"canceled_date":null,"total_premium_cents":540906,"carrier_name":"statefarm","status":"ACTIVE","limited_access":false,"form_of_business":"CORPORATION","deductible_cents":null,"paid_in_full":false,"is_monoline":false,"dwellings":[],"vehicles":[{"vehicle_id":"0e9ace8d-7d20-4e59-885d-b9b21654e723","year":2005,"make":"CHEVROLET","model":"Express","series":"3500","series2":null,"type":"CARGO VAN","annual_mileage":null,"vin":"1GAHG39U651194937","uses":null,"purchase_date":null,"ownership_type":null,"features":null,"lien_holder":"Metropolis Bank","is_removed":false,"garaging_address":{"address_id":"5cf7e857-57b7-442b-a581-0f0c99017efc","full_address":"344 Clinton Street, Apartment 3D, Brooklyn, NY, 11231","country":null,"address_nature":"PHYSICAL","number":"344","street":"Clinton","type":"St","city":"Brooklyn","state":"NY","sec_unit_type":"Apartment","sec_unit_num":"3D","zip":"11231"},"lien_holder_address":{"address_id":"9d3f8c08-2921-424a-ac2f-6192b7854f88","full_address":"620 Atlantic Avenue, Brooklyn, NY, 11217","country":null,"address_nature":"LIENHOLDER","number":"620","street":"Atlantic","type":"Ave","city":"Brooklyn","state":"NY","zip":"11217"},"coverages":[{"vehicle_coverage_id":"4656a66a-08b5-4fa3-bee1-7bffa94c0910","name":"UNINSURED_MOTORISTS","friendly_name":"Uninsured Motorists","premium_cents":26928,"per_person_limit_cents":1500000,"per_incident_limit_cents":3000000,"per_day_limit_cents":null,"deductible_cents":null,"is_declined":false,"per_mile_premium_tenth_of_cents":null},{"vehicle_coverage_id":"92bbbe21-f301-4a90-8a9d-db6e47c3fbbb","name":"PROPERTY_DAMAGE_LIABILITY","friendly_name":"Property Damage Liability","premium_cents":119438,"per_person_limit_cents":null,"per_incident_limit_cents":5000000,"per_day_limit_cents":null,"deductible_cents":null,"is_declined":false,"per_mile_premium_tenth_of_cents":null},{"vehicle_coverage_id":"c34eafe4-6f8b-4a85-ab5c-8d9908ced8cb","name":"BODILY_INJURY_LIABILITY","friendly_name":"Bodily Injury Liability","premium_cents":129964,"per_person_limit_cents":10000000,"per_incident_limit_cents":30000000,"per_day_limit_cents":null,"deductible_cents":null,"is_declined":false,"per_mile_premium_tenth_of_cents":null},{"vehicle_coverage_id":"1a87350e-aa48-4133-b787-058676c5c6e9","name":"COMPREHENSIVE","friendly_name":"Comprehensive","premium_cents":88985,"per_person_limit_cents":null,"per_incident_limit_cents":null,"per_day_limit_cents":null,"deductible_cents":50000,"is_declined":false,"per_mile_premium_tenth_of_cents":null},{"vehicle_coverage_id":"83443eb0-4ead-47ad-9986-299ece16b78a","name":"COLLISION","friendly_name":"Collision","premium_cents":175591,"per_person_limit_cents":null,"per_incident_limit_cents":null,"per_day_limit_cents":null,"deductible_cents":50000,"is_declined":false,"per_mile_premium_tenth_of_cents":null}],"drivers":[{"first_name":"Clark","middle_name":"Joseph","last_name":"Kent","drivers_license":"SUP1234017","drivers_license_state":"DC","date_of_birth_str":"05/03/1987","gender":"MALE","marital_status":"SINGLE","relationship_to_insured":"INSURED","age":null,"age_on_date":null,"education":null,"occupation":"Superhero","age_licensed":null,"driver_id":"8c93a05c-5675-49c3-abce-d21a37581b0a","is_excluded":false}],"GaragingAddress":{"address_id":"5cf7e857-57b7-442b-a581-0f0c99017efc","full_address":"344 Clinton Street, Apartment 3D, Brooklyn, NY, 11231","country":null,"address_nature":"PHYSICAL","number":"344","street":"Clinton","type":"St","city":"Brooklyn","state":"NY","sec_unit_type":"Apartment","sec_unit_num":"3D","zip":"11231"},"LienHolderAddress":{"address_id":"9d3f8c08-2921-424a-ac2f-6192b7854f88","full_address":"620 Atlantic Avenue, Brooklyn, NY, 11217","country":null,"address_nature":"LIENHOLDER","number":"620","street":"Atlantic","type":"Ave","city":"Brooklyn","state":"NY","zip":"11217"}}],"commercial_named_insureds":[],"named_insureds":[]}],"drivers":[{"first_name":"Clark","middle_name":"Joseph","last_name":"Kent","drivers_license":"SUP1234017","drivers_license_state":"DC","date_of_birth_str":"05/03/1987","gender":"MALE","marital_status":"SINGLE","relationship_to_insured":"INSURED","age":null,"age_on_date":null,"education":null,"occupation":"Superhero","age_licensed":null,"driver_id":"8c93a05c-5675-49c3-abce-d21a37581b0a"}],"documents":[{"document_id":"97a23631-65c7-4cde-a641-a365f06851f0","title":"11-03-2020 - BUSINESS_OWNERS - Business Owners Renewal Declarations","date_added":"2020-11-03T06:00:00.000Z","document_type":"DECLARATIONS","policy_id":"9cf2ec82-2dd8-489b-9868-ef856136b146"},{"document_id":"39eb8809-70c9-4d7b-b416-a9595f0822d3","title":"11-03-2021 - BUSINESS_OWNERS - Business Owners Renewal Declarations","date_added":"2021-11-03T05:00:00.000Z","document_type":"DECLARATIONS","policy_id":"9cf2ec82-2dd8-489b-9868-ef856136b146"},{"document_id":"6a897bf1-3afa-4300-9f96-38df18a45d1f","title":"11-03-2020 - COMMERCIAL_AUTO - Auto ID Cards","date_added":"2020-11-03T06:00:00.000Z","document_type":"INSURANCE_ID_CARD","policy_id":"edf6b64a-a54d-4426-9cfb-39f45664ff9b"},{"document_id":"fc557f4b-20a8-4a47-85e2-77ed96b6e71c","title":"05-03-2021 - COMMERCIAL_AUTO - Automobile Policy Renewal Declarations","date_added":"2021-05-03T05:00:00.000Z","document_type":"DECLARATIONS","policy_id":"edf6b64a-a54d-4426-9cfb-39f45664ff9b"},{"document_id":"cbcc69d5-0900-4303-a8d1-3587c21e9a39","title":"05-03-2022 - COMMERCIAL_AUTO - Auto ID Cards","date_added":"2022-05-03T05:00:00.000Z","document_type":"INSURANCE_ID_CARD","policy_id":"edf6b64a-a54d-4426-9cfb-39f45664ff9b"},{"document_id":"2b85494b-9f7f-43e6-b3ec-71e0df7bab5a","title":"11-03-2021 - COMMERCIAL_AUTO - Automobile Policy Renewal Declarations","date_added":"2021-11-03T05:00:00.000Z","document_type":"DECLARATIONS","policy_id":"edf6b64a-a54d-4426-9cfb-39f45664ff9b"},{"document_id":"f0916b80-a198-4555-9df4-bfad514b172d","title":"05-03-2022 - COMMERCIAL_AUTO - Automobile Policy Renewal Declarations","date_added":"2022-05-03T05:00:00.000Z","document_type":"DECLARATIONS","policy_id":"edf6b64a-a54d-4426-9cfb-39f45664ff9b"}],"addresses":[{"address_id":"2d006c32-bdc7-43d4-a2fa-f802cbcd0220","full_address":"1 Times Sq, New York, NY 10036","country":null,"address_nature":"AGENCY_LOCATION","number":"1","street":"Times","type":"Sq","city":"New York","state":"NY","zip":"10036"},{"address_id":"9d3f8c08-2921-424a-ac2f-6192b7854f88","full_address":"620 Atlantic Avenue, Brooklyn, NY, 11217","country":null,"address_nature":"LIENHOLDER","number":"620","street":"Atlantic","type":"Ave","city":"Brooklyn","state":"NY","zip":"11217"},{"address_id":"ac5f0142-cf0f-48c6-b7d6-9fc06bee124e","full_address":"344 Clinton Street, Apartment 3D, Brooklyn, NY, 11231","country":null,"address_nature":"INCIDENT_LOCATION","number":"344","street":"Clinton","type":"St","city":"Brooklyn","state":"NY","sec_unit_type":"Apartment","sec_unit_num":"3D","zip":"11231"},{"address_id":"5cf7e857-57b7-442b-a581-0f0c99017efc","full_address":"344 Clinton Street, Apartment 3D, Brooklyn, NY, 11231","country":null,"address_nature":"PHYSICAL","number":"344","street":"Clinton","type":"St","city":"Brooklyn","state":"NY","sec_unit_type":"Apartment","sec_unit_num":"3D","zip":"11231"},{"address_id":"8cd5da8f-0d20-4902-8f30-76419eba44e6","full_address":"344 Clinton Street, Apartment 3D, Brooklyn, NY, 11231","country":null,"address_nature":"MAILING","number":"344","street":"Clinton","type":"St","city":"Brooklyn","state":"NY","sec_unit_type":"Apartment","sec_unit_num":"3D","zip":"11231"}],"claims":[],"driving_records":[],"loss_events":[{"loss_event_id":"fba39e9b-edf0-4083-935c-d6e532b4798c","policy_id":"edf6b64a-a54d-4426-9cfb-39f45664ff9b","date_of_occurrence":"2019-08-23T05:00:00.000Z","type":"BURGLARY_AND_THEFT","date_of_claim":"2019-08-25T05:00:00.000Z","amount_paid_cents":2750000,"amount_reserved_cents":500000,"is_subrogation":false,"is_claim_open":false}],"agents":[{"agent_info_id":"f8a13fb6-f3b8-4d55-a99a-3c98d390fef3","address_id":"2d006c32-bdc7-43d4-a2fa-f802cbcd0220","agency_name":"Metropolis Insurance Agency","agent_full_name":"Sam Lane","phone_number":"8885552222","email":"sam.lane@theplanet.com","policy_ids":["edf6b64a-a54d-4426-9cfb-39f45664ff9b","9cf2ec82-2dd8-489b-9868-ef856136b146"]}]}]}}},"schema":{"type":"object","properties":{"total_pulls":{"type":"integer","example":1,"default":0,"description":"Total number of pulls available. Can be used in combination with limit to determine number of \"pages\"."},"pulls":{"type":"array","items":{"$ref":"#/components/schemas/Pull"}}}}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":{"error":"VALIDATION_ERROR"}}},"schema":{"type":"object","properties":{"error":{"type":"string","enum":["VALIDATION_ERROR"]}}}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}}},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["SUBSCRIPTION_INACTIVE"]}}},"examples":{"Example Response":{"value":{"error":"SUBSCRIPTION_INACTIVE"}}}}}}},"deprecated":false,"parameters":[{"schema":{"type":"string","format":"date-time"},"in":"query","name":"since","description":"Filter by Pulls that occurred since the supplied date (inclusive)"},{"schema":{"type":"string","format":"date-time"},"in":"query","name":"before","description":"Filter by Pulls that occurred before the supplied date (inclusive)"},{"schema":{"type":"integer","maximum":100,"default":10,"minimum":1},"in":"query","name":"limit","description":"Optionally limit the number of Pulls that are returned in the response to a maximum of limit. Use along with offset"},{"schema":{"type":"integer"},"in":"query","name":"offset","description":"Optionally return Pulls starting from the supplied offset within the total list of Pulls matching the query. Use along with limit"}],"tags":["Pulls API"]},"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"teamId","in":"path","required":true,"description":"ID of Team"}]},"/teams/{teamId}/pulls/{pullId}/documents/{documentId}/pdf":{"get":{"summary":"GET /:documentId/pdf","description":"Download a pdf document from a pull","operationId":"get-document-by-id","responses":{"200":{"description":"200 Response Schema","content":{"application/pdf":{"examples":{"Example Response":{"value":"...document...data...buffer..."}},"schema":{"type":"string","format":"byte"}}},"headers":{"Content-Disposition":{"schema":{"type":"string"},"description":"attachment; filename=\"<FIRST\\_NAME>\\_<LAST\\_NAME>\\_<DOC\\_TITLE>.pdf\""},"Content-Type":{"schema":{"type":"string"},"description":"application/pdf"}}},"400":{"description":"400 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":{"error":"VALIDATION_ERROR"}}},"schema":{"type":"object","properties":{"error":{"type":"string","enum":["VALIDATION_ERROR"]}}}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}}},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"404":{"description":"404 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["NOT_FOUND"]}}},"examples":{"Example Response":{"value":{"error":"NOT_FOUND"}}}}}}},"deprecated":false,"tags":["Pulls API"]},"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"teamId","in":"path","required":true,"description":"ID of Team"},{"schema":{"type":"string","format":"uuid"},"name":"pullId","in":"path","required":true,"description":"ID of Pull that Document belongs to"},{"schema":{"type":"string","format":"uuid"},"name":"documentId","in":"path","required":true,"description":"ID of Document to return"}]},"/teams/{teamId}/pulls/{pullId}/policyCheck":{"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"teamId","in":"path","required":true,"description":"ID of Team"},{"schema":{"type":"string","format":"uuid"},"name":"pullId","in":"path","required":true,"description":"ID of Pull that Document belongs to"}],"post":{"summary":"POST /policyCheck","description":"Evaluate Policy Check on pull","operationId":"post-pull-policy-check","responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"default":true},"pull":{"$ref":"#/components/schemas/Pull"}}}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":{"error":"INVALID_INPUT"}}},"schema":{"type":"object","properties":{"error":{"type":"string","enum":["INVALID_INPUT"]}}}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}}},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["FORBIDDEN"]}}},"examples":{"Example Response":{"value":{"error":"FORBIDDEN"}}}}}},"404":{"description":"404 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["NOT_FOUND"]}}},"examples":{"Example Response":{"value":{"error":"NOT_FOUND"}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"policy_check_settings":{"type":"object","properties":{"vehicle":{"allOf":[{"$ref":"#/components/schemas/PolicyCheckVehicleSetting"},{"$ref":"#/components/schemas/PolicyCheckPullVehicleSetting"}]},"dwelling":{"$ref":"#/components/schemas/PolicyCheckDwellingSetting"}}},"filters":{"type":"object","description":"Optional filters to restrict which entities are evaluated by the Policy Check.","properties":{"vehicle":{"type":"object","description":"Filters applied to vehicles.","properties":{"vin":{"type":"object","description":"Filter vehicles by VIN.","properties":{"eq":{"type":"string","description":"VIN value to match against.","example":"1HGCM82633A004352"},"partial_match":{"type":"boolean","description":"When true, performs a fuzzy match that returns vehicles whose VIN closely resembles the provided value (ranked by similarity) instead of requiring an exact match.","default":false,"example":true}},"required":["eq"]}}}}}}}}}},"deprecated":false,"tags":["Pulls API"]}},"/teams/{teamId}/pulls/{pullId}/policyCheck/pdf":{"get":{"summary":"GET /policyCheck/pdf","description":"Download a Policy Check PDF from a pull","operationId":"get-pull-policy-check-pdf","responses":{"200":{"description":"200 Response Schema","content":{"application/pdf":{"examples":{"Example Response":{"value":"...document...data...buffer..."}},"schema":{"type":"string","format":"byte"}}},"headers":{"Content-Disposition":{"schema":{"type":"string"},"description":"attachment; filename=\"policy_check.pdf\""},"Content-Type":{"schema":{"type":"string"},"description":"application/pdf"}}},"400":{"description":"400 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":{"error":"INVALID_INPUT"}}},"schema":{"type":"object","properties":{"error":{"type":"string","enum":["INVALID_INPUT"]}}}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}}},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["FORBIDDEN"]}}},"examples":{"Example Response":{"value":{"error":"FORBIDDEN"}}}}}},"404":{"description":"404 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["NOT_FOUND"]}}},"examples":{"Example Response":{"value":{"error":"NOT_FOUND"}}}}}}},"deprecated":false,"tags":["Pulls API"]},"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"teamId","in":"path","required":true,"description":"ID of Team"},{"schema":{"type":"string","format":"uuid"},"name":"pullId","in":"path","required":true,"description":"ID of Pull"}]},"/consent":{"post":{"summary":"POST /consent","description":"This page will help you get started with Consent API.","operationId":"post-consent","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["device_identifier","terms_version","consent_language"],"properties":{"device_identifier":{"type":"string","description":"IP address or device identifier of the user who is agreeing to the Canopy Connect Privacy Policy and Terms of Service"},"terms_version":{"type":"integer","description":"Version of Canopy Connect’s Privacy Policy and Terms of Service","format":"int32"},"consent_language":{"type":"string","description":"Text that was displayed to the user when prompting for their consent","maxLength":1024,"example":"By clicking <name of button> you agree to the Canopy Connect End User Privacy Policy and Terms of Service"}}}}}},"responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":{"consent_token":"b07ef761-5631-44ee-a867-ff06c24eb5ef"}}},"schema":{"type":"object","properties":{"consent_token":{"type":"string","example":"b07ef761-5631-44ee-a867-ff06c24eb5ef","description":"Consent token that can be passed into the SDK to skip the consent page"}}}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":{"error":"MISSING_DEVICE_IDENTIFIER"}}},"schema":{"type":"object","properties":{"error":{"type":"string","enum":["MISSING_DEVICE_IDENTIFIER","INVALID_CONSENT_LANGUAGE","CONSENT_LANGUAGE_TOO_LONG"]}}}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}}},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"404":{"description":"404 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["INVALID_PRIVACY_POLICY_TERM_ID"]}}},"examples":{"Example Response":{"value":{"error":"INVALID_PRIVACY_POLICY_TERM_ID"}}}}}}},"deprecated":false,"tags":["Consent API"]}},"/teams/{teamId}/webhooks":{"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"teamId","in":"path","required":true,"description":"ID of Team"}],"get":{"summary":"GET /webhooks","responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"webhooks":{"type":"array","description":"Webhooks available for your API Key type (sandbox or production)","items":{"type":"object","properties":{"webhook_id":{"type":"string","description":"The ID of the Webhook","format":"uuid"},"signing_secret":{"type":"string","description":"The secret used to validate webhook requests (https://docs.usecanopy.com/reference/verifying-webhook-signatures)"},"url":{"type":"string","description":"The URL that the webhook requests go to","format":"uri"},"is_sandbox":{"type":"boolean","description":"Whether your API Key and Webhook are sandbox (not production)"},"is_active":{"type":"boolean","description":"Whether your webhook is active and will receive webhook requests"},"event_types":{"type":"array","description":"The event types that will trigger the webhook request","items":{"type":"string","enum":["COMPLETE","POLICIES_AVAILABLE","POLICY_AVAILABLE","AUTH_STATUS","VALIDATION_COMPLETE"]}}}}}}},"examples":{"Example Response":{"value":{"webhooks":[{"webhook_id":"4dadb30c-95cd-4b17-aa99-0245e4ff6064","signing_secret":"cBiN66y0wYlbnwJiBu4wRAWceeL8jMJyhH/PjRYzTylTM9IfkJwOZ/Yfwi4dpZM5","url":"https://www.example.com/canopyConnectWebhook","is_sandbox":true,"is_active":true,"event_types":["COMPLETE","POLICIES_AVAILABLE","AUTH_STATUS"]}]}}}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}}},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}}},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}}},"operationId":"get-webhooks","description":"Used to get all available webhooks","tags":["Webhooks API"]},"post":{"summary":"POST /webhooks","operationId":"post-webhooks","responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"webhook_id":{"type":"string","format":"uuid","description":"The ID of the Webhook"},"signing_secret":{"type":"string","description":"The secret used to validate webhook requests (https://docs.usecanopy.com/reference/verifying-webhook-signatures)"}}},"examples":{"Example Response":{"value":{"webhook_id":"4dadb30c-95cd-4b17-aa99-0245e4ff6064","signing_secret":"cBiN66y0wYlbnwJiBu4wRAWceeL8jMJyhH/PjRYzTylTM9IfkJwOZ/Yfwi4dpZM5"}}}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["INVALID_URL","INVALID_EVENT_TYPE"]}}}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}}},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}}},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}}},"description":"Used to create a webhook","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"hookUrl":{"type":"string","description":"The URL that the webhook requests will go to","format":"uri"},"eventTypes":{"type":"array","description":"The event types that will trigger the webhook request","items":{"type":"string","enum":["COMPLETE","POLICIES_AVAILABLE","POLICY_AVAILABLE","AUTH_STATUS","VALIDATION_COMPLETE"]}}}}}}},"tags":["Webhooks API"]}},"/teams/{teamId}/webhooks/{webhookId}":{"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"teamId","in":"path","required":true,"description":"ID of Team"},{"schema":{"type":"string","format":"uuid"},"name":"webhookId","in":"path","required":true,"description":"ID of Webhook"}],"patch":{"summary":"PATCH /webhooks/:webhookId","operationId":"patch-webhook","responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}},"examples":{"Example Response":{"value":{"success":true}}}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["NOT_FOUND","INVALID_IS_ACTIVE","INVALID_EVENT_TYPE","INVALID_WEBHOOK_ID"]}}},"examples":{"Example Response":{"value":{"error":"NOT_FOUND"}}}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}}},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}}},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}}},"description":"Used to update a webhook","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"isActive":{"type":"boolean","description":"Whether your webhook is active and will receive webhook requests"},"eventTypes":{"type":"array","description":"The event types that will trigger the webhook request","items":{"type":"string","enum":["COMPLETE","POLICIES_AVAILABLE","POLICY_AVAILABLE","AUTH_STATUS","VALIDATION_COMPLETE"]}}}}}},"description":""},"tags":["Webhooks API"]},"delete":{"summary":"DELETE /webhooks/:webhookId","operationId":"delete-webhook","responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}},"examples":{"Example Response":{"value":{"success":true}}}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["INVALID_WEBHOOK_ID"]}}},"examples":{"Example Response":{"value":{"error":"INVALID_WEBHOOK_ID"}}}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}}},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}}},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}}},"description":"Used to delete a webhook","tags":["Webhooks API"]}},"/teams/{teamId}/monitorings":{"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"teamId","in":"path","required":true,"description":"ID of Team"}],"get":{"summary":"GET /monitorings","tags":["Monitorings API"],"responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"monitorings_count":{"type":"integer"},"monitorings":{"type":"array","items":{"$ref":"#/components/schemas/Monitoring"}}},"required":["monitorings_count","monitorings"]}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}},"required":["error"]}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["SUBSCRIPTION_INACTIVE"]}},"required":["error"]}}}}},"operationId":"get-monitorings","description":"List all Monitorings, optionally filtered by Pull ID or status. A Monitoring represents an ongoing connection to an insurance account, used for refreshing information on a connected insurance account.","parameters":[{"schema":{"type":"integer","default":100},"in":"query","name":"limit","description":"Pagination limit"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"before","description":"Pagination before pointer of a monitoring_id"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"pull_id","description":"Filter used to list Monitorings related to a Pull (cannot be used with account_identifier)"},{"schema":{"type":"string"},"in":"query","name":"account_identifier","description":"Filter used to list Monitorings related to an Account Identifier (cannot be used with pull_id)"},{"schema":{"type":"string","enum":["ACTIVE","STOPPED"]},"in":"query","name":"status","description":"Filter used to list Monitorings of a certain status"}]},"post":{"summary":"POST /monitorings","operationId":"post-monitoring","responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether creating the monitoring was successful"},"monitoring":{"$ref":"#/components/schemas/Monitoring","description":"Newly created Monitoring"}},"required":["success"]}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["INVALID_INPUT","INCORRECT_API_KEY_TYPE","PULL_TOO_OLD","PULL_NOT_SUCCESS","PULL_NOT_SUPPORTED"]}},"required":["error"]}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}},"required":["error"]},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["SUBSCRIPTION_INACTIVE"]}},"required":["error"]},"examples":{"Example Response":{"value":{"error":"SUBSCRIPTION_INACTIVE"}}}}}},"404":{"description":"404 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["NOT_FOUND"]}},"required":["error"]}}}}},"description":"Refresh the data on an insurance account. Create a Monitoring to refresh insurance account data on a fixed interval, or refresh on-demand.","tags":["Monitorings API"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"interval":{"type":"string","format":"ISO-8601-duration","example":"P1M","pattern":"^(-?)P(?=\\d|T\\d)(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)([DW]))?(?:T(?:(\\d+)H)?(?:(\\d+)M)?(?:(\\d+(?:\\.\\d+)?)S)?)?$","description":"How often the information should be refreshed. Must be >= 30 days. We accept ISO-8601 duration interval value and support days, months, and/or years."},"next_pull_date":{"type":"string","description":"Optional date the next refresh should occur (Can be used as a start date). Must be >= 30 days after the Pull was created. Defaults to Pull created date + interval.","format":"date-time"},"stop_after_date":{"type":"string","format":"date-time","description":"Optional date after which monitoring should stop"},"pull_id":{"type":"string","format":"uuid","description":"ID of the Pull to be monitored"}},"required":["interval","pull_id"]}}}}}},"/teams/{teamId}/monitorings/{monitoringId}":{"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"teamId","in":"path","required":true,"description":"ID of Team"},{"schema":{"type":"string","format":"uuid"},"name":"monitoringId","in":"path","required":true,"description":"ID of Monitoring"}],"patch":{"summary":"PATCH /monitorings/:monitoringId","operationId":"patch-monitoring","responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the update was successful"},"monitoring":{"$ref":"#/components/schemas/Monitoring","description":"The updated Monitoring"}},"required":["success"]}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["INVALID_MONITORING_ID","INCORRECT_API_KEY_TYPE","INVALID_INTERVAL","INTERVAL_TOO_SHORT","INVALID_STOP_AFTER"]}},"required":["error"]}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}},"required":["error"]},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["SUBSCRIPTION_INACTIVE"]}},"required":["error"]},"examples":{"Example Response":{"value":{"error":"SUBSCRIPTION_INACTIVE"}}}}}},"404":{"description":"404 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["NOT_FOUND"]}},"required":["error"]}}}}},"description":"Update a Monitoring to change the refresh interval, next refresh date, stop date or status. A Monitoring represents an ongoing connection to an insurance account, used for refreshing information on a connected insurance account.","tags":["Monitorings API"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"interval":{"type":"string","format":"ISO-8601-duration","example":"P1M","pattern":"^(-?)P(?=\\d|T\\d)(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)([DW]))?(?:T(?:(\\d+)H)?(?:(\\d+)M)?(?:(\\d+(?:\\.\\d+)?)S)?)?$","description":"How often the information should be refreshed. Must be >= 30 days. We accept ISO-8601 duration interval value and support days, months, and/or years."},"next_pull_date":{"type":"string","description":"Optional date the next refresh should occur. Must be >= 30 days after the latest Pull was created. Defaults to Pull created date + interval.","format":"date-time"},"stop_after_date":{"type":"string","format":"date-time","description":"Optional date after which monitoring should stop"},"status":{"type":"string","description":"Optional status to update the monitoring to"}}}}}}},"delete":{"summary":"DELETE /monitorings/:monitoringId","operationId":"delete-monitoring","responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether deleting the Monitoring was successful"},"monitoring":{"$ref":"#/components/schemas/Monitoring","description":"The Monitoring that was stopped"}},"required":["success"]}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["INVALID_MONITORING_ID","INCORRECT_API_KEY_TYPE"]}},"required":["error"]}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}},"required":["error"]},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["SUBSCRIPTION_INACTIVE"]}},"required":["error"]},"examples":{"Example Response":{"value":{"error":"SUBSCRIPTION_INACTIVE"}}}}}},"404":{"description":"404 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["NOT_FOUND"]}},"required":["error"]}}}}},"description":"Used to stop/pause a Monitoring. A Monitoring represents an ongoing connection to an insurance account, used for refreshing information on a connected insurance account.","tags":["Monitorings API"]},"get":{"summary":"GET /monitorings/:monitoringId","operationId":"get-monitoring","responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"type":"object","required":["monitoring"],"properties":{"monitoring":{"$ref":"#/components/schemas/Monitoring"},"pulls":{"type":"array","description":"Available when `with_pulls` is `true`","items":{"type":"object","properties":{"pull_id":{"type":"string","format":"uuid","description":"ID of the Pull"},"widget_id":{"type":"string","format":"uuid","description":"ID of the Widget the Pull belongs to"},"created_at":{"type":"string","format":"date-time","description":"Date the Pull was created"},"first_name":{"type":"string","description":"First name of policy holder"},"middle_name":{"type":"string","description":"Middle name of policy holder"},"last_name":{"type":"string","description":"Last name of policy holder"},"email":{"type":"string","format":"email","description":"Email optionally provided by consumer after submitting bad credentials (`NOT_AUTHENTICATED`)"},"account_email":{"type":"string","format":"email","description":"Policy holder email address"},"phone":{"type":"string","description":"Preferred contact phone"},"mobile_phone":{"type":"string","description":"Policy holder mobile phone"},"home_phone":{"type":"string","description":"Policy holder home phone"},"work_phone":{"type":"string","description":"Policy holder work phone"},"work_phone_extension":{"type":"string","description":"Policy holder work phone extension"},"status":{"type":"string","description":"Status of the Pull"},"insurance_provider_name":{"type":"string","description":"Policy holder's insurance provider"},"is_archived":{"type":"boolean","description":"Whether the pull is archived"},"monitoring_status":{"type":"string","description":"The monitoring status of the pull","enum":["PROCESSING","WAITING_FOR_USER","COMPLETED","EXPIRED"]}}}}}}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["INVALID_MONITORING_ID","INCORRECT_API_KEY_TYPE"]}},"required":["error"]}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}},"required":["error"]},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["SUBSCRIPTION_INACTIVE"]}},"required":["error"]},"examples":{"Example Response":{"value":{"error":"SUBSCRIPTION_INACTIVE"}}}}}},"404":{"description":"404 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["NOT_FOUND"]}},"required":["error"]}}}}},"tags":["Monitorings API"],"description":"Fetch a monitoring. A Monitoring represents an ongoing connection to an insurance account, used for refreshing information on a connected insurance account.","parameters":[{"schema":{"type":"boolean","enum":[true]},"in":"query","name":"with_pulls","description":"Whether pulls should be included"},{"schema":{"type":"string","default":"100"},"in":"query","name":"limit","description":"Pagination limit for the pulls"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"before","description":"Pagination before pointer for a pull_id"}]}},"/teams/{teamId}/monitorings/{monitoringId}/reconnectToken":{"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"teamId","in":"path","required":true,"description":"ID of Team"},{"schema":{"type":"string","format":"uuid"},"name":"monitoringId","in":"path","required":true,"description":"ID of Monitoring"}],"get":{"summary":"GET /monitorings/:monitoringId/reconnectToken","tags":["Monitorings API"],"responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"pull_id":{"type":"string","format":"uuid"},"reconnect_url":{"type":"string"},"reconnect_token":{"type":"string"}},"required":["pull_id","reconnect_url","reconnect_token"]}}}}},"operationId":"get-monitoring-reconnect-token","description":"Used to generate a reconnect token for a monitoring"}},"/teams/{teamId}/monitorings/{monitoringId}/refresh":{"post":{"summary":"POST /monitorings/:monitoringId/refresh","responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"pull_id":{"type":"string","format":"uuid"}}}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["CURRENTLY_REFRESHING","MONITORING_INACTIVE","PULL_NOT_SUPPORTED"]}}}}}},"404":{"description":"404 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["NOT_FOUND"]}}}}}}},"operationId":"post-monitoring-refresh","description":"Initiate a refresh of the data on a connected insurance account on-demand. A Monitoring represents an ongoing connection to an insurance account, used for refreshing information on a connected insurance account.","tags":["Monitorings API"]},"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"teamId","in":"path","required":true,"description":"ID of Team"},{"schema":{"type":"string","format":"uuid"},"name":"monitoringId","in":"path","required":true,"description":"ID of Monitoring"}]},"/teams/{teamId}/monitorings/{monitoringId}/events":{"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"teamId","in":"path","required":true,"description":"ID of Team"},{"schema":{"type":"string","format":"uuid"},"name":"monitoringId","in":"path","required":true,"description":"ID of Monitoring"}],"get":{"summary":"GET /monitorings/:monitoringId/events","tags":["Monitorings API"],"responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"previous_pull_id":{"type":"string","format":"uuid","description":"The ID of the previous Pull in the Monitoring."},"latest_pull_id":{"type":"string","format":"uuid","description":"The ID of the most recent Pull in the Monitoring."},"events":{"type":"array","description":"An array of events that occurred between the two most recent Pulls in the Monitoring.","items":{"$ref":"#/components/schemas/MonitoringEvent"}}}},"examples":{"New vehicle added":{"value":{"previous_pull_id":"b2cc89fc-2064-4259-bb61-460924fe115f","latest_pull_id":"af9d4a2e-f1f8-476a-a515-e16bbd432c91","events":[{"type":"ENDORSEMENT","changes":[{"schema":"POLICY","type":"UPDATE","before":{"total_premium_cents":51400},"after":{"total_premium_cents":62100}},{"schema":"VEHICLE","type":"CREATE","before":null,"after":{"vehicle_id":"3f7c2f44-51b6-4292-a502-f353ed0404f9"}},{"schema":"VEHICLEDRIVER","type":"CREATE","before":null,"after":{"vehicle_driver_id":"b1664850-19e6-4dce-a367-3f98234b4b47"}}],"documents":[{"document_id":"2754c9f8-a5b0-4282-a1a1-0ef29a97dd09"}]}]}},"Coverage change":{"value":{"previous_pull_id":"b2cc89fc-2064-4259-bb61-460924fe115f","latest_pull_id":"af9d4a2e-f1f8-476a-a515-e16bbd432c91","events":[{"type":"ENDORSEMENT","changes":[{"schema":"POLICY","type":"UPDATE","before":{"total_premium_cents":51400},"after":{"total_premium_cents":62100}},{"schema":"VEHICLECOVERAGE","type":"CREATE","before":null,"after":{"vehicle_coverage_id":"3f7c2f44-51b6-4292-a502-f353ed0404f9"}}],"documents":[{"document_id":"2754c9f8-a5b0-4282-a1a1-0ef29a97dd09"}]}]}},"Policy renewing with higher premium":{"value":{"previous_pull_id":"b2cc89fc-2064-4259-bb61-460924fe11f","latest_pull_id":"af9d4a2e-f1f8-476a-a515-e16bbd432c91","events":[{"type":"RENEWAL","changes":[{"schema":"POLICY","type":"UPDATE","before":{"total_premium_cents":51400,"effective_date":"2024-08-05T04:00:00.000Z","expiry_date":"2025-02-05T04:00:00.000Z"},"after":{"total_premium_cents":62100,"effective_date":"2025-02-05T04:00:00.000Z","expiry_date":"2025-08-05T04:00:00.000Z"}}],"documents":[{"document_id":"2754c9f8-a5b0-4282-a1a1-0ef29a97dd09"}]}]}},"Claim falls off the account":{"value":{"previous_pull_id":"b2cc89fc-2064-4259-bb61-460924fe115f","latest_pull_id":"af9d4a2e-f1f8-476a-a515-e16bbd432c91","events":[{"type":"CLAIM_REMOVED","changes":[{"schema":"CLAIM","type":"DELETE","before":{"claim_id":"595fb653-4684-4d81-91b8-1347626c7799"},"after":null}]}]}},"Driving record falls off the account":{"value":{"previous_pull_id":"b2cc89fc-2064-4259-bb61-460924fe115f","latest_pull_id":"af9d4a2e-f1f8-476a-a515-e16bbd432c91","events":[{"type":"DRIVINGRECORD_REMOVED","changes":[{"schema":"DRIVINGRECORD","type":"DELETE","before":{"driving_record_id":"a087aa85-db55-4100-8684-b21acee37ee2"},"after":null}]}]}}}}}}},"operationId":"get-monitoring-events","description":"Used to get the events between the two most recent Pulls of a monitored insurance account. Your plan must include monitoring events in order to access this API. For more information, contact your Canopy Connect representative."}},"/policyforms/{policyFormId}/pdf":{"description":"Download a policy form PDF","parameters":[{"schema":{"type":"string","format":"uuid"},"name":"policyFormId","in":"path","required":true,"description":"ID of Policy Form"}],"get":{"summary":"GET /policyforms/:policyFormId/pdf","tags":["Policy Forms API"],"description":"Used to download a policy form PDF. Your plan must include policy forms in order to access this API in production. For more information, contact your Canopy Connect representative.","responses":{"200":{"description":"200 Response Schema","content":{"application/pdf":{"examples":{"Example Response":{"value":"...document...data...buffer..."}},"schema":{"type":"string","format":"byte"}}},"headers":{"Content-Disposition":{"schema":{"type":"string"},"description":"attachment; filename=\"<FORM_NAME>.pdf\""},"Content-Type":{"schema":{"type":"string"},"description":"application/pdf"}}},"400":{"description":"400 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":{"error":"VALIDATION_ERROR"}}},"schema":{"type":"object","properties":{"error":{"type":"string","enum":["VALIDATION_ERROR"]}}}}}},"404":{"description":"404 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["NOT_FOUND"]}}},"examples":{"Example Response":{"value":{"error":"NOT_FOUND"}}}}}}},"operationId":"get-policy-form-by-id"}},"/tos":{"get":{"summary":"GET /tos","description":"Used to retrieve the current terms of service version number and the html content of the terms of service. When presenting consent to the customer you may either link to https://usecanopy.com/privacy or show them the terms html.","operationId":"get-tos","responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":{"terms_version":1,"terms_html":"<!DOCTYPE html>\n<html lang=\"en\">...html_content...</html>\n"}}},"schema":{"type":"object","properties":{"terms_version":{"type":"integer","example":1,"default":0,"description":"The current version for our Terms of Service"},"terms_html":{"type":"string","example":"<!DOCTYPE html>\n<html lang=\"en\">...html_content...</html>\n","description":"Html content of our Terms of Service which must be made visible to the consumer through an button/link to collect consent"}}}}}}},"deprecated":false,"security":[],"tags":["Whitelabel API","Consent API"]}},"/widget/pull/consentAndConnect":{"post":{"summary":"POST /consentAndConnect","description":"Used to verify consent, create a pull, and start the authentication. Use [/connect](https://docs-ent.usecanopy.com/reference/post-connect) for reauthentication","operationId":"post-consent-and-connect","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"device_identifier":{"type":"string","description":"User's IP address or other unique user identifier"},"terms_version":{"type":"integer","description":"Must correspond to the terms_version that was presented to the user"},"consent_language":{"type":"string","description":"Text that was displayed to the user when prompting for their consent","maxLength":1024,"example":"By clicking <name of button> you agree to the Canopy Connect End User Privacy Policy and Terms of Service"},"public_alias":{"type":"string","description":"The widget alias that the pull will be submitted on"},"meta_data":{"type":"object","description":"JSON serializable metadata that will be saved to the pull"},"insurerName":{"type":"string","description":"Carrier ID to submit the credentials to"},"insurerUsername":{"type":"string","description":"The username token returned by [Components](https://docs.usecanopy.com/reference/components-reference-documentation#submit)","minLength":5,"maxLength":200},"insurerPassword":{"type":"string","description":"The password token returned by [Components](https://docs.usecanopy.com/reference/components-reference-documentation#submit)","minLength":5,"maxLength":200},"insurerThirdField":{"type":"string","description":"The thirdfield token returned by [Components](https://docs.usecanopy.com/reference/components-reference-documentation#submit)"},"servicing_actions":{"type":["array","null"],"description":"Will set the `pull.type` to `SERVICING`.","items":{"$ref":"#/paths/~1teams~1%7BteamId%7D~1servicings/post/requestBody/content/application~1json/schema/properties/servicing_actions/items"}},"refresh_reason":{"enum":["UPCOMING_MONITORING","UPCOMING_SERVICING"],"description":"Specify if intending to reuse the credentials and consent from this pull for a future [Monitoring](https://docs.usecanopy.com/reference/how-to-use-monitoring) or [Servicing](https://docs.usecanopy.com/reference/how-to-use-servicing) pull. Will attempt to refresh the session so that the consumer does not need to re-authenticate."}},"required":["device_identifier","terms_version","consent_language","public_alias","insurerName","insurerUsername"]},"examples":{"SERVICING":{"value":{"device_identifier":"127.0.0.1","terms_version":1,"consent_language":"By clicking <name of button> you agree to the Canopy Connect End User Privacy Policy and Terms of Service","public_alias":"demo","meta_data":{},"insurerName":"statefarm","insurerUsername":"b6d60778-0e25-40d6-843c-626222c3e524","insurerPassword":"2083eb68-0757-4aac-bf8d-d331b5271909","servicing_actions":[{"type":"ADD_MORTGAGEE","payload":{"carrier_policy_number":"HO132483","name":"JP MORGAN CHASE BANK NA ISAOA ATIMA","address":"PO BOX 47020, ATLANTA, GA 30362","loan_number":"1234567890","mortgagee_type":"FIRST"}}]}},"PULLING_DATA":{"value":{"device_identifier":"127.0.0.1","terms_version":1,"consent_language":"By clicking <name of button> you agree to the Canopy Connect End User Privacy Policy and Terms of Service","public_alias":"demo","meta_data":{},"insurerName":"statefarm","insurerUsername":"b6d60778-0e25-40d6-843c-626222c3e524","insurerPassword":"2083eb68-0757-4aac-bf8d-d331b5271909","servicing_actions":null}}}}}},"responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":{"pull_id":"ce559727-cf02-4ebf-83ce-8035f8828be4","pull_jwt":"...jwt..."}}},"schema":{"type":"object","properties":{"pull_id":{"type":"string","format":"uuid","description":"Pull Id used to interact with the pull","example":"ce559727-cf02-4ebf-83ce-8035f8828be4"},"pull_jwt":{"type":"string","description":"JWT used to authenticate interactions with the Pull"},"servicing_action_ids":{"type":"array","minItems":1,"description":"IDs for each of the `ServicingActions` created. They will be returned in the same order they were supplied.","items":{"type":"string","format":"uuid"}}},"required":["pull_id","pull_jwt"]}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":{"error":"MISSING_DEVICE_IDENTIFIER"}}},"schema":{"type":"object","properties":{"error":{"type":"string","enum":["MISSING_DEVICE_IDENTIFIER","INVALID_CONSENT_LANGUAGE","INVALID_PUBLIC_ALIAS","INCORRECT_API_KEY_TYPE","UNSUPPORTED_INSURER","INVALID_USERNAME","INVALID_PASSWORD","INVALID_THIRDFIELD","CONSENT_LANGUAGE_TOO_LONG","INVALID_SERVICING_ACTIONS","MISSING_SERVICING_ACTIONS"]}}}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}}},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"404":{"description":"404 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["INVALID_PRIVACY_POLICY_TERM_ID"]}}},"examples":{"Example Response":{"value":{"error":"INVALID_PRIVACY_POLICY_TERM_ID"}}}}}}},"deprecated":false,"tags":["Whitelabel API"]}},"/widget/pull/consentAndDocuments":{"post":{"summary":"POST /consentAndDocuments","description":"Used to verify consent, create a pull, and upload documents.","operationId":"post-consent-and-documents","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","required":["device_identifier","terms_version","consent_language","public_alias","documents"],"properties":{"device_identifier":{"type":"string","description":"User's IP address or other unique user identifier"},"terms_version":{"type":"integer","description":"Must correspond to the terms_version that was presented to the user"},"consent_language":{"type":"string","description":"Text that was displayed to the user when prompting for their consent","maxLength":1024,"example":"By clicking <name of button> you agree to the Canopy Connect End User Privacy Policy and Terms of Service"},"public_alias":{"type":"string","description":"The widget alias that the pull will be submitted on"},"meta_data":{"type":"object","description":"JSON serializable metadata that will be saved to the pull"},"insurerName":{"type":["string","null"],"description":"Carrier ID to submit the credentials to"},"documents":{"type":"array","description":"Insurance documents. Max size per file is 10MB. Max combined size is 200MB.\n\nExample adding files to formdata:\n```javascript\nconst formData = new FormData();\nformData.append('documents', file1);\nformData.append('documents', file2);\n```","maxItems":20,"minItems":1,"items":{"type":"string","format":"binary"}}}},"encoding":{"meta_data":{"style":"deepObject","explode":true}}}}},"responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":{"pull_id":"ce559727-cf02-4ebf-83ce-8035f8828be4"}}},"schema":{"type":"object","required":["pull_id"],"properties":{"pull_id":{"type":"string","format":"uuid","description":"Pull Id used to interact with the pull","example":"ce559727-cf02-4ebf-83ce-8035f8828be4"}}}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":{"error":"MISSING_DEVICE_IDENTIFIER"}}},"schema":{"type":"object","properties":{"error":{"type":"string","enum":["MISSING_DEVICE_IDENTIFIER","INVALID_CONSENT_LANGUAGE","INVALID_PUBLIC_ALIAS","INCORRECT_API_KEY_TYPE","UNSUPPORTED_INSURER","CONSENT_LANGUAGE_TOO_LONG","DOCUMENT_UPLOAD_DISABLED","COULD_NOT_CREATE"]}}}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}}},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"404":{"description":"404 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["INVALID_PRIVACY_POLICY_TERM_ID"]}}},"examples":{"Example Response":{"value":{"error":"INVALID_PRIVACY_POLICY_TERM_ID"}}}}}}},"deprecated":false,"tags":["Whitelabel API"]}},"/widget/pull/{pullId}/connect":{"post":{"summary":"POST /connect","description":"Used to reauthenticate a pull when its status is `NOT_AUTHENTICATED`","operationId":"post-connect","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"insurerName":{"type":"string","description":"Consumers carrier username"},"insurerUsername":{"type":"string","description":"The username token returned by [Components](https://docs.usecanopy.com/reference/components-reference-documentation#submit)","minLength":5,"maxLength":200},"insurerPassword":{"type":"string","description":"The password token returned by [Components](https://docs.usecanopy.com/reference/components-reference-documentation#submit)","minLength":5,"maxLength":200},"insurerThirdField":{"type":"string","description":"The thirdfield token returned by [Components](https://docs.usecanopy.com/reference/components-reference-documentation#submit)"}},"required":["insurerName","insurerUsername"]}}},"description":""},"responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":{"pull":{"pull_id":"ce559727-cf02-4ebf-83ce-8035f8828be4"},"shouldPoll":true}}},"schema":{"type":"object","properties":{"pull":{"type":"object","properties":{"pull_id":{"type":"string","example":"ce559727-cf02-4ebf-83ce-8035f8828be4","format":"uuid","description":"Pull Id of the pull that was re-connected (will be the same as the path parameter)"}}},"shouldPoll":{"type":"boolean","example":true,"default":true,"deprecated":true}}}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":{"error":"INVALID_INPUT"}}},"schema":{"type":"object","properties":{"error":{"type":"string","enum":["INVALID_INPUT","UNSUPPORTED_INSURER"]}}}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}}},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"404":{"description":"404 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["NOT_FOUND"]}}},"examples":{"Example Response":{"value":{"error":"NOT_FOUND"}}}}}}},"deprecated":false,"security":[],"parameters":[{"schema":{"type":"string"},"in":"header","name":"pull-jwt","description":"Pull JWT of the pull you are trying to re-connect","required":true}],"tags":["Whitelabel API"]},"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"pullId","in":"path","required":true,"description":"Pull ID of the pull you are trying to re-connect"}]},"/carriers":{"get":{"summary":"GET /carriers","description":"Used to retrieve a list of supported carriers. It also includes various attributes to aid in UI","operationId":"get-carriers","responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":[{"carrier_id":"chubb","name":"Chubb","usernameFieldPlaceholder":"User ID","thirdFieldPlaceholder":null,"color":"#150f96","homepageUrl":"www.chubb.com","createAccountUrl":"https://www.chubb.com/securePersonalContent/ng/reg/#/register/policy","resetPasswordUrl":"https://extpga01.chubb.com/ChbResetPassword","disablePasswordField":false,"servicingActions":["ADD_MORTGAGEE","EDIT_MORTGAGEE","REMOVE_MORTGAGEE"],"products":["personal"]},{"carrier_id":"nationalgeneral","name":"National General","usernameFieldPlaceholder":null,"thirdFieldPlaceholder":"Policy Number","color":"#f8981d","homepageUrl":"www.nationalgeneral.com","createAccountUrl":"https://service.nationalgeneral.com/Register.aspx","resetPasswordUrl":"https://service.nationalgeneral.com/RetrievePassword.aspx","disablePasswordField":false,"products":["personal","commercial"]}]}},"schema":{"type":"array","items":{"$ref":"#/paths/~1carriers~1%7BcarrierId%7D/get/responses/200/content/application~1json/schema"}}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}}},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}}},"deprecated":false,"tags":["Whitelabel API"],"security":[],"parameters":[{"schema":{"type":"string","example":"personal,commercial"},"in":"query","name":"products","description":"Cannot be used with `public_alias`. Comma separated list of products to show carriers for. Valid products: `personal`, `commercial`"},{"schema":{"type":"string"},"in":"query","name":"public_alias","description":"Cannot be used with `products`. The widget public alias that is used to return carriers with products that match the widget's supported products"}]}},"/carriers/{carrierId}":{"parameters":[{"schema":{"type":"string"},"name":"carrierId","in":"path","required":true}],"get":{"summary":"GET /carriers/:carrierId","tags":["Whitelabel API"],"responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"title":"Carrier","type":"object","properties":{"carrier_id":{"type":"string","example":"chubb","description":"Unique carrier id"},"name":{"type":"string","example":"Chubb","description":"Human-friendly carrier name"},"usernameFieldPlaceholder":{"type":"string","example":"User ID","description":"Default to 'Username' when null"},"thirdFieldPlaceholder":{"type":["string","null"],"description":"If not null then a third input field should be displayed with the value being the label. You can use thirdFieldValidtorRgx to validate the input and show thirdFieldValidatorError if it does not pass"},"thirdFieldValidatorError":{"type":"string","description":"A user friendly error message that can be displayed when thridfield input does not match the thirdFieldValidatorRgx"},"thirdFieldValidatorRgx":{"type":"string","format":"regex","description":"A regex pattern that can be used to validate thirdfield input from the user","example":"(FL|LA|NC|SC|TX)"},"thirdFieldValidatorRgxFlags":{"type":"string","description":"Regex flags to be used with thirdFieldValidatorRgx. Empty string is equivalent to no flags. Usage info: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#advanced_searching_with_flags","example":"i"},"color":{"type":"string","example":"#150f96","description":"Color derived from the carrier"},"homepageUrl":{"type":"string","example":"www.chubb.com","description":"Carrier homepage URL"},"createAccountUrl":{"type":"string","example":"https://www.chubb.com/securePersonalContent/ng/reg/#/register/policy","description":"Carrier URL to create an account"},"resetPasswordUrl":{"type":["string","null"],"example":"https://extpga01.chubb.com/ChbResetPassword","description":"Carrier URL to reset your password"},"disablePasswordField":{"type":"boolean","example":false,"default":true,"description":"True if password is not required for carrier (password field should be hidden)"},"servicingActions":{"type":"array","description":"`ServicingAction` types available for carrier.","items":{"enum":["ADD_MORTGAGEE","EDIT_MORTGAGEE","REMOVE_MORTGAGEE"]}},"products":{"type":"array","items":{"enum":["personal","commercial"]}},"subIssuerOf":{"type":"string","description":"If present, this carrier is a sub-issuer that routes through the parent carrier with this ID"}},"required":["carrier_id","name","usernameFieldPlaceholder","thirdFieldPlaceholder","color","homepageUrl","createAccountUrl","disablePasswordField"]},"examples":{"Example Response":{"value":{"carrier_id":"chubb","name":"Chubb","usernameFieldPlaceholder":"User ID","thirdFieldPlaceholder":null,"color":"#150f96","homepageUrl":"www.chubb.com","createAccountUrl":"https://www.chubb.com/securePersonalContent/ng/reg/#/register/policy","resetPasswordUrl":"https://extpga01.chubb.com/ChbResetPassword","disablePasswordField":false,"servicingActions":["ADD_MORTGAGEE","EDIT_MORTGAGEE","REMOVE_MORTGAGEE"],"products":["personal"]}}}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["INVALID_STATUS"]}}},"examples":{}}}},"404":{"description":"404 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["NOT_FOUND"]}}}}}}},"operationId":"get-carrier","description":"Used to retrieve a single supported carrier.","parameters":[{"schema":{"type":"string","example":"personal,commercial"},"in":"query","name":"products","description":"Cannot be used with `public_alias`. Comma separated list of products to include carriers for. Valid products: `personal`, `commercial`"},{"schema":{"type":"string"},"in":"query","name":"public_alias","description":"Cannot be used with `products`. The widget public alias that is used to include carriers with products that match the widget's supported products"}]}},"/widget/pull/{pullId}/idv":{"post":{"summary":"POST /idv","description":"Used to submit a mfa code when a pull has a status of `IDENTITY_VERIFICATION`","operationId":"post-idv","responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":{"pull_id":"ce559727-cf02-4ebf-83ce-8035f8828be4"}}},"schema":{"type":"object","properties":{"pull_id":{"type":"string","example":"ce559727-cf02-4ebf-83ce-8035f8828be4","description":"Pull Id of the pull the idv code was submitted to (will be the same as the path parameter)"}}}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":{"error":"INVALID_INPUT"}}},"schema":{"type":"object","properties":{"error":{"type":"string","enum":["INVALID_INPUT","INVALID_ACTION"]}}}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}}},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"404":{"description":"404 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["NOT_FOUND"]}}},"examples":{"Example Response":{"value":{"error":"NOT_FOUND"}}}}}}},"deprecated":false,"security":[],"parameters":[{"schema":{"type":"string"},"in":"header","description":"Pull JWT of the pull you are trying to submit a IDV code for","name":"pull-jwt","required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"mfaValue":{"type":"string","description":"The mfa value supplied by the consumer"}}}}},"description":""},"tags":["Whitelabel API"]},"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"pullId","in":"path","required":true,"description":"Pull ID of the pull you are trying to submit a IDV code for"}]},"/widget/pull/{pullId}/idvoptions":{"post":{"summary":"POST /idvoptions","description":"Used to select a mfa option when a pull has a status of `IDENTITY_VERIFICATION_OPTIONS`","operationId":"post-idvoptions","responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":{"pull_id":"ce559727-cf02-4ebf-83ce-8035f8828be4"}}},"schema":{"type":"object","properties":{"pull_id":{"type":"string","example":"ce559727-cf02-4ebf-83ce-8035f8828be4","description":"Pull Id of the pull the idv option was submitted to (will be the same as the path parameter)"}}}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":{"error":"INVALID_INPUT"}}},"schema":{"type":"object","properties":{"error":{"type":"string","enum":["INVALID_INPUT","INVALID_ACTION"]}}}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}}},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"404":{"description":"404 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["NOT_FOUND"]}}},"examples":{"Example Response":{"value":{"error":"NOT_FOUND"}}}}}}},"deprecated":false,"security":[],"parameters":[{"schema":{"type":"string"},"in":"header","name":"pull-jwt","description":"Pull JWT for the pull you are submitting IDV Options for","required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"optionKey":{"type":"string","description":"Derived from one of the keys from mfa_options"}}}}}},"tags":["Whitelabel API"]},"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"pullId","in":"path","required":true,"description":"Pull ID of the pull you are submitting IDV Options for"}]},"/widget/pull/reconnectToken":{"parameters":[],"post":{"summary":"POST /reconnectToken","tags":["Whitelabel API"],"responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"pull_id":{"type":"string","format":"uuid","description":"ID of the Pull being reconnected"},"pull_jwt":{"type":"string","description":"Pull JWT used to authenticate the rest of the Whitelabel API routes"}},"required":["pull_id","pull_jwt"]}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["INVALID_RECONNECT_TOKEN","INCORRECT_API_KEY_TYPE","MONITORING_INACTIVE","PULL_NOT_SUPPORTED","NEWER_PULL_AVAILABLE","ALREADY_RECONNECTED","UNSUPPORTED_CARRIER"]}}}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}},"required":["error"]},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"404":{"description":"404 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["NOT_FOUND"]}}}}}}},"operationId":"post-reconnect-token","description":"Used to reconnect to a monitored pull that requires input from the user","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reconnect_token":{"type":"string","description":"The Reconnect Token associated with the Pull."}},"required":["reconnect_token"]}}}}}},"/teams/{teamId}/servicings":{"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"teamId","in":"path","required":true,"description":"ID of Team"}],"get":{"summary":"GET /servicings","tags":["Servicings API"],"responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"total_servicings":{"type":"integer"},"servicings":{"type":"array","items":{"$ref":"#/components/schemas/ServicingAction"}}},"required":["total_servicings","servicings"]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["INVALID_INPUT"]}}}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}},"required":["error"]}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["SUBSCRIPTION_INACTIVE","UNAUTHORIZED"]}},"required":["error"]}}}}},"operationId":"get-servicings","description":"Used to get all `ServicingActions`.","parameters":[{"schema":{"type":"integer","default":100,"minimum":1,"maximum":100},"in":"query","name":"limit","description":"Pagination limit"},{"schema":{"type":"integer","format":"uuid","minimum":0},"in":"query","name":"offset","description":"Pagination offset from the first result"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"pull_id","description":"Filter used to list `ServicingsActions` related to a `Pull`"}]},"post":{"summary":"POST /servicings","operationId":"post-servicings","responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"pull_id":{"type":"string","format":"uuid"},"pull_jwt":{"type":"string"},"servicing_action_ids":{"type":"array","description":"IDs for each of the `ServicingActions` created. They will be returned in the same order they were supplied.","items":{"type":"string","format":"uuid","minLength":1}}}},"examples":{"Example 1":{"value":{"pull_id":"7aec3a23-0c86-41f7-937e-174af7c0aa6a","pull_jwt":"jwt-string","servicing_action_ids":["497f6eca-6276-4993-bfeb-53cbbbba6f08"]}}}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["INVALID_INPUT","PULL_TOO_OLD","INVALID_USERNAME"]}},"required":["error"]}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}},"required":["error"]},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["SUBSCRIPTION_INACTIVE","UNAUTHORIZED"]}},"required":["error"]},"examples":{"Example Response":{"value":{"error":"SUBSCRIPTION_INACTIVE"}}}}}},"404":{"description":"404 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["NOT_FOUND"]}},"required":["error"]}}}}},"description":"Used to create `ServicingActions` using the credentials + consent from an existing `Pull`. \n\nIf you are collecting credentials + consent for a new `Pull`, use [POST /consentAndConnect](https://docs.usecanopy.com/reference/post-consent-and-connect).","tags":["Servicings API"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"pull_id":{"type":"string","format":"uuid","description":"ID of the `Pull` to reuse the credentials + consent from."},"servicing_actions":{"type":"array","minItems":1,"items":{"title":"ServicingActionPayload","type":"object","examples":[{"servicing_action_id":"a082368f-fa48-48d3-9b0a-f3941c81511d","type":"ADD_MORTGAGEE","payload":{},"confirmation_data":{},"status":"QUEUED","validation_error_type":"INVALID_POLICY_NUMBER"}],"oneOf":[{"type":"object","$ref":"#/components/schemas/ServicingAction/allOf/1/oneOf/0/allOf/0"},{"type":"object","$ref":"#/components/schemas/ServicingAction/allOf/1/oneOf/1/allOf/0"},{"type":"object","$ref":"#/components/schemas/ServicingAction/allOf/1/oneOf/2/allOf/0"},{"type":"object","$ref":"#/components/schemas/ServicingAction/allOf/1/oneOf/3/allOf/0"}]}}},"required":["pull_id","servicing_actions"]},"examples":{"ADD_VEHICLE":{"value":{"pull_id":"7aec3a23-0c86-41f7-937e-174af7c0aa6a","servicing_actions":[{"type":"ADD_VEHICLE","payload":{"carrier_policy_number":"AU192837","vehicle":{"model_year":2012,"vin":"3N1AB6AP0CL704240","type":"PRIVATE_PASSENGER"},"replacing_vin":"3FAHP0HA8CR128394","registered_owner_full_name":"John Smith","registered_co_owner_full_name":"Alice Smith","registered_state":"AL","garaging_address":"344 Clinton Street, Brooklyn, NY, 11231","is_customized":true,"primary_use":{"type":"COMMUTE","days_driven_per_week":1,"miles_driven_each_way":1},"primary_driver_full_name":"John Smith","annual_mileage":10000,"current_mileage":2000,"coverage_selections":{"BODILY_INJURY_LIABILITY":{"per_person_limit_cents":10000000,"per_incident_limit_cents":30000000},"PROPERTY_DAMAGE_LIABILITY":{"per_incident_limit_cents":5000000},"PERSONAL_INJURY_PROTECTION":{"is_declined":true},"UNINSURED_MOTORISTS":{"is_declined":false,"per_person_limit_cents":2500000,"per_incident_limit_cents":5000000},"UNDERINSURED_MOTORISTS":{"is_declined":false,"per_person_limit_cents":2500000,"per_incident_limit_cents":5000000},"COLLISION":{"is_declined":false,"deductible_cents":50000},"COMPREHENSIVE":{"is_declined":false,"deductible_cents":50000},"EMERGENCY_ROAD_SERVICE":{"is_declined":true},"RENTAL_REIMBURSEMENT":{"is_declined":false,"per_day_limit_cents":3000,"max_days":30}},"safety_restraint_device":"NONE","anti_theft_device":"UNKNOWN","daytime_running_lights":true,"tracking_device":true,"vehicle_acquisition_date":"2023-08-16","vehicle_ownership":{"type":"OWN"}}}]}},"ADD_MORTGAGEE":{"value":{"pull_id":"7aec3a23-0c86-41f7-937e-174af7c0aa6a","servicing_actions":[{"type":"ADD_MORTGAGEE","payload":{"carrier_policy_number":"HO132483","name":"JP MORGAN CHASE BANK NA ISAOA ATIMA","address":"PO BOX 47020, ATLANTA, GA 30362","loan_number":"1234567890","mortgagee_type":"FIRST"}}]}},"EDIT_MORTGAGEE":{"value":{"pull_id":"7aec3a23-0c86-41f7-937e-174af7c0aa6a","servicing_actions":[{"type":"EDIT_MORTGAGEE","payload":{"carrier_policy_number":"HO132483","name":"JP MORGAN CHASE BANK NA ISAOA ATIMA","address":"PO BOX 47020, ATLANTA, GA 30362","loan_number":"1234567890","mortgagee_type":"FIRST"}}]}},"REMOVE_MORTGAGEE":{"value":{"pull_id":"7aec3a23-0c86-41f7-937e-174af7c0aa6a","servicing_actions":[{"type":"REMOVE_MORTGAGEE","payload":{"carrier_policy_number":"HO132483","mortgagee_type":"FIRST"}}]}}}}}}}},"/teams/{teamId}/servicings/{servicingActionId}":{"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"teamId","in":"path","required":true,"description":"ID of Team"},{"schema":{"type":"string","format":"uuid"},"name":"servicingActionId","in":"path","required":true,"description":"ID of ServicingAction"}],"get":{"summary":"GET /servicings/:servicingActionId","operationId":"get-servicing","responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicingAction"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["INVALID_INPUT"]}}}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}},"required":["error"]},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["SUBSCRIPTION_INACTIVE","UNAUTHORIZED"]}},"required":["error"]},"examples":{"Example Response":{"value":{"error":"SUBSCRIPTION_INACTIVE"}}}}}},"404":{"description":"404 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["NOT_FOUND"]}},"required":["error"]}}}}},"tags":["Servicings API"],"description":"Used to get a `ServicingAction`.","parameters":[]}},"/widget/pull/{pullId}/servicingAction":{"post":{"summary":"POST /servicingAction","description":"Used to submit confirmation for a `ServicingAction` on a `Pull`.","operationId":"post-servicing-action","responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":{"pull_id":"ce559727-cf02-4ebf-83ce-8035f8828be4"}}},"schema":{"type":"object","properties":{"pull_id":{"type":"string","example":"ce559727-cf02-4ebf-83ce-8035f8828be4","description":"Pull ID of the pull the `ServicingAction` was submitted for (will be the same as the path parameter)."}}}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":{"error":"INVALID_INPUT"}}},"schema":{"type":"object","properties":{"error":{"type":"string","enum":["INVALID_INPUT","INVALID_ACTION"]}}}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}}},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"404":{"description":"404 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["NOT_FOUND"]}}},"examples":{"Example Response":{"value":{"error":"NOT_FOUND"}}}}}}},"deprecated":false,"security":[],"parameters":[{"schema":{"type":"string"},"in":"header","name":"pull-jwt","description":"Pull JWT for the `Pull` you are submitting `ServicingAction` confirmation for.","required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"servicing_action_id":{"type":"string","format":"uuid","description":"ID for the `ServicingAction` you are submitting confirmation for."},"is_confirmed":{"type":"boolean","description":"Whether to confirm (true) or reject (false) the `ServicingAction` based on the `confirmation_data` available for it."}},"required":["servicing_action_id","is_confirmed"]}}}},"tags":["Whitelabel API"]},"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"pullId","in":"path","required":true,"description":"ID of the `Pull` you are submitting `ServicingAction` confirmation for."}]},"/health":{"get":{"summary":"GET /health","tags":["Misc API"],"responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"healthy":{"type":"boolean","default":true}}},"examples":{"200 Example Response":{"value":{"healthy":true}}}}}},"500":{"description":"500 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"healthy":{"type":"boolean","default":false}}},"examples":{"500 Example Response":{"value":{"healthy":false}}}}}}},"operationId":"get-health","description":"Get the current health of the Canopy Connect service.","security":[]}},"/teams/{teamId}/enrich/propertyData":{"get":{"summary":"GET /propertyData","responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrichmentPropertyData"},"examples":{"200 Example Response":{"value":{"address":{"number":"344","street":"Clinton","type":"St","city":"Brooklyn","state":"NY","sec_unit_type":"Apartment","sec_unit_num":"3D","zip":"11231"},"data":{"apn":"02192-04-018-000","occupancy":null,"class":"SINGLE_FAMILY_RESIDENCE_TOWNHOUSE","sub_type":"RESIDENTIAL","year_built":1950,"construction_type":"BRICK","wall_type":"BRICK","foundation_type":"CONCRETE","frame_type":"WOOD","roof_cover":"SHINGLE","roof_shape":"PYRAMID","cooling_type":"CENTRAL","heating_type":"CENTRAL","heating_fuel":"GAS","energy_type":"GOOD","sewer_type":"MUNICIPAL","building_shape":"L_SHAPED","construction_quality":"EXCELLENT","has_fireplace":true,"num_fireplaces":1,"fireplace_type":"YES","has_pool":false,"pool_type":"NO_POOL","square_ft":934,"num_beds":2,"num_baths_full":2,"num_baths_partial":1,"num_stories":2,"num_units":1,"garage_type":"ATTACHED_1_CAR","garage_square_ft":240,"num_parking_spaces":1,"assessed_improvement_value_cents":1423000,"assessed_land_value_cents":2291000,"assessed_total_value_cents":3714000,"market_improvement_value_cents":19900000,"market_land_value_cents":32040000,"market_total_value_cents":51940000,"owner1_first_name":"Clark Joseph","owner1_last_name":"Kent","owner2_first_name":"Lois","owner2_last_name":"Lane","owner3_first_name":null,"owner3_last_name":null,"owner4_first_name":null,"owner4_last_name":null,"first_mortgage_amount_cents":null,"first_mortgage_lender":null,"second_mortgage_amount_cents":null,"second_mortgage_lender":null,"purchase_date":"2016-06-29","purchase_price_cents":50000000,"last_update_date":"2022-04-14"}}}}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["INVALID_ADDRESS"]}}},"examples":{"Example Response":{"value":{"error":"INVALID_ADDRESS"}}}}}},"404":{"description":"404 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["NO_PROPERTY_DATA"]}}},"examples":{"Example Response":{"value":{"error":"NO_PROPERTY_DATA"}}}}}}},"operationId":"get-property-data","description":"Look up property data for a given address. Your plan must include ad-hoc property data lookups in order to access this API. For more information, contact your Canopy Connect representative.","parameters":[{"schema":{"type":"string"},"in":"query","name":"address","description":"The address to look up property data for.","example":"344 Clinton Street, Apartment 3D, Brooklyn, NY, 11231"}],"tags":["Enrichment API"]},"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"teamId","in":"path","required":true,"description":"ID of Team"}]},"/teams/{teamId}/enrich/driverLicense":{"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"teamId","in":"path","required":true,"description":"ID of Team"}],"get":{"summary":"GET /driverLicense","tags":["Enrichment API"],"responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrichmentDriverLicense"}}}}},"operationId":"get-enrichment-driverlicense","parameters":[{"schema":{"type":"string"},"in":"query","name":"first_name","required":true,"description":"The first name of the person."},{"schema":{"type":"string"},"in":"query","name":"middle_name","description":"The middle name of the person."},{"schema":{"type":"string"},"in":"query","name":"last_name","required":true,"description":"The last name of the person."},{"schema":{"type":"string"},"in":"query","name":"date_of_birth_str","required":true,"description":"The date of birth of the person. MM/DD/YYYY"},{"schema":{"type":"string"},"in":"query","name":"address","required":true,"description":"A mailing or street address."},{"schema":{"type":"string"},"in":"query","name":"purpose","required":true,"description":"Why you are looking up the information. This must be an allowed reason under the DPPA."},{"schema":{"type":"string"},"in":"query","name":"employee_name","required":true,"description":"Person responsible for making the inquiry."},{"schema":{"type":"string"},"in":"query","name":"employee_job_function","required":true,"description":"The title of the person responsible for making the inquiry."}]}},"/teams/{teamId}/enrich/drivingRecordIq":{"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"teamId","in":"path","required":true,"description":"ID of Team"}],"get":{"summary":"GET /drivingRecordIq","tags":["Enrichment API"],"responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrichmentDrivingRecordIq"}}}}},"operationId":"get-enrichment-drivingrecordiq","parameters":[{"schema":{"type":"string"},"in":"query","name":"first_name","required":true,"description":"The first name of the person."},{"schema":{"type":"string"},"in":"query","name":"middle_name","description":"The middle name of the person."},{"schema":{"type":"string"},"in":"query","name":"last_name","required":true,"description":"The last name of the person."},{"schema":{"type":"string"},"in":"query","name":"address","required":true,"description":"A mailing or street address."},{"schema":{"type":"string"},"in":"query","name":"purpose","required":true,"description":"Why you are looking up the information. This must be an allowed reason under the DPPA."},{"schema":{"type":"string"},"in":"query","name":"employee_name","required":true,"description":"Person responsible for making the inquiry."},{"schema":{"type":"string"},"in":"query","name":"employee_job_function","required":true,"description":"The title of the person responsible for making the inquiry."},{"schema":{"type":"string"},"in":"query","name":"date_of_birth_str","description":"Required if DL is not supplied. Date of birth of the person in MM/DD/YYYY."},{"schema":{"type":"string"},"in":"query","name":"drivers_license","description":"Required if DOB is not supplied. The drivers license number of the person."},{"schema":{"type":"string"},"in":"query","name":"drivers_license_state","description":"Required if DOB is not supplied. The drivers license state of the person."}]}},"/teams/{teamId}/enrich/household":{"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"teamId","in":"path","required":true,"description":"ID of Team"}],"get":{"summary":"GET /household","tags":["Enrichment API"],"responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrichmentHousehold"}}}}},"operationId":"get-enrichment-household","parameters":[{"schema":{"type":"string"},"in":"query","name":"first_name","required":true,"description":"The first name of the person."},{"schema":{"type":"string"},"in":"query","name":"middle_name","description":"The middle name of the person."},{"schema":{"type":"string"},"in":"query","name":"last_name","required":true,"description":"The last name of the person."},{"schema":{"type":"string"},"in":"query","name":"address","required":true,"description":"A mailing or street address."},{"schema":{"type":"boolean"},"in":"query","name":"lookup_vehicles","description":"Whether vehicles should be included in the response"},{"schema":{"type":"string"},"in":"query","name":"purpose","required":true,"description":"Why you are looking up the information. This must be an allowed reason under the DPPA."},{"schema":{"type":"string"},"in":"query","name":"employee_name","required":true,"description":"Person responsible for making the inquiry."},{"schema":{"type":"string"},"in":"query","name":"employee_job_function","required":true,"description":"The title of the person responsible for making the inquiry."},{"schema":{"type":"string"},"in":"query","name":"date_of_birth_str","description":"Required if DL is not supplied. Date of birth of the person in MM/DD/YYYY."},{"schema":{"type":"string"},"in":"query","name":"drivers_license","description":"Required if DOB is not supplied. The drivers license number of the person."},{"schema":{"type":"string"},"in":"query","name":"drivers_license_state","description":"Required if DOB is not supplied. The drivers license state of the person."}]}},"/teams/{teamId}/policySearch":{"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"teamId","in":"path","required":true,"description":"ID of the requesting Team"}],"post":{"summary":"POST /policySearch","description":"Initiates a new credential-less insurance policy search. Supports Auto insurance policy search, Home insurance policy search, and Auto ID Card search.","operationId":"post-policy-search","tags":["Policy Search API"],"security":[{"BasicAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["device_identifier","terms_version","consent_language","public_alias","insurerName","searchType","searchData"],"properties":{"device_identifier":{"type":"string","description":"User's IP address or other unique end user identifier."},"terms_version":{"type":"integer","description":"Must correspond to the terms_version that was presented to the user."},"consent_language":{"type":"string","maxLength":1024,"description":"Text that was displayed to the user when prompting for their consent."},"public_alias":{"type":"string","description":"The widget alias that the pull will be submitted on."},"insurerName":{"type":"string","enum":["allstate","amfam","autoowners","farmers","nationwide","progressive","usaa"],"description":"Carrier ID to search for policies"},"searchType":{"type":"string","enum":["AUTO_ID_CARD","AUTO_POLICY","HOME_POLICY"],"description":"Type of search. Supply \"AUTO_ID_CARD\" for Auto ID Card Search, \"AUTO_POLICY\" for Auto Policy Search, and \"HOME_POLICY\" for Home Policy Search"},"searchData":{"type":"object","description":"Key/value pairs corresponding to carrier-specific input requirements"}}},"examples":{"Auto-Owners Auto ID Card Search by policy number and zip":{"value":{"device_identifier":"124.321.213.111","terms_version":1,"consent_language":"By clicking Continue you agree to the Canopy Connect End User Privacy Policy and Terms of Service","public_alias":"<YOUR_PUBLIC_ALIAS>","insurerName":"autoowners","searchType":"AUTO_ID_CARD","searchData":{"policyNumber":"12345678","zipCode":"90210"}}},"Farmers Auto ID Card Search by name, zip, and date of birth":{"value":{"device_identifier":"124.321.213.111","terms_version":1,"consent_language":"By clicking Continue you agree to the Canopy Connect End User Privacy Policy and Terms of Service","public_alias":"<YOUR_PUBLIC_ALIAS>","insurerName":"farmers","searchType":"AUTO_ID_CARD","searchData":{"firstName":"Clark","lastName":"Kent","zipCode":"90210","dateOfBirth":"01/01/1990","policyNumberOrInfo":"info"}}},"Farmers Auto ID Card Search by policy number and zip":{"value":{"device_identifier":"124.321.213.111","terms_version":1,"consent_language":"By clicking Continue you agree to the Canopy Connect End User Privacy Policy and Terms of Service","public_alias":"<YOUR_PUBLIC_ALIAS>","insurerName":"farmers","searchType":"AUTO_ID_CARD","searchData":{"policyNumber":"12345678","zipCode":"90210","policyNumberOrInfo":"policyNumber"}}},"Progressive Auto Policy Search by VIN":{"value":{"device_identifier":"124.321.213.111","terms_version":1,"consent_language":"By clicking Continue you agree to the Canopy Connect End User Privacy Policy and Terms of Service","public_alias":"<YOUR_PUBLIC_ALIAS>","insurerName":"progressive","searchType":"AUTO_POLICY","searchData":{"vin":"1G2ZG558964193639"}}},"USAA Home Policy Search by street address, zip, and policy number":{"value":{"device_identifier":"124.321.213.111","terms_version":1,"consent_language":"By clicking Continue you agree to the Canopy Connect End User Privacy Policy and Terms of Service","public_alias":"<YOUR_PUBLIC_ALIAS>","insurerName":"usaa","searchType":"HOME_POLICY","searchData":{"streetAddress":"123 Main Street","zipCode":"90210","policyNumber":"12345678"}}}}}}},"responses":{"200":{"description":"200 Response Schema - Policy Search Initiated","content":{"application/json":{"schema":{"type":"object","properties":{"pull_id":{"type":"string","format":"uuid","description":"Pull ID of the Pull with insurance policy or ID card inforrmation matching the search criteria"},"pull_jwt":{"type":"string","description":"Pull JWT used to authenticate the rest of the Whitelabel API routes"}},"required":["pull_id","pull_jwt"]},"examples":{"Success Response":{"value":{"pull_id":"550e8400-e29b-41d4-a716-446655440000","pull_jwt":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwdWxsX2lkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDAwIiwiaWF0IjoxNzA0NjcyMDAwfQ.abc123..."}}}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["INVALID_INPUT","INVALID_PUBLIC_ALIAS","INCORRECT_API_KEY_TYPE","INVALID_POLICY_LOOKUP_DATA"]}}},"examples":{"Invalid Search Type":{"description":"Returned when searchType is not one of AUTO_ID_CARD, AUTO_POLICY, or HOME_POLICY.","value":{"error":"INVALID_INPUT"}},"Invalid Public Alias":{"description":"Returned when: Widget with the specified public_alias doesn't exist, Widget doesn't have the POLICY_LOOKUP flag enabled, Widget belongs to a different team, or API key doesn't have access to the specified widget.","value":{"error":"INVALID_PUBLIC_ALIAS"}},"API Key Environment Mismatch":{"description":"Returned when using a sandbox API key with a production widget (or vice versa).","value":{"error":"INCORRECT_API_KEY_TYPE"}},"Invalid Insurance Provider":{"description":"Returned when insurerName is not a supported carrier.","value":{"error":"INVALID_INPUT"}},"Invalid Policy Lookup Data":{"description":"Returned when searchData has missing required fields or unexpected extra fields for the specified carrier and search type.","value":{"error":"INVALID_POLICY_LOOKUP_DATA"}}}}}},"403":{"description":"403 Response Schema - No Policy Lookup Access","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["FORBIDDEN"]}}},"examples":{"No Policy Lookup Access":{"description":"Returned when the team doesn't have access to the specified policy lookup type.","value":{"error":"FORBIDDEN"}}}}}},"500":{"description":"500 Response Schema - Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["INTERNAL_ERROR"]}}},"examples":{"Internal Server Error":{"description":"Returned when an unexpected error occurs during processing.","value":{"error":"INTERNAL_ERROR"}}}}}}}}},"/teams/{teamId}/policyChecks/settings":{"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"teamId","in":"path","required":true,"description":"ID of Team"}],"get":{"summary":"GET /policyChecks/settings","description":"Fetch the Policy Check settings on your Canopy Connect account. This shows which Policy Checks are configured. All configured Policy Checks are run on every submission.","tags":["Policy Check Team Setting API"],"responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"policy_check_settings":{"type":"object","properties":{"vehicle":{"$ref":"#/components/schemas/PolicyCheckVehicleSetting"},"dwelling":{"$ref":"#/components/schemas/PolicyCheckDwellingSetting"}}}},"required":["success","vehicle"]},"examples":{"Example Response":{"value":{"success":true,"vehicle":{"POLICY_NOT_ACTIVE":false,"LIENHOLDER_NAME_MISMATCH":[],"DRIVER_REMOVED":false,"VEHICLE_REMOVED":false,"NO_COLLISION_COVERAGE":false,"NO_COMPREHENSIVE_COVERAGE":false,"MAX_COLLISION_DEDUCTIBLE_CENTS":null,"MAX_COMPREEHENSIVE_DEDUCTIBLE_CENTS":null,"MIN_PROPERTY_DAMAGE_COVERAGE_CENTS":null,"MIN_BODILY_INJURY_COVERAGE":{"per_person_cents":null,"per_accident_cents":null},"MIN_UNINSURED_MOTORIST_BODILY_INJURY_COVERAGE":{"per_person_cents":null,"per_accident_cents":null}}}}}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}}},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["FORBIDDEN"]}}},"examples":{"Example Response":{"value":{"error":"FORBIDDEN"}}}}}}},"operationId":"get-policy-check-team-settings"},"post":{"summary":"POST /policyChecks/settings","description":"Configure the Policy Checks on your Canopy Connect account. All configured Policy Checks are run on every submission.","tags":["Policy Check Team Setting API"],"responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"policy_check_settings":{"type":"object","properties":{"vehicle":{"$ref":"#/components/schemas/PolicyCheckVehicleSetting"},"dwelling":{"$ref":"#/components/schemas/PolicyCheckDwellingSetting"}}}},"required":["success","vehicle"]},"examples":{"Example Response":{"value":{"success":true,"vehicle":{"POLICY_NOT_ACTIVE":false,"LIENHOLDER_NAME_MISMATCH":[],"DRIVER_REMOVED":false,"VEHICLE_REMOVED":false,"NO_COLLISION_COVERAGE":false,"NO_COMPREHENSIVE_COVERAGE":false,"MAX_COLLISION_DEDUCTIBLE_CENTS":null,"MAX_COMPREEHENSIVE_DEDUCTIBLE_CENTS":null,"MIN_PROPERTY_DAMAGE_COVERAGE_CENTS":null,"MIN_BODILY_INJURY_COVERAGE":{"per_person_cents":null,"per_accident_cents":null},"MIN_UNINSURED_MOTORIST_BODILY_INJURY_COVERAGE":{"per_person_cents":null,"per_accident_cents":null}}}}}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":{"error":"INVALID_INPUT"}}},"schema":{"type":"object","properties":{"error":{"type":"string","enum":["INVALID_INPUT"]}}}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}}},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["FORBIDDEN"]}}},"examples":{"Example Response":{"value":{"error":"FORBIDDEN"}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"policy_check_settings":{"type":"object","properties":{"vehicle":{"$ref":"#/components/schemas/PolicyCheckVehicleSetting"},"dwelling":{"$ref":"#/components/schemas/PolicyCheckDwellingSetting"}}}}}}}},"operationId":"post-policy-check-team-settings"}},"/teams/{teamId}/widgets":{"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"teamId","in":"path","required":true,"description":"ID of Team"}],"get":{"summary":"GET /widgets","parameters":[{"schema":{"type":"number","default":10,"minimum":1,"maximum":100},"in":"query","name":"limit","description":"Pagination limit for the widgets"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"before","description":"Pagination before pointer for a widget_id"}],"tags":["Widgets API"],"responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"widgets":{"type":"array","description":"Available widgets","items":{"$ref":"#/components/schemas/Widget"}}},"required":["success","widgets"]},"examples":{"Example Response":{"value":{"success":true,"widgets":[{"widget_id":"d2bb6d56-15ff-4760-a27c-362f9bce645a","public_alias":"demo","company_name":"Demo Company","logo_src":"https://app.usecanopy.com/widget-static/img/widget-logos/d2bb6d56-15ff-4760-a27c-362f9bce645a/x-uuid-x.png","icon_src":"https://app.usecanopy.com/widget-static/img/widget-logos/d2bb6d56-15ff-4760-a27c-362f9bce645a/icon-x-uuid-x.png","is_sandbox":false,"brand_color_hex":"405dff","public_url":"https://app.usecanopy.com/c/demo","agents":[{"agent_id":"6dcb460e-19ce-4d75-a280-d33fa37e3557","email":"demo@example.com","first_name":"John","last_name":"Doe","role":"ADMIN"}]}]}}}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":{"error":"VALIDATION_ERROR"}}},"schema":{"type":"object","properties":{"error":{"type":"string","enum":["VALIDATION_ERROR"]}}}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}}},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["SUBSCRIPTION_INACTIVE"]}}},"examples":{"Example Response":{"value":{"error":"SUBSCRIPTION_INACTIVE"}}}}}}},"operationId":"get-widgets","description":"Used to get all available widgets"},"post":{"summary":"POST /widgets","operationId":"post-widgets","responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","default":true},"widget":{"$ref":"#/components/schemas/Widget"}}}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":{"error":"INVALID_INPUT"}}},"schema":{"type":"object","properties":{"error":{"type":"string","enum":["INVALID_INPUT","WIDGET_RESTRICTED_API_KEY","INVALID_AGENT_ID","WIDGET_LIMIT_EXCEEDED","ALREADY_EXISTS"]}}}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}}},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["SUBSCRIPTION_INACTIVE"]}}},"examples":{"Example Response":{"value":{"error":"SUBSCRIPTION_INACTIVE"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"intro_title":{"type":"string","description":"The message displayed upon the introduction of the Widget flow."},"public_alias":{"type":"string","description":"The public identifier for the Widget (eg. demo => https://app.usecanopy.com/c/demo). When not explicitly set, a public_alias will be auto generated."},"company_name":{"type":"string","description":"The company name presented in the Widget flow."},"brand_color_hex":{"type":"string","description":"RRGGBB hexadecimal string used for color theming in the Widget flow."},"success_message":{"type":"string","description":"The message displayed upon successful completion of the Widget flow."},"on_success_redirect_url":{"type":["string","null"],"description":"The URL the user is taken to upon successful completion of the Widget flow."},"cobranded_intro_screen":{"type":"boolean","description":"Whether the enhanced “cobranded” introduction screen is enabled for the Widget flow."},"agents":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"agent_id":{"type":"string","format":"uuid"}}}},{"type":"array","items":{"type":"string","format":"uuid"}}],"description":"Optional list of agents to update (either list of agent_ids or agent object with agent_id)"}}}}}},"tags":["Widgets API"],"description":"Used to create a widget"}},"/teams/{teamId}/widgets/{widgetId}":{"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"teamId","in":"path","required":true},{"schema":{"type":"string","format":"uuid"},"name":"widgetId","in":"path","required":true}],"get":{"summary":"GET /:widgetId","tags":["Widgets API"],"responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","default":true},"widget":{"$ref":"#/components/schemas/Widget"}}}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":{"error":"INCORRECT_API_KEY_TYPE"}}},"schema":{"type":"object","properties":{"error":{"type":"string","enum":["INCORRECT_API_KEY_TYPE"]}}}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}}},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["SUBSCRIPTION_INACTIVE"]}}},"examples":{"Example Response":{"value":{"error":"SUBSCRIPTION_INACTIVE"}}}}}},"404":{"description":"404 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["NOT_FOUND"]}},"required":["error"]}}}}},"operationId":"get-widgetId","description":"Used to get a widget"},"patch":{"summary":"PATCH /:widgetId","operationId":"patch-widgetId","responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","default":true},"widget":{"$ref":"#/components/schemas/Widget"}}}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":{"error":"INVALID_INPUT"}}},"schema":{"type":"object","properties":{"error":{"type":"string","enum":["INCORRECT_API_KEY_TYPE","INVALID_INPUT","INVALID_AGENT_ID","ALREADY_EXISTS"]}}}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}}},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["SUBSCRIPTION_INACTIVE"]}}},"examples":{"Example Response":{"value":{"error":"SUBSCRIPTION_INACTIVE"}}}}}},"404":{"description":"404 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["NOT_FOUND"]}},"required":["error"]}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"intro_title":{"type":"string","description":"The message displayed upon the introduction of the Widget flow."},"public_alias":{"type":"string","description":"The public identifier for the Widget (eg. demo => https://app.usecanopy.com/c/demo). When not explicitly set, a public_alias will be auto generated."},"company_name":{"type":"string","description":"The company name presented in the Widget flow."},"brand_color_hex":{"type":"string","description":"RRGGBB hexadecimal string used for color theming in the Widget flow."},"success_message":{"type":"string","description":"The message displayed upon successful completion of the Widget flow."},"on_success_redirect_url":{"type":["string","null"],"description":"The URL the user is taken to upon successful completion of the Widget flow."},"cobranded_intro_screen":{"type":"boolean","description":"Whether the enhanced “cobranded” introduction screen is enabled for the Widget flow."},"agents":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"agent_id":{"type":"string","format":"uuid"}}}},{"type":"array","items":{"type":"string","format":"uuid"}}],"description":"Optional list of agents to update (either list of agent_ids or agent object with agent_id)"}}}}}},"tags":["Widgets API"],"description":"Used to edit a widget"},"delete":{"summary":"DELETE /:widgetId","operationId":"delete-widgetId","responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","default":true}}}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":{"error":"INCORRECT_API_KEY_TYPE"}}},"schema":{"type":"object","properties":{"error":{"type":"string","enum":["INCORRECT_API_KEY_TYPE"]}}}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}}},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["SUBSCRIPTION_INACTIVE"]}}},"examples":{"Example Response":{"value":{"error":"SUBSCRIPTION_INACTIVE"}}}}}},"404":{"description":"404 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["NOT_FOUND"]}},"required":["error"]}}}}},"tags":["Widgets API"],"description":"Used to delete a widget"}},"/teams/{teamId}/widgets/{widgetId}/logo":{"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"teamId","in":"path","required":true},{"schema":{"type":"string","format":"uuid"},"name":"widgetId","in":"path","required":true}],"put":{"summary":"PUT /:widgetId/logo","operationId":"put-widgetId-logo","responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","default":true},"widget":{"$ref":"#/components/schemas/Widget"}}}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":{"error":"INVALID_INPUT"}}},"schema":{"type":"object","properties":{"error":{"type":"string","enum":["INCORRECT_API_KEY_TYPE","INVALID_INPUT","INVALID_IMAGE"]}}}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}}},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["SUBSCRIPTION_INACTIVE"]}}},"examples":{"Example Response":{"value":{"error":"SUBSCRIPTION_INACTIVE"}}}}}},"404":{"description":"404 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["NOT_FOUND"]}},"required":["error"]}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"logo":{"type":"string","format":"binary"}}},"encoding":{"logo":{"contentType":"image/jpg, image/jpeg, image/png, image/webp"}}}}},"description":"Used to stream logo upload for a widget","tags":["Widgets API"]}},"/teams/{teamId}/widgets/{widgetId}/icon":{"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"teamId","in":"path","required":true},{"schema":{"type":"string","format":"uuid"},"name":"widgetId","in":"path","required":true}],"put":{"summary":"PUT /:widgetId/icon","operationId":"put-widgetId-icon","responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","default":true},"widget":{"$ref":"#/components/schemas/Widget"}}}}}},"400":{"description":"400 Response Schema","content":{"application/json":{"examples":{"Example Response":{"value":{"error":"INVALID_INPUT"}}},"schema":{"type":"object","properties":{"error":{"type":"string","enum":["INCORRECT_API_KEY_TYPE","INVALID_INPUT","INVALID_IMAGE"]}}}}}},"401":{"description":"401 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["UNAUTHORIZED"]}}},"examples":{"Example Response":{"value":{"error":"UNAUTHORIZED"}}}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["SUBSCRIPTION_INACTIVE"]}}},"examples":{"Example Response":{"value":{"error":"SUBSCRIPTION_INACTIVE"}}}}}},"404":{"description":"404 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["NOT_FOUND"]}},"required":["error"]}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"icon":{"type":"string","format":"binary"}}},"encoding":{"icon":{"contentType":"image/jpg, image/jpeg, image/png, image/webp"}}}}},"description":"Used to stream icon upload for a widget","tags":["Widgets API"]}},"/teams/{teamId}":{"parameters":[{"schema":{"type":"string"},"name":"teamId","in":"path","required":true}],"get":{"summary":"GET /:teamId","tags":["Teams API"],"responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"team_id":{"type":"string","description":"ID of the Team"},"company_name":{"type":"string","description":"Company name for the Team"},"client_id":{"type":"string","description":"Client ID used to make request"}}}}}}},"operationId":"get-team","description":"Used to get information about the current team"},"delete":{"summary":"DELETE /:teamId","tags":["Teams API"],"responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["SUBSCRIPTION_INACTIVE"]},"message":{"enum":["Subscription is already canceled"]}}}}}},"404":{"description":"404 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["NOT_FOUND"]},"message":{"enum":["Team not found"]}}}}}}},"operationId":"delete-team","description":"Used to deprovision a team"}},"/teams":{"post":{"summary":"POST /teams","tags":["Teams API"],"responses":{"200":{"description":"200 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"client_id":{"type":"string","description":"API client ID for the Team created"},"client_secret":{"type":"string","description":"API client secret for the Team created"},"team":{"type":"object","properties":{"team_id":{"type":"string","description":"ID of the Team created"},"company_name":{"type":"string","description":"Company name for the Team created"}}}}}}}},"403":{"description":"403 Response Schema","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["FORBIDDEN"]}}}}}}},"operationId":"create-team","description":"Used to provision a team","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"company_name":{"type":"string","minLength":1,"maxLength":255}}}}}}}}},"x-readme":{"headers":[],"explorer-enabled":true,"proxy-enabled":true,"samples-enabled":true}}