NAV
curl Ruby Python Javascript

Canopy Connect REST API v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Access

To gain access to the Canopy Connect API, create a Canopy Connect account. Once you’ve completed the signup process and acknowledged our terms, we’ll provide a live client_id and client_secret via the Dashboard. The API is served over HTTPS TLS version 1.2 and higher to ensure data privacy. HTTP and HTTPS with TLS versions below 1.2 are not supported. HTTP response status codes are used to indicate status and errors.

Authentication

Supply your x-canopy-client-id x-canopy-client-secret in the headers of your API requests.

Data flow

Register a webhook with Canopy Connect to receive notifications of data pulls completing. Make requests to the API endpoints to retrieve the information for a data pull.

Webhooks

Register a POST endpoint on your Canopy Connect dashboard to receive notifications of data pulls completing. The request body will be JSON of the form {"pull_id":"<PULL_ID>","status":"SUCCESS"}

Base URLs:

Terms of service Email: Support License: Apache 2.0

Authentication

Pulls

Retrieve insurance information

Retrieve a Pull by ID

Code samples

# You can also use wget
curl -X GET https://app.usecanopy.com/api/v1.0.0/teams/{teamId}/pulls/{pullId} \
  -H 'Accept: application/json' \
  -H 'x-canopy-client-id: CLIENT_ID' \
  -H 'x-canopy-client-secret: CLIENT_SECRET'

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'x-canopy-client-id' => 'CLIENT_ID',
  'x-canopy-client-secret' => 'CLIENT_SECRET'
}

result = RestClient.get 'https://app.usecanopy.com/api/v1.0.0/teams/{teamId}/pulls/{pullId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'x-canopy-client-id': 'CLIENT_ID',
  'x-canopy-client-secret': 'CLIENT_SECRET'
}

r = requests.get('https://app.usecanopy.com/api/v1.0.0/teams/{teamId}/pulls/{pullId}', headers = headers)

print(r.json())


const headers = {
  'Accept':'application/json',
  'x-canopy-client-id':'CLIENT_ID',
  'x-canopy-client-secret':'CLIENT_SECRET'
};

fetch('https://app.usecanopy.com/api/v1.0.0/teams/{teamId}/pulls/{pullId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /teams/{teamId}/pulls/{pullId}

Returns a single Pull

Parameters

Name In Type Required Description
teamId path string(uuid) true ID of Team that requested Pull belongs to
pullId path string(uuid) true ID of Pull to return

Example responses

200 Response

{
  "pull": {
    "pull_id": "7aec3a23-0c86-41f7-937e-174af7c0aa6a",
    "status": "SUCCESS",
    "first_name": "John",
    "middle_name": "Michael",
    "last_name": "Doe",
    "email": "johnmdoe@example.com",
    "account_email": "johnmdoe@example.com",
    "phone": "7077891110",
    "mobile_phone": "7077891110",
    "home_phone": "6176068911",
    "work_phone": "1234567890",
    "work_phone_extension": "123",
    "policies": [
      {
        "policy_id": "ee9b03e0-6495-427a-85a5-34444d24ae04",
        "name": "Auto #12345678",
        "description": "Effective 05/04/2020 - 11/04/2020",
        "policy_number": "12345678",
        "policy_type": "AUTO",
        "effective_date": "2020-05-04",
        "expiry_date": "2020-11-04",
        "renewal_date": "2020-11-04",
        "canceled_date": "2020-11-04",
        "total_premium_cents": 102400,
        "carrier_name": "USAA",
        "vehicles": [
          {
            "vehicle_id": "e57c411b-caf2-4a2e-b2e8-e232824b6ddf",
            "year": 2016,
            "make": "Toyota",
            "model": "Corolla",
            "series": "ZRE172L",
            "series2": "L/LE",
            "type": "PASSENGER CAR",
            "annual_mileage": 10000,
            "vin": "5YFBURHE3GP567966",
            "uses": [
              "PLEASURE",
              "COMMUTE",
              "RIDESHARE",
              "BUSINESS"
            ],
            "purchase_date": "2020-05-04",
            "ownership_type": "own",
            "features": [
              "Child Safety Door Locks",
              "Power Door Locks",
              "Driver Airbag",
              "Front Side Airbag",
              "Passenger Airbag"
            ],
            "lien_holder": "string",
            "lien_holder_address": {
              "address_id": "a32b0e3d-a5f5-48d8-a572-6ae561815055",
              "full_address": "609 Market St, San Francisco, CA, 94105, United States",
              "number": "609",
              "prefix": "string",
              "street": "Market",
              "type": "St",
              "suffix": "string",
              "city": "San Francisco",
              "state": "CA",
              "sec_unit_type": "string",
              "sec_unit_num": "string",
              "zip": "94105",
              "country": "US"
            },
            "garaging_address": {
              "address_id": "a32b0e3d-a5f5-48d8-a572-6ae561815055",
              "full_address": "609 Market St, San Francisco, CA, 94105, United States",
              "number": "609",
              "prefix": "string",
              "street": "Market",
              "type": "St",
              "suffix": "string",
              "city": "San Francisco",
              "state": "CA",
              "sec_unit_type": "string",
              "sec_unit_num": "string",
              "zip": "94105",
              "country": "US"
            },
            "drivers": [
              {
                "driver_id": "d13674cc-89e2-4383-beab-46a9e6e4a9b2",
                "first_name": "Emily",
                "middle_name": "Lane",
                "last_name": "Doe",
                "drivers_license": "AB12345678",
                "drivers_license_state": "CA",
                "date_of_birth_str": "1990-10-12",
                "education": "Bachelors",
                "occupation": "Waiter and Waitress",
                "gender": "Female",
                "marital_status": "Married",
                "relationship_to_insured": "Spouse",
                "age": 29,
                "age_on_date": "2020-10-12",
                "age_licensed": 17
              }
            ],
            "coverages": [
              {
                "vehicle_coverage_id": "cd9f9a96-c06f-4ebc-88da-bef191059aa6",
                "name": "BODILY_INJURY_LIABILITY",
                "friendly_name": "Bodily Injury Liability",
                "premium_cents": 52500,
                "per_mile_premium_tenth_of_cents": 30,
                "per_person_limit_cents": 1500000,
                "per_incident_limit_cents": 3000000,
                "per_day_limit_cents": 5000,
                "deductible_cents": 50000,
                "is_declined": false
              }
            ]
          }
        ],
        "dwellings": [
          {
            "dwelling_id": "63f9a99f-ab9d-4faf-83a6-5ae128451627",
            "address": {
              "address_id": "a32b0e3d-a5f5-48d8-a572-6ae561815055",
              "full_address": "609 Market St, San Francisco, CA, 94105, United States",
              "number": "609",
              "prefix": "string",
              "street": "Market",
              "type": "St",
              "suffix": "string",
              "city": "San Francisco",
              "state": "CA",
              "sec_unit_type": "string",
              "sec_unit_num": "string",
              "zip": "94105",
              "country": "US"
            },
            "coverages": [
              {
                "dwelling_coverage_id": "48706bc1-c862-4bd1-bcb8-f5eaa5ea23ce",
                "name": "DWELLING",
                "friendly_name": "Dwelling",
                "premium_cents": 52500,
                "per_person_limit_cents": 5000,
                "per_incident_limit_cents": 50000000,
                "deductible_cents": 100000,
                "is_declined": false
              }
            ]
          }
        ]
      }
    ],
    "documents": [
      {
        "document_id": "b792e8ae-2cb4-4209-85b9-32be4c2fcdd6",
        "title": "2020-05-04 Auto #12345678 - Declarations Page",
        "date_added": "2020-05-04",
        "document_type": "Declarations"
      }
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request Invalid Pull ID supplied None
401 Unauthorized Invalid authentication supplied None
404 Not Found Pull not found or not authorized to access the requested Pull None

Response Schema

Status Code 200

Name Type Required Restrictions Description
» pull Pull false none none
»» pull_id string(uuid) false none none
»» status string false none Pull Status
»» first_name string false none First name of policy holder
»» middle_name string false none Middle name of policy holder
»» last_name string false none Last name of policy holder
»» email string(email) false none Preferred contact email
»» account_email string(email) false none Policy holder email
»» phone string(phone number) false none Preferred contact phone
»» mobile_phone string(phone number) false none Policy holder mobile phone
»» home_phone string(phone number) false none Policy holder home phone
»» work_phone string(phone number) false none Policy holder work phone
»» work_phone_extension string(phone number) false none Policy holder work phone extension
»» policies [Policy] false none List of policy object
»»» policy_id string(uuid) false none none
»»» name string false none human-friendly name of policy
»»» description string false none human-friendly description of policy
»»» policy_number string false none carrier policy number
»»» policy_type string false none Policy type
»»» effective_date string(date) false none Policy effective date
»»» expiry_date string(date) false none Policy expiration date
»»» renewal_date string(date) false none Policy renewal date
»»» canceled_date string(date) false none Policy canceled date
»»» total_premium_cents integer false none Total policy premium in cents
»»» carrier_name string false none insurance carrier name
»»» vehicles [Vehicle] false none List of vehicle object
»»»» vehicle_id string(uuid) false none none
»»»» year integer false none vehicle year
»»»» make string false none vehicle make
»»»» model string false none vehicle model
»»»» series string false none vehicle series
»»»» series2 string false none vehicle series 2
»»»» type string false none vehicle type
»»»» annual_mileage integer false none vehicle annual mileage
»»»» vin string false none vehicle identification number'
»»»» uses [string] false none vehicle uses
»»»» purchase_date string(date) false none vehicle purchase date
»»»» ownership_type string false none Vehicle Ownership type
»»»» features [string] false none vehicle features
»»»» lien_holder string false none Vehicle lien holder
»»»» lien_holder_address Address false none none
»»»»» address_id string(uuid) false none none
»»»»» full_address string false none One-line address for convenience
»»»»» number string false none House or street number of Address
»»»»» prefix string false none Directional prefix for street, such as N, NE, E, etc
»»»»» street string false none Name of the street without directional or type qualifier
»»»»» type string false none Abbreviated street type, eg. Rd, St, Ave, etc
»»»»» suffix string false none Directional suffix for the street, as above
»»»»» city string false none City of Address
»»»»» state string false none State of Address
»»»»» sec_unit_type string false none the type of unit
»»»»» sec_unit_num string false none the number of the unit (may not be numeric)
»»»»» zip string false none Zipcode of Address
»»»»» country string false none Country of Address
»»»» garaging_address Address false none none
»»»» drivers [Driver] false none List of driver object
»»»»» driver_id string(uuid) false none none
»»»»» first_name string false none First name of driver
»»»»» middle_name string false none Middle name of driver
»»»»» last_name string false none Last name of driver
»»»»» drivers_license string false none Driver's license number
»»»»» drivers_license_state string false none State of Driver's license
»»»»» date_of_birth_str string false none Driver's date of birth
»»»»» education string false none Driver's education
»»»»» occupation string false none Driver's occupation
»»»»» gender string false none Driver's gender
»»»»» marital_status string false none Driver's marital status
»»»»» relationship_to_insured string false none Relationship to the insured
»»»»» age integer false none Driver's age
»»»»» age_on_date string(date) false none Date reference for driver's age
»»»»» age_licensed integer false none Age at which driver was licensed
»»»» coverages [VehicleCoverage] false none List of vehicle coverage object
»»»»» vehicle_coverage_id string(uuid) false none none
»»»»» name string false none Name of coverage item
»»»»» friendly_name string false none Name of coverage item
»»»»» premium_cents integer false none Premium paid for coverage item
»»»»» per_mile_premium_tenth_of_cents integer false none Premium paid per-mile for coverage item, in tenths of cents
»»»»» per_person_limit_cents integer false none Per-person limit, in cents
»»»»» per_incident_limit_cents integer false none Per-incident limit, in cents
»»»»» per_day_limit_cents integer false none Per-day limit, in cents
»»»»» deductible_cents integer false none Deductible, in cents
»»»»» is_declined boolean false none If true, this coverage item was declined
»»» dwellings [Dwelling] false none List of dwelling object
»»»» dwelling_id string(uuid) false none none
»»»» address Address false none none
»»»» coverages [DwellingCoverage] false none List of dwelling coverage object
»»»»» dwelling_coverage_id string(uuid) false none none
»»»»» name string false none Name of coverage item
»»»»» friendly_name string false none Friendly name of coverage item
»»»»» premium_cents integer false none Premium paid for coverage item, in cents
»»»»» per_person_limit_cents integer false none Per-person limit, in cents
»»»»» per_incident_limit_cents integer false none Per-incident limit, in cents
»»»»» deductible_cents integer false none Deductible, in cents
»»»»» is_declined boolean false none If true, this coverage item was declined
»» documents [Document] false none List of document object
»»» document_id string(uuid) false none none
»»» title string false none title of Document
»»» date_added string(date) false none Effective date of Document
»»» document_type string false none Type of Document

Enumerated Values

Property Value
status SUCCESS
status NOT_AUTHENTICATED
status IDENTITY_VERIFICATION_OPTIONS
status IDENTITY_VERIFICATION
status PULLING_DATA
policy_type AUTO
policy_type HOMEOWNERS
ownership_type own
ownership_type finance
ownership_type lease
name BODILY_INJURY_LIABILITY
name PROPERTY_DAMAGE_LIABILITY
name SINGLE_LIMIT_LIABILITY
name SUPPLEMENTAL_SPOUSAL_LIABILITY
name PERSONAL_INJURY_PROTECTION
name ADDITIONAL_PERSONAL_INJURY_PROTECTION
name GUEST_PERSONAL_INJURY_PROTECTION
name COMPREHENSIVE
name COMPREHENSIVE_GLASS
name COLLISION
name COLLISION_DEDUCTIBLE_WAIVER
name DISABILITY
name CAR_RENTAL_AND_TRAVEL_EXPENSES RENTAL_REIMBURSEMENT
name NECESSARY_EXPENSES
name UNINSURED_MOTORIST_BODILY_INJURY_LIABILITY
name UNDERINSURED_MOTORIST_BODILY_INJURY_LIABILITY
name UNINSURED_MOTORISTS
name UNDERINSURED_MOTORISTS
name TOWING_AND_LABOR
name VANISHING_DEDUCTIBLE
name WORK_LOSS_BENEFIT
name MEDICAL_PAYMENTS
name EMERGENCY_ROAD_SERVICE
name MECHANICAL_BREAKDOWN
name RIDESHARE_DRIVER
name LOAN_LEASE_PAYOFF
name GAP
name CUSTOM_PARTS_AND_EQUIPMENT
name ORIGINAL_PARTS_REPLACEMENT
name NEW_CAR_REPLACEMENT
name VANISHING_DEDUCTIBLE
friendly_name Bodily Injury Liability
friendly_name Property Damage Liability
friendly_name Single Limit Liability
friendly_name Supplemental Spousal Liability
friendly_name Personal Injury Protection
friendly_name Additional Personal Injury Protection
friendly_name Guest Personal Injury Protection
friendly_name Comprehensive
friendly_name Comprehensive Glass
friendly_name Collision
friendly_name Collision Deductible Waiver
friendly_name Disability
friendly_name Car Rental and Travel Expenses
friendly_name Necessary Expenses
friendly_name Uninsured Motorist Bodily Injury Liability
friendly_name Underinsured Motorist Bodily Injury Liability
friendly_name Uninsured Motorists
friendly_name Underinsured Motorists
friendly_name Towing And Labor
friendly_name Vanishing Deductible
friendly_name Work Loss Benefit
friendly_name Medical Payments
friendly_name Emergency Road Service
friendly_name Mechanical Breakdown
friendly_name Rideshare Driver
friendly_name Loan/lease payoff
friendly_name Gap
friendly_name Custom parts and equipment
friendly_name Original Parts Replacement
friendly_name New Car Replacement
friendly_name Vanishing Deductible
name DWELLING
name OTHER_STRUCTURES
name PERSONAL_PROPERTY
name LOSS_OF_USE
name PERSONAL_LIABILITY
name REPLACEMENT_COST_FULL_VALUE
name REPLACEMENT_COST_DWELLING
name REPLACEMENT_COST_CONTENTS
name GUEST_MEDICAL_PROTECTION
name MEDICAL_PAYMENTS
name BUILDING_CODES
name WIND_HAIL
name HURRICANE
name ESCAPE_OF_WATER
name ADDITIONAL_LIVING_EXPENSES
friendly_name Dwelling
friendly_name Other Structures
friendly_name Personal Property
friendly_name Loss of Use
friendly_name Personal Liability
friendly_name Special Personal Property
friendly_name Full Value Replacement Cost
friendly_name Dwelling Replacement Cost
friendly_name Contents Replacement Cost
friendly_name Guest Medical Protection
friendly_name Medical Payments
friendly_name Building Codes
friendly_name Wind/Hail
friendly_name Hurricane
friendly_name Escape of Water
friendly_name Additional Living Expenses
document_type Insurance Application
document_type Insurance Binder
document_type Declarations
document_type Endorsement
document_type Insurance ID Card
document_type Verification of Insurance

Get a list of your Pulls

Code samples

# You can also use wget
curl -X GET https://app.usecanopy.com/api/v1.0.0/teams/{teamId}/pulls \
  -H 'Accept: application/json' \
  -H 'x-canopy-client-id: CLIENT_ID' \
  -H 'x-canopy-client-secret: CLIENT_SECRET'

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'x-canopy-client-id' => 'CLIENT_ID',
  'x-canopy-client-secret' => 'CLIENT_SECRET'
}

result = RestClient.get 'https://app.usecanopy.com/api/v1.0.0/teams/{teamId}/pulls',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'x-canopy-client-id': 'CLIENT_ID',
  'x-canopy-client-secret': 'CLIENT_SECRET'
}

r = requests.get('https://app.usecanopy.com/api/v1.0.0/teams/{teamId}/pulls', headers = headers)

print(r.json())


const headers = {
  'Accept':'application/json',
  'x-canopy-client-id':'CLIENT_ID',
  'x-canopy-client-secret':'CLIENT_SECRET'
};

fetch('https://app.usecanopy.com/api/v1.0.0/teams/{teamId}/pulls',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /teams/{teamId}/pulls

Returns an Array of Pulls

Parameters

Name In Type Required Description
teamId path string(uuid) true ID of Team
since query string(date) false Filter by Pulls that occurred since the supplied date (inclusive)
before query string(date) false Filter by Pulls that occurred before the supplied date (inclusive)
limit query number false Optionally limit the number of Pulls that are returned in the response to a maximum of limit. Use along with offset
offset query number false Optionally return Pulls starting from the supplied offset within the total list of Pulls matching the query. Use along with limit

Example responses

200 Response

{
  "total_pulls": 1,
  "pulls": [
    {
      "pull_id": "7aec3a23-0c86-41f7-937e-174af7c0aa6a",
      "status": "SUCCESS",
      "first_name": "John",
      "middle_name": "Michael",
      "last_name": "Doe",
      "email": "johnmdoe@example.com",
      "account_email": "johnmdoe@example.com",
      "phone": "7077891110",
      "mobile_phone": "7077891110",
      "home_phone": "6176068911",
      "work_phone": "1234567890",
      "work_phone_extension": "123",
      "policies": [
        {
          "policy_id": "ee9b03e0-6495-427a-85a5-34444d24ae04",
          "name": "Auto #12345678",
          "description": "Effective 05/04/2020 - 11/04/2020",
          "policy_number": "12345678",
          "policy_type": "AUTO",
          "effective_date": "2020-05-04",
          "expiry_date": "2020-11-04",
          "renewal_date": "2020-11-04",
          "canceled_date": "2020-11-04",
          "total_premium_cents": 102400,
          "carrier_name": "USAA",
          "vehicles": [
            {
              "vehicle_id": "e57c411b-caf2-4a2e-b2e8-e232824b6ddf",
              "year": 2016,
              "make": "Toyota",
              "model": "Corolla",
              "series": "ZRE172L",
              "series2": "L/LE",
              "type": "PASSENGER CAR",
              "annual_mileage": 10000,
              "vin": "5YFBURHE3GP567966",
              "uses": [
                "PLEASURE",
                "COMMUTE",
                "RIDESHARE",
                "BUSINESS"
              ],
              "purchase_date": "2020-05-04",
              "ownership_type": "own",
              "features": [
                "Child Safety Door Locks",
                "Power Door Locks",
                "Driver Airbag",
                "Front Side Airbag",
                "Passenger Airbag"
              ],
              "lien_holder": "string",
              "lien_holder_address": {
                "address_id": "a32b0e3d-a5f5-48d8-a572-6ae561815055",
                "full_address": "609 Market St, San Francisco, CA, 94105, United States",
                "number": "609",
                "prefix": "string",
                "street": "Market",
                "type": "St",
                "suffix": "string",
                "city": "San Francisco",
                "state": "CA",
                "sec_unit_type": "string",
                "sec_unit_num": "string",
                "zip": "94105",
                "country": "US"
              },
              "garaging_address": {
                "address_id": "a32b0e3d-a5f5-48d8-a572-6ae561815055",
                "full_address": "609 Market St, San Francisco, CA, 94105, United States",
                "number": "609",
                "prefix": "string",
                "street": "Market",
                "type": "St",
                "suffix": "string",
                "city": "San Francisco",
                "state": "CA",
                "sec_unit_type": "string",
                "sec_unit_num": "string",
                "zip": "94105",
                "country": "US"
              },
              "drivers": [
                {
                  "driver_id": "d13674cc-89e2-4383-beab-46a9e6e4a9b2",
                  "first_name": "Emily",
                  "middle_name": "Lane",
                  "last_name": "Doe",
                  "drivers_license": "AB12345678",
                  "drivers_license_state": "CA",
                  "date_of_birth_str": "1990-10-12",
                  "education": "Bachelors",
                  "occupation": "Waiter and Waitress",
                  "gender": "Female",
                  "marital_status": "Married",
                  "relationship_to_insured": "Spouse",
                  "age": 29,
                  "age_on_date": "2020-10-12",
                  "age_licensed": 17
                }
              ],
              "coverages": [
                {
                  "vehicle_coverage_id": "cd9f9a96-c06f-4ebc-88da-bef191059aa6",
                  "name": "BODILY_INJURY_LIABILITY",
                  "friendly_name": "Bodily Injury Liability",
                  "premium_cents": 52500,
                  "per_mile_premium_tenth_of_cents": 30,
                  "per_person_limit_cents": 1500000,
                  "per_incident_limit_cents": 3000000,
                  "per_day_limit_cents": 5000,
                  "deductible_cents": 50000,
                  "is_declined": false
                }
              ]
            }
          ],
          "dwellings": [
            {
              "dwelling_id": "63f9a99f-ab9d-4faf-83a6-5ae128451627",
              "address": {
                "address_id": "a32b0e3d-a5f5-48d8-a572-6ae561815055",
                "full_address": "609 Market St, San Francisco, CA, 94105, United States",
                "number": "609",
                "prefix": "string",
                "street": "Market",
                "type": "St",
                "suffix": "string",
                "city": "San Francisco",
                "state": "CA",
                "sec_unit_type": "string",
                "sec_unit_num": "string",
                "zip": "94105",
                "country": "US"
              },
              "coverages": [
                {
                  "dwelling_coverage_id": "48706bc1-c862-4bd1-bcb8-f5eaa5ea23ce",
                  "name": "DWELLING",
                  "friendly_name": "Dwelling",
                  "premium_cents": 52500,
                  "per_person_limit_cents": 5000,
                  "per_incident_limit_cents": 50000000,
                  "deductible_cents": 100000,
                  "is_declined": false
                }
              ]
            }
          ]
        }
      ],
      "documents": [
        {
          "document_id": "b792e8ae-2cb4-4209-85b9-32be4c2fcdd6",
          "title": "2020-05-04 Auto #12345678 - Declarations Page",
          "date_added": "2020-05-04",
          "document_type": "Declarations"
        }
      ]
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request Invalid Team ID supplied None
401 Unauthorized Invalid authentication supplied None
404 Not Found Not found or not authorized to access the requested Team's Pulls None

Response Schema

Status Code 200

Name Type Required Restrictions Description
» total_pulls number false none Total number of Pulls matching the query
» pulls [Pull] false none none
»» pull_id string(uuid) false none none
»» status string false none Pull Status
»» first_name string false none First name of policy holder
»» middle_name string false none Middle name of policy holder
»» last_name string false none Last name of policy holder
»» email string(email) false none Preferred contact email
»» account_email string(email) false none Policy holder email
»» phone string(phone number) false none Preferred contact phone
»» mobile_phone string(phone number) false none Policy holder mobile phone
»» home_phone string(phone number) false none Policy holder home phone
»» work_phone string(phone number) false none Policy holder work phone
»» work_phone_extension string(phone number) false none Policy holder work phone extension
»» policies [Policy] false none List of policy object
»»» policy_id string(uuid) false none none
»»» name string false none human-friendly name of policy
»»» description string false none human-friendly description of policy
»»» policy_number string false none carrier policy number
»»» policy_type string false none Policy type
»»» effective_date string(date) false none Policy effective date
»»» expiry_date string(date) false none Policy expiration date
»»» renewal_date string(date) false none Policy renewal date
»»» canceled_date string(date) false none Policy canceled date
»»» total_premium_cents integer false none Total policy premium in cents
»»» carrier_name string false none insurance carrier name
»»» vehicles [Vehicle] false none List of vehicle object
»»»» vehicle_id string(uuid) false none none
»»»» year integer false none vehicle year
»»»» make string false none vehicle make
»»»» model string false none vehicle model
»»»» series string false none vehicle series
»»»» series2 string false none vehicle series 2
»»»» type string false none vehicle type
»»»» annual_mileage integer false none vehicle annual mileage
»»»» vin string false none vehicle identification number'
»»»» uses [string] false none vehicle uses
»»»» purchase_date string(date) false none vehicle purchase date
»»»» ownership_type string false none Vehicle Ownership type
»»»» features [string] false none vehicle features
»»»» lien_holder string false none Vehicle lien holder
»»»» lien_holder_address Address false none none
»»»»» address_id string(uuid) false none none
»»»»» full_address string false none One-line address for convenience
»»»»» number string false none House or street number of Address
»»»»» prefix string false none Directional prefix for street, such as N, NE, E, etc
»»»»» street string false none Name of the street without directional or type qualifier
»»»»» type string false none Abbreviated street type, eg. Rd, St, Ave, etc
»»»»» suffix string false none Directional suffix for the street, as above
»»»»» city string false none City of Address
»»»»» state string false none State of Address
»»»»» sec_unit_type string false none the type of unit
»»»»» sec_unit_num string false none the number of the unit (may not be numeric)
»»»»» zip string false none Zipcode of Address
»»»»» country string false none Country of Address
»»»» garaging_address Address false none none
»»»» drivers [Driver] false none List of driver object
»»»»» driver_id string(uuid) false none none
»»»»» first_name string false none First name of driver
»»»»» middle_name string false none Middle name of driver
»»»»» last_name string false none Last name of driver
»»»»» drivers_license string false none Driver's license number
»»»»» drivers_license_state string false none State of Driver's license
»»»»» date_of_birth_str string false none Driver's date of birth
»»»»» education string false none Driver's education
»»»»» occupation string false none Driver's occupation
»»»»» gender string false none Driver's gender
»»»»» marital_status string false none Driver's marital status
»»»»» relationship_to_insured string false none Relationship to the insured
»»»»» age integer false none Driver's age
»»»»» age_on_date string(date) false none Date reference for driver's age
»»»»» age_licensed integer false none Age at which driver was licensed
»»»» coverages [VehicleCoverage] false none List of vehicle coverage object
»»»»» vehicle_coverage_id string(uuid) false none none
»»»»» name string false none Name of coverage item
»»»»» friendly_name string false none Name of coverage item
»»»»» premium_cents integer false none Premium paid for coverage item
»»»»» per_mile_premium_tenth_of_cents integer false none Premium paid per-mile for coverage item, in tenths of cents
»»»»» per_person_limit_cents integer false none Per-person limit, in cents
»»»»» per_incident_limit_cents integer false none Per-incident limit, in cents
»»»»» per_day_limit_cents integer false none Per-day limit, in cents
»»»»» deductible_cents integer false none Deductible, in cents
»»»»» is_declined boolean false none If true, this coverage item was declined
»»» dwellings [Dwelling] false none List of dwelling object
»»»» dwelling_id string(uuid) false none none
»»»» address Address false none none
»»»» coverages [DwellingCoverage] false none List of dwelling coverage object
»»»»» dwelling_coverage_id string(uuid) false none none
»»»»» name string false none Name of coverage item
»»»»» friendly_name string false none Friendly name of coverage item
»»»»» premium_cents integer false none Premium paid for coverage item, in cents
»»»»» per_person_limit_cents integer false none Per-person limit, in cents
»»»»» per_incident_limit_cents integer false none Per-incident limit, in cents
»»»»» deductible_cents integer false none Deductible, in cents
»»»»» is_declined boolean false none If true, this coverage item was declined
»» documents [Document] false none List of document object
»»» document_id string(uuid) false none none
»»» title string false none title of Document
»»» date_added string(date) false none Effective date of Document
»»» document_type string false none Type of Document

Enumerated Values

Property Value
status SUCCESS
status NOT_AUTHENTICATED
status IDENTITY_VERIFICATION_OPTIONS
status IDENTITY_VERIFICATION
status PULLING_DATA
policy_type AUTO
policy_type HOMEOWNERS
ownership_type own
ownership_type finance
ownership_type lease
name BODILY_INJURY_LIABILITY
name PROPERTY_DAMAGE_LIABILITY
name SINGLE_LIMIT_LIABILITY
name SUPPLEMENTAL_SPOUSAL_LIABILITY
name PERSONAL_INJURY_PROTECTION
name ADDITIONAL_PERSONAL_INJURY_PROTECTION
name GUEST_PERSONAL_INJURY_PROTECTION
name COMPREHENSIVE
name COMPREHENSIVE_GLASS
name COLLISION
name COLLISION_DEDUCTIBLE_WAIVER
name DISABILITY
name CAR_RENTAL_AND_TRAVEL_EXPENSES RENTAL_REIMBURSEMENT
name NECESSARY_EXPENSES
name UNINSURED_MOTORIST_BODILY_INJURY_LIABILITY
name UNDERINSURED_MOTORIST_BODILY_INJURY_LIABILITY
name UNINSURED_MOTORISTS
name UNDERINSURED_MOTORISTS
name TOWING_AND_LABOR
name VANISHING_DEDUCTIBLE
name WORK_LOSS_BENEFIT
name MEDICAL_PAYMENTS
name EMERGENCY_ROAD_SERVICE
name MECHANICAL_BREAKDOWN
name RIDESHARE_DRIVER
name LOAN_LEASE_PAYOFF
name GAP
name CUSTOM_PARTS_AND_EQUIPMENT
name ORIGINAL_PARTS_REPLACEMENT
name NEW_CAR_REPLACEMENT
name VANISHING_DEDUCTIBLE
friendly_name Bodily Injury Liability
friendly_name Property Damage Liability
friendly_name Single Limit Liability
friendly_name Supplemental Spousal Liability
friendly_name Personal Injury Protection
friendly_name Additional Personal Injury Protection
friendly_name Guest Personal Injury Protection
friendly_name Comprehensive
friendly_name Comprehensive Glass
friendly_name Collision
friendly_name Collision Deductible Waiver
friendly_name Disability
friendly_name Car Rental and Travel Expenses
friendly_name Necessary Expenses
friendly_name Uninsured Motorist Bodily Injury Liability
friendly_name Underinsured Motorist Bodily Injury Liability
friendly_name Uninsured Motorists
friendly_name Underinsured Motorists
friendly_name Towing And Labor
friendly_name Vanishing Deductible
friendly_name Work Loss Benefit
friendly_name Medical Payments
friendly_name Emergency Road Service
friendly_name Mechanical Breakdown
friendly_name Rideshare Driver
friendly_name Loan/lease payoff
friendly_name Gap
friendly_name Custom parts and equipment
friendly_name Original Parts Replacement
friendly_name New Car Replacement
friendly_name Vanishing Deductible
name DWELLING
name OTHER_STRUCTURES
name PERSONAL_PROPERTY
name LOSS_OF_USE
name PERSONAL_LIABILITY
name REPLACEMENT_COST_FULL_VALUE
name REPLACEMENT_COST_DWELLING
name REPLACEMENT_COST_CONTENTS
name GUEST_MEDICAL_PROTECTION
name MEDICAL_PAYMENTS
name BUILDING_CODES
name WIND_HAIL
name HURRICANE
name ESCAPE_OF_WATER
name ADDITIONAL_LIVING_EXPENSES
friendly_name Dwelling
friendly_name Other Structures
friendly_name Personal Property
friendly_name Loss of Use
friendly_name Personal Liability
friendly_name Special Personal Property
friendly_name Full Value Replacement Cost
friendly_name Dwelling Replacement Cost
friendly_name Contents Replacement Cost
friendly_name Guest Medical Protection
friendly_name Medical Payments
friendly_name Building Codes
friendly_name Wind/Hail
friendly_name Hurricane
friendly_name Escape of Water
friendly_name Additional Living Expenses
document_type Insurance Application
document_type Insurance Binder
document_type Declarations
document_type Endorsement
document_type Insurance ID Card
document_type Verification of Insurance

Documents

Retrieve an insurance document

Get a Document's PDF content

Code samples

# You can also use wget
curl -X GET https://app.usecanopy.com/api/v1.0.0/teams/{teamId}/pulls/{pullId}/documents/{documentId}/pdf \
  -H 'Accept: application/pdf' \
  -H 'x-canopy-client-id: CLIENT_ID' \
  -H 'x-canopy-client-secret: CLIENT_SECRET'

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/pdf',
  'x-canopy-client-id' => 'CLIENT_ID',
  'x-canopy-client-secret' => 'CLIENT_SECRET'
}

result = RestClient.get 'https://app.usecanopy.com/api/v1.0.0/teams/{teamId}/pulls/{pullId}/documents/{documentId}/pdf',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/pdf',
  'x-canopy-client-id': 'CLIENT_ID',
  'x-canopy-client-secret': 'CLIENT_SECRET'
}

r = requests.get('https://app.usecanopy.com/api/v1.0.0/teams/{teamId}/pulls/{pullId}/documents/{documentId}/pdf', headers = headers)

print(r.json())


const headers = {
  'Accept':'application/pdf',
  'x-canopy-client-id':'CLIENT_ID',
  'x-canopy-client-secret':'CLIENT_SECRET'
};

fetch('https://app.usecanopy.com/api/v1.0.0/teams/{teamId}/pulls/{pullId}/documents/{documentId}/pdf',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /teams/{teamId}/pulls/{pullId}/documents/{documentId}/pdf

Returns a single Document's PDF content

Parameters

Name In Type Required Description
teamId path string(uuid) true ID of Team
pullId path string(uuid) true ID of Pull that Document belongs to
documentId path string(uuid) true ID of Document to return

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK successful operation string
400 Bad Request Invalid parameters supplied None
401 Unauthorized Invalid authentication parameters supplied None
404 Not Found Document not found or not authorized None

Schemas

Pull

{
  "pull_id": "7aec3a23-0c86-41f7-937e-174af7c0aa6a",
  "status": "SUCCESS",
  "first_name": "John",
  "middle_name": "Michael",
  "last_name": "Doe",
  "email": "johnmdoe@example.com",
  "account_email": "johnmdoe@example.com",
  "phone": "7077891110",
  "mobile_phone": "7077891110",
  "home_phone": "6176068911",
  "work_phone": "1234567890",
  "work_phone_extension": "123",
  "policies": [
    {
      "policy_id": "ee9b03e0-6495-427a-85a5-34444d24ae04",
      "name": "Auto #12345678",
      "description": "Effective 05/04/2020 - 11/04/2020",
      "policy_number": "12345678",
      "policy_type": "AUTO",
      "effective_date": "2020-05-04",
      "expiry_date": "2020-11-04",
      "renewal_date": "2020-11-04",
      "canceled_date": "2020-11-04",
      "total_premium_cents": 102400,
      "carrier_name": "USAA",
      "vehicles": [
        {
          "vehicle_id": "e57c411b-caf2-4a2e-b2e8-e232824b6ddf",
          "year": 2016,
          "make": "Toyota",
          "model": "Corolla",
          "series": "ZRE172L",
          "series2": "L/LE",
          "type": "PASSENGER CAR",
          "annual_mileage": 10000,
          "vin": "5YFBURHE3GP567966",
          "uses": [
            "PLEASURE",
            "COMMUTE",
            "RIDESHARE",
            "BUSINESS"
          ],
          "purchase_date": "2020-05-04",
          "ownership_type": "own",
          "features": [
            "Child Safety Door Locks",
            "Power Door Locks",
            "Driver Airbag",
            "Front Side Airbag",
            "Passenger Airbag"
          ],
          "lien_holder": "string",
          "lien_holder_address": {
            "address_id": "a32b0e3d-a5f5-48d8-a572-6ae561815055",
            "full_address": "609 Market St, San Francisco, CA, 94105, United States",
            "number": "609",
            "prefix": "string",
            "street": "Market",
            "type": "St",
            "suffix": "string",
            "city": "San Francisco",
            "state": "CA",
            "sec_unit_type": "string",
            "sec_unit_num": "string",
            "zip": "94105",
            "country": "US"
          },
          "garaging_address": {
            "address_id": "a32b0e3d-a5f5-48d8-a572-6ae561815055",
            "full_address": "609 Market St, San Francisco, CA, 94105, United States",
            "number": "609",
            "prefix": "string",
            "street": "Market",
            "type": "St",
            "suffix": "string",
            "city": "San Francisco",
            "state": "CA",
            "sec_unit_type": "string",
            "sec_unit_num": "string",
            "zip": "94105",
            "country": "US"
          },
          "drivers": [
            {
              "driver_id": "d13674cc-89e2-4383-beab-46a9e6e4a9b2",
              "first_name": "Emily",
              "middle_name": "Lane",
              "last_name": "Doe",
              "drivers_license": "AB12345678",
              "drivers_license_state": "CA",
              "date_of_birth_str": "1990-10-12",
              "education": "Bachelors",
              "occupation": "Waiter and Waitress",
              "gender": "Female",
              "marital_status": "Married",
              "relationship_to_insured": "Spouse",
              "age": 29,
              "age_on_date": "2020-10-12",
              "age_licensed": 17
            }
          ],
          "coverages": [
            {
              "vehicle_coverage_id": "cd9f9a96-c06f-4ebc-88da-bef191059aa6",
              "name": "BODILY_INJURY_LIABILITY",
              "friendly_name": "Bodily Injury Liability",
              "premium_cents": 52500,
              "per_mile_premium_tenth_of_cents": 30,
              "per_person_limit_cents": 1500000,
              "per_incident_limit_cents": 3000000,
              "per_day_limit_cents": 5000,
              "deductible_cents": 50000,
              "is_declined": false
            }
          ]
        }
      ],
      "dwellings": [
        {
          "dwelling_id": "63f9a99f-ab9d-4faf-83a6-5ae128451627",
          "address": {
            "address_id": "a32b0e3d-a5f5-48d8-a572-6ae561815055",
            "full_address": "609 Market St, San Francisco, CA, 94105, United States",
            "number": "609",
            "prefix": "string",
            "street": "Market",
            "type": "St",
            "suffix": "string",
            "city": "San Francisco",
            "state": "CA",
            "sec_unit_type": "string",
            "sec_unit_num": "string",
            "zip": "94105",
            "country": "US"
          },
          "coverages": [
            {
              "dwelling_coverage_id": "48706bc1-c862-4bd1-bcb8-f5eaa5ea23ce",
              "name": "DWELLING",
              "friendly_name": "Dwelling",
              "premium_cents": 52500,
              "per_person_limit_cents": 5000,
              "per_incident_limit_cents": 50000000,
              "deductible_cents": 100000,
              "is_declined": false
            }
          ]
        }
      ]
    }
  ],
  "documents": [
    {
      "document_id": "b792e8ae-2cb4-4209-85b9-32be4c2fcdd6",
      "title": "2020-05-04 Auto #12345678 - Declarations Page",
      "date_added": "2020-05-04",
      "document_type": "Declarations"
    }
  ]
}

Properties

Name Type Required Restrictions Description
pull_id string(uuid) false none none
status string false none Pull Status
first_name string false none First name of policy holder
middle_name string false none Middle name of policy holder
last_name string false none Last name of policy holder
email string(email) false none Preferred contact email
account_email string(email) false none Policy holder email
phone string(phone number) false none Preferred contact phone
mobile_phone string(phone number) false none Policy holder mobile phone
home_phone string(phone number) false none Policy holder home phone
work_phone string(phone number) false none Policy holder work phone
work_phone_extension string(phone number) false none Policy holder work phone extension
policies [Policy] false none List of policy object
documents [Document] false none List of document object

Enumerated Values

Property Value
status SUCCESS
status NOT_AUTHENTICATED
status IDENTITY_VERIFICATION_OPTIONS
status IDENTITY_VERIFICATION
status PULLING_DATA

Policy

{
  "policy_id": "ee9b03e0-6495-427a-85a5-34444d24ae04",
  "name": "Auto #12345678",
  "description": "Effective 05/04/2020 - 11/04/2020",
  "policy_number": "12345678",
  "policy_type": "AUTO",
  "effective_date": "2020-05-04",
  "expiry_date": "2020-11-04",
  "renewal_date": "2020-11-04",
  "canceled_date": "2020-11-04",
  "total_premium_cents": 102400,
  "carrier_name": "USAA",
  "vehicles": [
    {
      "vehicle_id": "e57c411b-caf2-4a2e-b2e8-e232824b6ddf",
      "year": 2016,
      "make": "Toyota",
      "model": "Corolla",
      "series": "ZRE172L",
      "series2": "L/LE",
      "type": "PASSENGER CAR",
      "annual_mileage": 10000,
      "vin": "5YFBURHE3GP567966",
      "uses": [
        "PLEASURE",
        "COMMUTE",
        "RIDESHARE",
        "BUSINESS"
      ],
      "purchase_date": "2020-05-04",
      "ownership_type": "own",
      "features": [
        "Child Safety Door Locks",
        "Power Door Locks",
        "Driver Airbag",
        "Front Side Airbag",
        "Passenger Airbag"
      ],
      "lien_holder": "string",
      "lien_holder_address": {
        "address_id": "a32b0e3d-a5f5-48d8-a572-6ae561815055",
        "full_address": "609 Market St, San Francisco, CA, 94105, United States",
        "number": "609",
        "prefix": "string",
        "street": "Market",
        "type": "St",
        "suffix": "string",
        "city": "San Francisco",
        "state": "CA",
        "sec_unit_type": "string",
        "sec_unit_num": "string",
        "zip": "94105",
        "country": "US"
      },
      "garaging_address": {
        "address_id": "a32b0e3d-a5f5-48d8-a572-6ae561815055",
        "full_address": "609 Market St, San Francisco, CA, 94105, United States",
        "number": "609",
        "prefix": "string",
        "street": "Market",
        "type": "St",
        "suffix": "string",
        "city": "San Francisco",
        "state": "CA",
        "sec_unit_type": "string",
        "sec_unit_num": "string",
        "zip": "94105",
        "country": "US"
      },
      "drivers": [
        {
          "driver_id": "d13674cc-89e2-4383-beab-46a9e6e4a9b2",
          "first_name": "Emily",
          "middle_name": "Lane",
          "last_name": "Doe",
          "drivers_license": "AB12345678",
          "drivers_license_state": "CA",
          "date_of_birth_str": "1990-10-12",
          "education": "Bachelors",
          "occupation": "Waiter and Waitress",
          "gender": "Female",
          "marital_status": "Married",
          "relationship_to_insured": "Spouse",
          "age": 29,
          "age_on_date": "2020-10-12",
          "age_licensed": 17
        }
      ],
      "coverages": [
        {
          "vehicle_coverage_id": "cd9f9a96-c06f-4ebc-88da-bef191059aa6",
          "name": "BODILY_INJURY_LIABILITY",
          "friendly_name": "Bodily Injury Liability",
          "premium_cents": 52500,
          "per_mile_premium_tenth_of_cents": 30,
          "per_person_limit_cents": 1500000,
          "per_incident_limit_cents": 3000000,
          "per_day_limit_cents": 5000,
          "deductible_cents": 50000,
          "is_declined": false
        }
      ]
    }
  ],
  "dwellings": [
    {
      "dwelling_id": "63f9a99f-ab9d-4faf-83a6-5ae128451627",
      "address": {
        "address_id": "a32b0e3d-a5f5-48d8-a572-6ae561815055",
        "full_address": "609 Market St, San Francisco, CA, 94105, United States",
        "number": "609",
        "prefix": "string",
        "street": "Market",
        "type": "St",
        "suffix": "string",
        "city": "San Francisco",
        "state": "CA",
        "sec_unit_type": "string",
        "sec_unit_num": "string",
        "zip": "94105",
        "country": "US"
      },
      "coverages": [
        {
          "dwelling_coverage_id": "48706bc1-c862-4bd1-bcb8-f5eaa5ea23ce",
          "name": "DWELLING",
          "friendly_name": "Dwelling",
          "premium_cents": 52500,
          "per_person_limit_cents": 5000,
          "per_incident_limit_cents": 50000000,
          "deductible_cents": 100000,
          "is_declined": false
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
policy_id string(uuid) false none none
name string false none human-friendly name of policy
description string false none human-friendly description of policy
policy_number string false none carrier policy number
policy_type string false none Policy type
effective_date string(date) false none Policy effective date
expiry_date string(date) false none Policy expiration date
renewal_date string(date) false none Policy renewal date
canceled_date string(date) false none Policy canceled date
total_premium_cents integer false none Total policy premium in cents
carrier_name string false none insurance carrier name
vehicles [Vehicle] false none List of vehicle object
dwellings [Dwelling] false none List of dwelling object

Enumerated Values

Property Value
policy_type AUTO
policy_type HOMEOWNERS

Document

{
  "document_id": "b792e8ae-2cb4-4209-85b9-32be4c2fcdd6",
  "title": "2020-05-04 Auto #12345678 - Declarations Page",
  "date_added": "2020-05-04",
  "document_type": "Declarations"
}

Properties

Name Type Required Restrictions Description
document_id string(uuid) false none none
title string false none title of Document
date_added string(date) false none Effective date of Document
document_type string false none Type of Document

Enumerated Values

Property Value
document_type Insurance Application
document_type Insurance Binder
document_type Declarations
document_type Endorsement
document_type Insurance ID Card
document_type Verification of Insurance

Vehicle

{
  "vehicle_id": "e57c411b-caf2-4a2e-b2e8-e232824b6ddf",
  "year": 2016,
  "make": "Toyota",
  "model": "Corolla",
  "series": "ZRE172L",
  "series2": "L/LE",
  "type": "PASSENGER CAR",
  "annual_mileage": 10000,
  "vin": "5YFBURHE3GP567966",
  "uses": [
    "PLEASURE",
    "COMMUTE",
    "RIDESHARE",
    "BUSINESS"
  ],
  "purchase_date": "2020-05-04",
  "ownership_type": "own",
  "features": [
    "Child Safety Door Locks",
    "Power Door Locks",
    "Driver Airbag",
    "Front Side Airbag",
    "Passenger Airbag"
  ],
  "lien_holder": "string",
  "lien_holder_address": {
    "address_id": "a32b0e3d-a5f5-48d8-a572-6ae561815055",
    "full_address": "609 Market St, San Francisco, CA, 94105, United States",
    "number": "609",
    "prefix": "string",
    "street": "Market",
    "type": "St",
    "suffix": "string",
    "city": "San Francisco",
    "state": "CA",
    "sec_unit_type": "string",
    "sec_unit_num": "string",
    "zip": "94105",
    "country": "US"
  },
  "garaging_address": {
    "address_id": "a32b0e3d-a5f5-48d8-a572-6ae561815055",
    "full_address": "609 Market St, San Francisco, CA, 94105, United States",
    "number": "609",
    "prefix": "string",
    "street": "Market",
    "type": "St",
    "suffix": "string",
    "city": "San Francisco",
    "state": "CA",
    "sec_unit_type": "string",
    "sec_unit_num": "string",
    "zip": "94105",
    "country": "US"
  },
  "drivers": [
    {
      "driver_id": "d13674cc-89e2-4383-beab-46a9e6e4a9b2",
      "first_name": "Emily",
      "middle_name": "Lane",
      "last_name": "Doe",
      "drivers_license": "AB12345678",
      "drivers_license_state": "CA",
      "date_of_birth_str": "1990-10-12",
      "education": "Bachelors",
      "occupation": "Waiter and Waitress",
      "gender": "Female",
      "marital_status": "Married",
      "relationship_to_insured": "Spouse",
      "age": 29,
      "age_on_date": "2020-10-12",
      "age_licensed": 17
    }
  ],
  "coverages": [
    {
      "vehicle_coverage_id": "cd9f9a96-c06f-4ebc-88da-bef191059aa6",
      "name": "BODILY_INJURY_LIABILITY",
      "friendly_name": "Bodily Injury Liability",
      "premium_cents": 52500,
      "per_mile_premium_tenth_of_cents": 30,
      "per_person_limit_cents": 1500000,
      "per_incident_limit_cents": 3000000,
      "per_day_limit_cents": 5000,
      "deductible_cents": 50000,
      "is_declined": false
    }
  ]
}

Properties

Name Type Required Restrictions Description
vehicle_id string(uuid) false none none
year integer false none vehicle year
make string false none vehicle make
model string false none vehicle model
series string false none vehicle series
series2 string false none vehicle series 2
type string false none vehicle type
annual_mileage integer false none vehicle annual mileage
vin string false none vehicle identification number'
uses [string] false none vehicle uses
purchase_date string(date) false none vehicle purchase date
ownership_type string false none Vehicle Ownership type
features [string] false none vehicle features
lien_holder string false none Vehicle lien holder
lien_holder_address Address false none none
garaging_address Address false none none
drivers [Driver] false none List of driver object
coverages [VehicleCoverage] false none List of vehicle coverage object

Enumerated Values

Property Value
ownership_type own
ownership_type finance
ownership_type lease

Dwelling

{
  "dwelling_id": "63f9a99f-ab9d-4faf-83a6-5ae128451627",
  "address": {
    "address_id": "a32b0e3d-a5f5-48d8-a572-6ae561815055",
    "full_address": "609 Market St, San Francisco, CA, 94105, United States",
    "number": "609",
    "prefix": "string",
    "street": "Market",
    "type": "St",
    "suffix": "string",
    "city": "San Francisco",
    "state": "CA",
    "sec_unit_type": "string",
    "sec_unit_num": "string",
    "zip": "94105",
    "country": "US"
  },
  "coverages": [
    {
      "dwelling_coverage_id": "48706bc1-c862-4bd1-bcb8-f5eaa5ea23ce",
      "name": "DWELLING",
      "friendly_name": "Dwelling",
      "premium_cents": 52500,
      "per_person_limit_cents": 5000,
      "per_incident_limit_cents": 50000000,
      "deductible_cents": 100000,
      "is_declined": false
    }
  ]
}

Properties

Name Type Required Restrictions Description
dwelling_id string(uuid) false none none
address Address false none none
coverages [DwellingCoverage] false none List of dwelling coverage object

Driver

{
  "driver_id": "d13674cc-89e2-4383-beab-46a9e6e4a9b2",
  "first_name": "Emily",
  "middle_name": "Lane",
  "last_name": "Doe",
  "drivers_license": "AB12345678",
  "drivers_license_state": "CA",
  "date_of_birth_str": "1990-10-12",
  "education": "Bachelors",
  "occupation": "Waiter and Waitress",
  "gender": "Female",
  "marital_status": "Married",
  "relationship_to_insured": "Spouse",
  "age": 29,
  "age_on_date": "2020-10-12",
  "age_licensed": 17
}

Properties

Name Type Required Restrictions Description
driver_id string(uuid) false none none
first_name string false none First name of driver
middle_name string false none Middle name of driver
last_name string false none Last name of driver
drivers_license string false none Driver's license number
drivers_license_state string false none State of Driver's license
date_of_birth_str string false none Driver's date of birth
education string false none Driver's education
occupation string false none Driver's occupation
gender string false none Driver's gender
marital_status string false none Driver's marital status
relationship_to_insured string false none Relationship to the insured
age integer false none Driver's age
age_on_date string(date) false none Date reference for driver's age
age_licensed integer false none Age at which driver was licensed

VehicleCoverage

{
  "vehicle_coverage_id": "cd9f9a96-c06f-4ebc-88da-bef191059aa6",
  "name": "BODILY_INJURY_LIABILITY",
  "friendly_name": "Bodily Injury Liability",
  "premium_cents": 52500,
  "per_mile_premium_tenth_of_cents": 30,
  "per_person_limit_cents": 1500000,
  "per_incident_limit_cents": 3000000,
  "per_day_limit_cents": 5000,
  "deductible_cents": 50000,
  "is_declined": false
}

A VehicleCoverage represents a single coverage line item on a vehicle policy.

Properties

Name Type Required Restrictions Description
vehicle_coverage_id string(uuid) false none none
name string false none Name of coverage item
friendly_name string false none Name of coverage item
premium_cents integer false none Premium paid for coverage item
per_mile_premium_tenth_of_cents integer false none Premium paid per-mile for coverage item, in tenths of cents
per_person_limit_cents integer false none Per-person limit, in cents
per_incident_limit_cents integer false none Per-incident limit, in cents
per_day_limit_cents integer false none Per-day limit, in cents
deductible_cents integer false none Deductible, in cents
is_declined boolean false none If true, this coverage item was declined

Enumerated Values

Property Value
name BODILY_INJURY_LIABILITY
name PROPERTY_DAMAGE_LIABILITY
name SINGLE_LIMIT_LIABILITY
name SUPPLEMENTAL_SPOUSAL_LIABILITY
name PERSONAL_INJURY_PROTECTION
name ADDITIONAL_PERSONAL_INJURY_PROTECTION
name GUEST_PERSONAL_INJURY_PROTECTION
name COMPREHENSIVE
name COMPREHENSIVE_GLASS
name COLLISION
name COLLISION_DEDUCTIBLE_WAIVER
name DISABILITY
name CAR_RENTAL_AND_TRAVEL_EXPENSES RENTAL_REIMBURSEMENT
name NECESSARY_EXPENSES
name UNINSURED_MOTORIST_BODILY_INJURY_LIABILITY
name UNDERINSURED_MOTORIST_BODILY_INJURY_LIABILITY
name UNINSURED_MOTORISTS
name UNDERINSURED_MOTORISTS
name TOWING_AND_LABOR
name VANISHING_DEDUCTIBLE
name WORK_LOSS_BENEFIT
name MEDICAL_PAYMENTS
name EMERGENCY_ROAD_SERVICE
name MECHANICAL_BREAKDOWN
name RIDESHARE_DRIVER
name LOAN_LEASE_PAYOFF
name GAP
name CUSTOM_PARTS_AND_EQUIPMENT
name ORIGINAL_PARTS_REPLACEMENT
name NEW_CAR_REPLACEMENT
name VANISHING_DEDUCTIBLE
friendly_name Bodily Injury Liability
friendly_name Property Damage Liability
friendly_name Single Limit Liability
friendly_name Supplemental Spousal Liability
friendly_name Personal Injury Protection
friendly_name Additional Personal Injury Protection
friendly_name Guest Personal Injury Protection
friendly_name Comprehensive
friendly_name Comprehensive Glass
friendly_name Collision
friendly_name Collision Deductible Waiver
friendly_name Disability
friendly_name Car Rental and Travel Expenses
friendly_name Necessary Expenses
friendly_name Uninsured Motorist Bodily Injury Liability
friendly_name Underinsured Motorist Bodily Injury Liability
friendly_name Uninsured Motorists
friendly_name Underinsured Motorists
friendly_name Towing And Labor
friendly_name Vanishing Deductible
friendly_name Work Loss Benefit
friendly_name Medical Payments
friendly_name Emergency Road Service
friendly_name Mechanical Breakdown
friendly_name Rideshare Driver
friendly_name Loan/lease payoff
friendly_name Gap
friendly_name Custom parts and equipment
friendly_name Original Parts Replacement
friendly_name New Car Replacement
friendly_name Vanishing Deductible

DwellingCoverage

{
  "dwelling_coverage_id": "48706bc1-c862-4bd1-bcb8-f5eaa5ea23ce",
  "name": "DWELLING",
  "friendly_name": "Dwelling",
  "premium_cents": 52500,
  "per_person_limit_cents": 5000,
  "per_incident_limit_cents": 50000000,
  "deductible_cents": 100000,
  "is_declined": false
}

Properties

Name Type Required Restrictions Description
dwelling_coverage_id string(uuid) false none none
name string false none Name of coverage item
friendly_name string false none Friendly name of coverage item
premium_cents integer false none Premium paid for coverage item, in cents
per_person_limit_cents integer false none Per-person limit, in cents
per_incident_limit_cents integer false none Per-incident limit, in cents
deductible_cents integer false none Deductible, in cents
is_declined boolean false none If true, this coverage item was declined

Enumerated Values

Property Value
name DWELLING
name OTHER_STRUCTURES
name PERSONAL_PROPERTY
name LOSS_OF_USE
name PERSONAL_LIABILITY
name REPLACEMENT_COST_FULL_VALUE
name REPLACEMENT_COST_DWELLING
name REPLACEMENT_COST_CONTENTS
name GUEST_MEDICAL_PROTECTION
name MEDICAL_PAYMENTS
name BUILDING_CODES
name WIND_HAIL
name HURRICANE
name ESCAPE_OF_WATER
name ADDITIONAL_LIVING_EXPENSES
friendly_name Dwelling
friendly_name Other Structures
friendly_name Personal Property
friendly_name Loss of Use
friendly_name Personal Liability
friendly_name Special Personal Property
friendly_name Full Value Replacement Cost
friendly_name Dwelling Replacement Cost
friendly_name Contents Replacement Cost
friendly_name Guest Medical Protection
friendly_name Medical Payments
friendly_name Building Codes
friendly_name Wind/Hail
friendly_name Hurricane
friendly_name Escape of Water
friendly_name Additional Living Expenses

Address

{
  "address_id": "a32b0e3d-a5f5-48d8-a572-6ae561815055",
  "full_address": "609 Market St, San Francisco, CA, 94105, United States",
  "number": "609",
  "prefix": "string",
  "street": "Market",
  "type": "St",
  "suffix": "string",
  "city": "San Francisco",
  "state": "CA",
  "sec_unit_type": "string",
  "sec_unit_num": "string",
  "zip": "94105",
  "country": "US"
}

Properties

Name Type Required Restrictions Description
address_id string(uuid) false none none
full_address string false none One-line address for convenience
number string false none House or street number of Address
prefix string false none Directional prefix for street, such as N, NE, E, etc
street string false none Name of the street without directional or type qualifier
type string false none Abbreviated street type, eg. Rd, St, Ave, etc
suffix string false none Directional suffix for the street, as above
city string false none City of Address
state string false none State of Address
sec_unit_type string false none the type of unit
sec_unit_num string false none the number of the unit (may not be numeric)
zip string false none Zipcode of Address
country string false none Country of Address