Trellis Connect API v1.2.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.

Streamline insurance quotes by fetching information from existing insurers / institutions

Looking for our Widget SDK Docs? Find them here: https://github.com/trellisconnect/js-sdk-docs

There are two ways to authenticate with the Trellis API endpoints:

1. SecretKeyAuth: To be used from private backend servers ONLY. Pass the X-API-Client-Id and X-API-Secret-Key in the headers for authentication.
2. TemporaryAccessKeyAuthForConnectionId: To be used from client pages. Pass the X-API-Client-Id and X-API-Temporary-Access-Key in the headers for authentication. Note that temporary access keys are valid only for a limited time and are intended to be used by the client's browser in the workflow after creating a connection. You can get the temporaryAccessKey from the onSuccess handler from the Trellis Widget SDK.

The basic flow of a Trellis integration is as follows

1. Get your Client ID and Secret Key from your point of contact at Trellis.
2. Get a Trellis Connection ID from the Trellis Widget (passed in the onSuccess callback).
3. Retrieve policy information with the GET /policies endpoint documented below in /connection.

Previous API Versions

• Trellis Connect API v1.1.0

Version Changelog

v1.2.0

• New Improved polling experience for /account/{connectionId}/policies while waiting for policies to be available.
• Removed `/account/{connectionId}` endpoint in favor of new polling method.

v1.1.0

• Initial production API.

Base URLs:

• https://api.trellisconnect.com/trellis/connect/1.2.0

Email: Support License: Apache 2.0

Authentication

• API Key (ClientIdKeyAuth)

  • Parameter Name: X-API-Client-Id, in: header.

• API Key (SecretKeyAuth)

  • Parameter Name: X-API-Secret-Key, in: header.

• API Key (TemporaryAccessKeyAuthForConnectionId)

  • Parameter Name: X-API-Temporary-Access-Key, in: header.

Connections

/account/{connectionId}/policies

Code samples

# You can also use wget
curl -X GET https://api.trellisconnect.com/trellis/connect/1.2.0/account/{connectionId}/policies \
  -H 'Accept: application/json' \
  -H 'X-API-USE-CASE: FUTURE_POLICY' \
  -H 'X-API-Client-Id: API_KEY' \
  -H 'X-API-Secret-Key: API_KEY'

GET https://api.trellisconnect.com/trellis/connect/1.2.0/account/{connectionId}/policies HTTP/1.1
Host: api.trellisconnect.com
Accept: application/json
X-API-USE-CASE: FUTURE_POLICY

const headers = {
  'Accept':'application/json',
  'X-API-USE-CASE':'FUTURE_POLICY',
  'X-API-Client-Id':'API_KEY',
  'X-API-Secret-Key':'API_KEY'
};

fetch('https://api.trellisconnect.com/trellis/connect/1.2.0/account/{connectionId}/policies',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'X-API-USE-CASE' => 'FUTURE_POLICY',
  'X-API-Client-Id' => 'API_KEY',
  'X-API-Secret-Key' => 'API_KEY'
}

result = RestClient.get 'https://api.trellisconnect.com/trellis/connect/1.2.0/account/{connectionId}/policies',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'X-API-USE-CASE': 'FUTURE_POLICY',
  'X-API-Client-Id': 'API_KEY',
  'X-API-Secret-Key': 'API_KEY'
}

r = requests.get('https://api.trellisconnect.com/trellis/connect/1.2.0/account/{connectionId}/policies', headers = headers)

print(r.json())

 'application/json',
    'X-API-USE-CASE' => 'FUTURE_POLICY',
    'X-API-Client-Id' => 'API_KEY',
    'X-API-Secret-Key' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.trellisconnect.com/trellis/connect/1.2.0/account/{connectionId}/policies', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.trellisconnect.com/trellis/connect/1.2.0/account/{connectionId}/policies");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "X-API-USE-CASE": []string{"FUTURE_POLICY"},
        "X-API-Client-Id": []string{"API_KEY"},
        "X-API-Secret-Key": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.trellisconnect.com/trellis/connect/1.2.0/account/{connectionId}/policies", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /account/{connectionId}/policies

Return insurance policies associated with this connection. Requires the X-API-Client-Id and either the X-API-Secret-Key header OR the X-Temporary-Access-Key header. This endpoint should be called by your application server if you are using your API Secret Key for authentication because that is not safe to share with users' web browsers.
NOTE: This endpoint should be polled and may take up to 5 minutes to return policy information. Most policies will be returned much sooner.

Parameters

Enumerated Values

Example responses

200 Response

{
  "status": "READY",
  "issuerId": "geico",
  "issuerName": "GEICO",
  "policies": [
    {
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "issuer": "geico",
      "policyNumber": "5232-11-255-22",
      "policyType": "PERSONAL_AUTO",
      "policyHolder": {
        "name": {
          "firstName": "John,",
          "middleName": "K,",
          "lastName": "Smith"
        },
        "address": {
          "number": 123,
          "street": "Main",
          "type": "St",
          "sec_unit_type": "Apt",
          "sec_unit_num": "1A",
          "city": "San Francisco",
          "state": "CA",
          "zip": 94111,
          "plus4": 2233,
          "suffix": "Ave",
          "prefix": "W"
        },
        "phoneNumber": "(123) 456-2233",
        "email": "johnksmith@gmail.com",
        "isHomeOwner": true,
        "isMilitary": true,
        "residenceStatus": "OwnSingleFamily",
        "tenureInYears": 2
      },
      "policyTermMonths": 6,
      "paymentScheduleMonths": 1,
      "numberOfPayments": 6,
      "issueDate": "2019-01-01",
      "renewalDate": "2019-07-01",
      "effectiveDate": "2019-01-01",
      "expirationDate": "2019-07-01",
      "active": true,
      "hasAtFaultAccident": "yes",
      "hasAtFaultClaim": "yes",
      "canceledDate": "2019-04-01",
      "dateRetrieved": "2019-02-01",
      "premiumCents": 94200,
      "operators": [
        {
          "name": {
            "firstName": "John",
            "middleName": "K",
            "lastName": "Smith"
          },
          "gender": "female",
          "maritalStatus": "married",
          "occupation": "Electrical Engineer (Degreed)",
          "education": "associates",
          "rawEducation": "Bachelor's Degree",
          "relationship": "Named Insured",
          "rawRelationship": "Married",
          "birthday": "1985-08-29",
          "birthdayRange": {
            "start": "1988-01-01",
            "end": "1988-12-31"
          },
          "ageLicensed": 16,
          "ageLicensedInternationally": 16,
          "isPrimary": true,
          "driversLicenseState": "MA",
          "driversLicenseStatus": "ValidUSLicense",
          "driversLicenseNumber": "S22229999",
          "hasFullDriversLicenseNumber": true,
          "email": "johnksmith@gmail.com",
          "experienceInYears": 8,
          "addressRaw": "123 Main St San Francisco CA 94129",
          "address": {
            "number": 123,
            "street": "Main",
            "type": "St",
            "sec_unit_type": "Apt",
            "sec_unit_num": "1A",
            "city": "San Francisco",
            "state": "CA",
            "zip": 94111,
            "plus4": 2233,
            "suffix": "Ave",
            "prefix": "W"
          },
          "financialResponsibilityCases": [
            {
              "type": "SR-21",
              "state": "CA",
              "caseNumber": 331476039
            }
          ]
        }
      ],
      "vehicles": [
        {
          "year": 2015,
          "inStorage": true,
          "isRideSharing": true,
          "vin": "WBA2F7C55FVX55555",
          "make": "BMW",
          "model": "228XI 2D 4X4",
          "type": null,
          "annualMileage": 5000,
          "driver": {
            "firstName": "John",
            "middleName": "K",
            "lastName": "Smith"
          },
          "use": "commute",
          "garagingLocationRaw": "123 Main St San Francisco CA 94129",
          "garagingLocation": {
            "number": 123,
            "street": "Main",
            "type": "St",
            "sec_unit_type": "Apt",
            "sec_unit_num": "1A",
            "city": "San Francisco",
            "state": "CA",
            "zip": 94111,
            "plus4": 2233,
            "suffix": "Ave",
            "prefix": "W"
          },
          "discounts": [
            {
              "name": "Multi-Product",
              "discountCents": 5000,
              "rawName": "Bundle"
            }
          ],
          "discountTotalCents": 5000,
          "purchaseDate": "1999-04-12",
          "antiTheftDevices": true,
          "bodyStyle": "4 Door Sedan",
          "ownershipStatus": "owned",
          "lienHolder": "TD Auto Finance",
          "lienHolderAddress": {
            "number": 123,
            "street": "Main",
            "type": "St",
            "sec_unit_type": "Apt",
            "sec_unit_num": "1A",
            "city": "San Francisco",
            "state": "CA",
            "zip": 94111,
            "plus4": 2233,
            "suffix": "Ave",
            "prefix": "W"
          },
          "lienHolderAddressRaw": "123 Main Street New York NY 10011",
          "premiumCents": 12344,
          "coverages": [
            {
              "name": "Bodily Injury Liability",
              "premiumCents": 7400,
              "isDeclined": false,
              "perPersonLimitCents": 20000,
              "perAccidentLimitCents": 40000,
              "deductibleCents": 1000,
              "glassDeductibleCents": 500,
              "perDayLimitCents": 40000,
              "perMonthLimitCents": 45000,
              "perWeekLimitCents": 11500
            }
          ]
        }
      ],
      "discounts": [
        {
          "name": "Multi-Product",
          "discountCents": 5000,
          "rawName": "Bundle"
        }
      ],
      "documents": [
        {
          "url": "https://storage.googleapis.com/...",
          "urlExpiration": "2020-09-24",
          "type": "DEC_PAGE"
        }
      ],
      "incidents": [
        {
          "id": "291e57c2-48ab-4b72-ad4e-b5284d78c32e_0",
          "driverNameRaw": "Jane Doe",
          "driver": 0,
          "descriptionRaw": null,
          "date": "2019-01-01",
          "state": "CA",
          "atFault": "yes",
          "paidAmountCents": 229670,
          "liabilityMedicalPaidAmountCents": 10201,
          "type": "CLAIM",
          "typeDetails": "Hit an animal"
        }
      ]
    },
    {
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0852",
      "issuer": "allstate",
      "policyNumber": "5232-11-255-22",
      "policyType": "HOMEOWNERS",
      "policyHolder": {
        "name": {
          "firstName": "John,",
          "middleName": "K,",
          "lastName": "Smith"
        },
        "address": {
          "number": 123,
          "street": "Main",
          "type": "St",
          "sec_unit_type": "Apt",
          "sec_unit_num": "1A",
          "city": "San Francisco",
          "state": "CA",
          "zip": 94111,
          "plus4": 2233,
          "suffix": "Ave",
          "prefix": "W"
        },
        "phoneNumber": "(123) 456-2233",
        "email": "johnksmith@gmail.com",
        "isHomeOwner": true,
        "isMilitary": true,
        "residenceStatus": "OwnSingleFamily",
        "tenureInYears": 2
      },
      "policyTermMonths": 12,
      "paymentScheduleMonths": 1,
      "numberOfPayments": 12,
      "issueDate": "2019-01-01",
      "renewalDate": "2019-07-01",
      "effectiveDate": "2019-01-01",
      "expirationDate": "2019-07-01",
      "active": true,
      "canceledDate": "2019-04-01",
      "dateRetrieved": "2019-02-01",
      "premiumCents": 94200,
      "discounts": [
        {
          "name": "Multi-Product",
          "discountCents": 5000,
          "rawName": "Bundle"
        }
      ],
      "property": {
        "purchaseDate": "1990-10-12",
        "squareFeet": 2300,
        "usage": "Primary Home",
        "numberOfStories": 2,
        "dwellingType": "Single Family Home",
        "yearBuilt": 1980,
        "constructionType": "Frame",
        "foundationType": "Slab",
        "composition": [
          {
            "type": "Roof",
            "shape": "Flat",
            "descriptionRaw": "string",
            "materials": [
              "Rubber",
              "Wood"
            ],
            "percentage": 75
          }
        ],
        "numberOfKitchens": 1,
        "numberOfBathrooms": 3,
        "numberOfFireplaces": 1,
        "garages": [
          {
            "type": "Attached",
            "capacity": 2
          }
        ],
        "distanceToFireHydrantInFeet": 100,
        "distanceToFireDepartmentInMiles": 2,
        "features": {
          "hasBurglarAlarm": true,
          "hasFireAlarm": true,
          "hasSupplementalHeating": false
        },
        "addressRaw": "string",
        "ageOfRoofInYears": 4,
        "address": {
          "number": 123,
          "street": "Main",
          "type": "St",
          "sec_unit_type": "Apt",
          "sec_unit_num": "1A",
          "city": "San Francisco",
          "state": "CA",
          "zip": 94111,
          "plus4": 2233,
          "suffix": "Ave",
          "prefix": "W"
        }
      },
      "coverages": [
        {
          "name": "Personal Property",
          "rawName": "Personal Property",
          "perOccurrenceLimitCents": 10000000,
          "perPersonLimitCents": 50000000,
          "maxMonthsLimit": 6,
          "premiumCents": 50000,
          "isDeclined": false,
          "deductibleCents": 50000,
          "hurricaneDeductibleCents": 50000,
          "windstormDeductibleCents": 50000,
          "earthquakeDeductibleCents": 50000
        }
      ],
      "householdMembers": [
        {
          "name": {
            "firstName": "John",
            "middleName": "K",
            "lastName": "Smith"
          },
          "gender": "female",
          "relationship": "Named Insured",
          "birthday": "1985-08-29",
          "birthdayRange": {
            "start": "1988-01-01",
            "end": "1988-12-31"
          },
          "occupation": "Engineer"
        }
      ],
      "mortgages": [
        {
          "type": "First Mortgage",
          "loanNumber": "000-393323-33",
          "lienHolder": "Quicken Loans",
          "lienHolderAddress": {
            "number": 123,
            "street": "Main",
            "type": "St",
            "sec_unit_type": "Apt",
            "sec_unit_num": "1A",
            "city": "San Francisco",
            "state": "CA",
            "zip": 94111,
            "plus4": 2233,
            "suffix": "Ave",
            "prefix": "W"
          },
          "lienHolderAddressRaw": "string"
        }
      ],
      "documents": [
        {
          "url": "https://storage.googleapis.com/...",
          "urlExpiration": "2020-09-24",
          "type": "DEC_PAGE"
        }
      ]
    }
  ]
}

202 Response

{
  "status": "NOT_READY",
  "issuerId": "geico",
  "issuerName": "GEICO",
  "message": "POLICIES NOT READY YET"
}

401 Response

"Unauthorized."

403 Response

"insufficient access to retrieve policies for requested account"

404 Response

{
  "status": "READY",
  "issuerId": "geico",
  "issuerName": "GEICO",
  "message": "NO_POLICIES_FOUND",
  "error": {
    "errorType": "NO_POLICIES_FOUND"
  }
}

Responses

Response Headers

Schemas

Address

{
  "number": "123",
  "street": "Main",
  "type": "St",
  "sec_unit_type": "Apt",
  "sec_unit_num": "1A",
  "city": "San Francisco",
  "state": "CA",
  "zip": "94111",
  "plus4": "2233",
  "suffix": "Ave",
  "prefix": "W"
}

Properties

PersonalAutoCoverage

{
  "name": "Bodily Injury Liability",
  "premiumCents": 7400,
  "isDeclined": false,
  "perPersonLimitCents": 20000,
  "perAccidentLimitCents": 40000,
  "deductibleCents": 1000,
  "glassDeductibleCents": 500,
  "perDayLimitCents": 40000,
  "perMonthLimitCents": 45000,
  "perWeekLimitCents": 11500
}

Represents a single type of coverage on a policy. A missing/declined coverage may show up in this list as declined ("isDeclined = true") or it may be omitted entirely. When a coverage amount is listed as UNLIMITED, a value of 999999999999999 ($9,999,999,999,999.99) will be sent instead. Here is a mapping of coverage type to which amounts may appear on an instance of that coverage type:

Accidental Death and Dismemberment: ['perAccidentLimitCents', 'perPersonLimitCents']

Additional Personal Injury Protection: ['perPersonLimitCents', 'perAccidentLimitCents']

Bodily Injury Liability: ['perPersonLimitCents', 'perAccidentLimitCents']

Car Rental & Travel Expenses: ['perDayLimitCents', 'perAccidentLimitCents']

Collision Deductible Waiver: []

Collision: ['deductibleCents']

Comprehensive Glass: ['deductibleCents']

Comprehensive: ['deductibleCents', 'glassDeductibleCents']

Custom Parts and Equipment: ['perAccidentLimitCents']

Disability: []

Emergency Road Service: ['perAccidentLimitCents']

Extended Medical Benefits: []

Extended Medical Expense: ['perPersonLimitCents']

Full Vehicle Replacement: []

Funeral Benefits: ['perAccidentLimitCents', 'perPersonLimitCents']

Guest Personal Injury Protection: []

Law Enforcement Fee: []

Limited Property Damage: ['perAccidentLimitCents']

Loan/Lease Payoff: []

Mechanical Breakdown: ['deductibleCents']

Medical Payments: ['perPersonLimitCents']

Necessary Expenses: ['perDayLimitCents', 'perAccidentLimitCents']

Optional Basic Economic Loss: ['perPersonLimitCents', 'perAccidentLimitCents']

Optional Bodily Injury to Others: ['perPersonLimitCents', 'perAccidentLimitCents']

Permissive User: []

Personal Belongings: ['perAccidentLimitCents', 'deductibleCents']

Personal Injury Protection: ['perPersonLimitCents', 'deductibleCents']

Property Damage Liability: ['perAccidentLimitCents']

Property Protection Insurance: ['perAccidentLimitCents']

Rideshare Gap: []

Road Trip Accident Accomodations: ['perAccidentLimitCents']

Supplemental Spousal Liability: []

Supplementary Uninsured / Underinsured Motorist: ['perPersonLimitCents', 'perAccidentLimitCents']

Underinsured Motorist Bodily Injury: ['perPersonLimitCents', 'perAccidentLimitCents']

Underinsured Motorist Property Damage: ['perAccidentLimitCents', 'deductibleCents']

Uninsured / Underinsured Motorist Bodily Injury: ['perPersonLimitCents', 'perAccidentLimitCents']

Uninsured / Underinsured Motorist Property Damage: ['perAccidentLimitCents', 'deductibleCents']

Uninsured Motorist Bodily Injury: ['perPersonLimitCents', 'perAccidentLimitCents']

Uninsured Motorist Property Damage: ['perAccidentLimitCents', 'deductibleCents']

Vanishing Deductible: ['deductibleCents']

Vehicle Liability: ['perAccidentLimitCents']

Work Loss Benefit: ['perMonthLimitCents', 'perWeekLimitCents']

Properties

Enumerated Values

PropertyCoverage

{
  "name": "Personal Property",
  "rawName": "Personal Property",
  "perOccurrenceLimitCents": 10000000,
  "perPersonLimitCents": 50000000,
  "maxMonthsLimit": 6,
  "premiumCents": 50000,
  "isDeclined": false,
  "deductibleCents": 50000,
  "hurricaneDeductibleCents": 50000,
  "windstormDeductibleCents": 50000,
  "earthquakeDeductibleCents": 50000
}

Coverages applied to a HOMEOWNERS or RENTERS policy

Properties

Enumerated Values

CommonDiscount

{
  "name": "Multi-Product",
  "discountCents": 5000,
  "rawName": "Bundle"
}

Discounts applied to ANY policy type

Properties

Enumerated Values

PersonalAutoDiscount

{
  "name": "Good Driver",
  "discountCents": 5000,
  "rawName": "Good Driver Discount"
}

Discounts applied to a PERSONAL_AUTO policy

Properties

Enumerated Values

PropertyDiscount

{
  "name": "Fire Alarms",
  "discountCents": 10000,
  "rawName": "Fire Detection"
}

Discounts applied to a HOMEOWNERS or RENTERS policy

Properties

Enumerated Values

Document

{
  "url": "https://storage.googleapis.com/...",
  "urlExpiration": "2020-09-24",
  "type": "DEC_PAGE"
}

Properties

Enumerated Values

ErrorDetails

{
  "errorType": "ACCOUNT_NOT_FOUND",
  "errorCode": "TECHNICAL_DIFFICULTIES",
  "errorMessage": "The issuer or Trellis was experiencing technical difficulties."
}

Contains additional information about an HTTP error, if any.

Properties

Enumerated Values

HouseholdMember

{
  "name": {
    "firstName": "John",
    "middleName": "K",
    "lastName": "Smith"
  },
  "gender": "female",
  "relationship": "Named Insured",
  "birthday": "1985-08-29",
  "birthdayRange": {
    "start": "1988-01-01",
    "end": "1988-12-31"
  },
  "occupation": "Engineer"
}

The household members within the insured property. Only applicable for HOMEOWNERS and RENTERS policy types

Properties

Enumerated Values

Incident

{
  "id": "291e57c2-48ab-4b72-ad4e-b5284d78c32e_0",
  "driverNameRaw": "Jane Doe",
  "driver": 0,
  "descriptionRaw": null,
  "date": "2019-01-01",
  "state": "CA",
  "atFault": "yes",
  "paidAmountCents": 229670,
  "liabilityMedicalPaidAmountCents": 10201,
  "type": "CLAIM",
  "typeDetails": "Hit an animal"
}

Auto incidents involving the policyholder. Only applicable to PERSONAL_AUTO policies

Properties

Enumerated Values

Mortgage

{
  "type": "First Mortgage",
  "loanNumber": "000-393323-33",
  "lienHolder": "Quicken Loans",
  "lienHolderAddress": {
    "number": "123",
    "street": "Main",
    "type": "St",
    "sec_unit_type": "Apt",
    "sec_unit_num": "1A",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94111",
    "plus4": "2233",
    "suffix": "Ave",
    "prefix": "W"
  },
  "lienHolderAddressRaw": "string"
}

The mortgages on the insured property. Only applicable for HOMEOWNERS and RENTERS policy types

Properties

Name

{
  "firstName": "John",
  "middleName": "K",
  "lastName": "Smith"
}

Properties

FinancialResponsibilityCase

{
  "type": "SR-21",
  "state": "CA",
  "caseNumber": 331476039
}

Details of financial responsibility case

Properties

Enumerated Values

Operator

{
  "name": {
    "firstName": "John",
    "middleName": "K",
    "lastName": "Smith"
  },
  "gender": "female",
  "maritalStatus": "married",
  "occupation": "Electrical Engineer (Degreed)",
  "education": "associates",
  "rawEducation": "Bachelor's Degree",
  "relationship": "Named Insured",
  "rawRelationship": "Married",
  "birthday": "1985-08-29",
  "birthdayRange": {
    "start": "1988-01-01",
    "end": "1988-12-31"
  },
  "ageLicensed": 16,
  "ageLicensedInternationally": 16,
  "isPrimary": true,
  "driversLicenseState": "MA",
  "driversLicenseStatus": "ValidUSLicense",
  "driversLicenseNumber": "S22229999",
  "hasFullDriversLicenseNumber": true,
  "email": "johnksmith@gmail.com",
  "experienceInYears": 8,
  "addressRaw": "123 Main St, San Francisco CA 94129",
  "address": {
    "number": "123",
    "street": "Main",
    "type": "St",
    "sec_unit_type": "Apt",
    "sec_unit_num": "1A",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94111",
    "plus4": "2233",
    "suffix": "Ave",
    "prefix": "W"
  },
  "financialResponsibilityCases": [
    {
      "type": "SR-21",
      "state": "CA",
      "caseNumber": 331476039
    }
  ]
}

Details for the operators within a PERSONAL_AUTO policy

Properties

Enumerated Values

Property

{
  "purchaseDate": "1990-10-12",
  "squareFeet": 2300,
  "usage": "Primary Home",
  "numberOfStories": 2,
  "dwellingType": "Single Family Home",
  "yearBuilt": 1980,
  "constructionType": "Frame",
  "foundationType": "Slab",
  "composition": [
    {
      "type": "Roof",
      "shape": "Flat",
      "descriptionRaw": "string",
      "materials": [
        "Rubber",
        "Wood"
      ],
      "percentage": 75
    }
  ],
  "numberOfKitchens": 1,
  "numberOfBathrooms": 3,
  "numberOfFireplaces": 1,
  "garages": [
    {
      "type": "Attached",
      "capacity": 2
    }
  ],
  "distanceToFireHydrantInFeet": 100,
  "distanceToFireDepartmentInMiles": 2,
  "features": {
    "hasBurglarAlarm": true,
    "hasFireAlarm": true,
    "hasSupplementalHeating": false
  },
  "addressRaw": "string",
  "ageOfRoofInYears": 4,
  "address": {
    "number": "123",
    "street": "Main",
    "type": "St",
    "sec_unit_type": "Apt",
    "sec_unit_num": "1A",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94111",
    "plus4": "2233",
    "suffix": "Ave",
    "prefix": "W"
  }
}

Details for the insured property. Only applicable for HOMEOWNERS and RENTERS policy types

Properties

Enumerated Values

Policy

{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "issuer": "geico",
  "policyNumber": "5232-11-255-22",
  "policyType": "PERSONAL_AUTO",
  "policyHolder": {
    "name": {
      "firstName": "John",
      "middleName": "K",
      "lastName": "Smith"
    },
    "address": {
      "number": "123",
      "street": "Main",
      "type": "St",
      "sec_unit_type": "Apt",
      "sec_unit_num": "1A",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94111",
      "plus4": "2233",
      "suffix": "Ave",
      "prefix": "W"
    },
    "phoneNumber": "(123) 456-2233",
    "email": "johnksmith@gmail.com",
    "isHomeOwner": true,
    "isMilitary": true,
    "residenceStatus": "OwnSingleFamily",
    "tenureInYears": 2
  },
  "policyTermMonths": 6,
  "paymentScheduleMonths": 1,
  "numberOfPayments": 1,
  "issueDate": "2019-01-01",
  "renewalDate": "2019-07-01",
  "effectiveDate": "2019-01-01",
  "expirationDate": "2019-07-01",
  "active": true,
  "hasAtFaultAccident": "yes",
  "hasAtFaultClaim": "yes",
  "canceledDate": "2019-04-01",
  "dateRetrieved": "2019-02-01",
  "premiumCents": 94200,
  "operators": [
    {
      "name": {
        "firstName": "John",
        "middleName": "K",
        "lastName": "Smith"
      },
      "gender": "female",
      "maritalStatus": "married",
      "occupation": "Electrical Engineer (Degreed)",
      "education": "associates",
      "rawEducation": "Bachelor's Degree",
      "relationship": "Named Insured",
      "rawRelationship": "Married",
      "birthday": "1985-08-29",
      "birthdayRange": {
        "start": "1988-01-01",
        "end": "1988-12-31"
      },
      "ageLicensed": 16,
      "ageLicensedInternationally": 16,
      "isPrimary": true,
      "driversLicenseState": "MA",
      "driversLicenseStatus": "ValidUSLicense",
      "driversLicenseNumber": "S22229999",
      "hasFullDriversLicenseNumber": true,
      "email": "johnksmith@gmail.com",
      "experienceInYears": 8,
      "addressRaw": "123 Main St, San Francisco CA 94129",
      "address": {
        "number": "123",
        "street": "Main",
        "type": "St",
        "sec_unit_type": "Apt",
        "sec_unit_num": "1A",
        "city": "San Francisco",
        "state": "CA",
        "zip": "94111",
        "plus4": "2233",
        "suffix": "Ave",
        "prefix": "W"
      },
      "financialResponsibilityCases": [
        {
          "type": "SR-21",
          "state": "CA",
          "caseNumber": 331476039
        }
      ]
    }
  ],
  "vehicles": [
    {
      "year": "2015",
      "inStorage": true,
      "isRideSharing": true,
      "vin": "WBA2F7C55FVX55555",
      "make": "BMW",
      "model": "228XI 2D 4X4",
      "type": null,
      "annualMileage": 5000,
      "driver": {
        "firstName": "John",
        "middleName": "K",
        "lastName": "Smith"
      },
      "use": "commute",
      "garagingLocationRaw": "123 Main St, San Francisco CA 94129",
      "garagingLocation": {
        "number": "123",
        "street": "Main",
        "type": "St",
        "sec_unit_type": "Apt",
        "sec_unit_num": "1A",
        "city": "San Francisco",
        "state": "CA",
        "zip": "94111",
        "plus4": "2233",
        "suffix": "Ave",
        "prefix": "W"
      },
      "discounts": [
        {
          "name": "Multi-Product",
          "discountCents": 5000,
          "rawName": "Bundle"
        }
      ],
      "discountTotalCents": 5000,
      "purchaseDate": "1999-04-12",
      "antiTheftDevices": true,
      "bodyStyle": "4 Door Sedan",
      "ownershipStatus": "owned",
      "lienHolder": "TD Auto Finance",
      "lienHolderAddress": {
        "number": "123",
        "street": "Main",
        "type": "St",
        "sec_unit_type": "Apt",
        "sec_unit_num": "1A",
        "city": "San Francisco",
        "state": "CA",
        "zip": "94111",
        "plus4": "2233",
        "suffix": "Ave",
        "prefix": "W"
      },
      "lienHolderAddressRaw": "123 Main Street, New York NY 10011",
      "premiumCents": 12344,
      "coverages": [
        {
          "name": "Bodily Injury Liability",
          "premiumCents": 7400,
          "isDeclined": false,
          "perPersonLimitCents": 20000,
          "perAccidentLimitCents": 40000,
          "deductibleCents": 1000,
          "glassDeductibleCents": 500,
          "perDayLimitCents": 40000,
          "perMonthLimitCents": 45000,
          "perWeekLimitCents": 11500
        }
      ]
    }
  ],
  "discounts": [
    {
      "name": "Multi-Product",
      "discountCents": 5000,
      "rawName": "Bundle"
    }
  ],
  "property": {
    "purchaseDate": "1990-10-12",
    "squareFeet": 2300,
    "usage": "Primary Home",
    "numberOfStories": 2,
    "dwellingType": "Single Family Home",
    "yearBuilt": 1980,
    "constructionType": "Frame",
    "foundationType": "Slab",
    "composition": [
      {
        "type": "Roof",
        "shape": "Flat",
        "descriptionRaw": "string",
        "materials": [
          "Rubber",
          "Wood"
        ],
        "percentage": 75
      }
    ],
    "numberOfKitchens": 1,
    "numberOfBathrooms": 3,
    "numberOfFireplaces": 1,
    "garages": [
      {
        "type": "Attached",
        "capacity": 2
      }
    ],
    "distanceToFireHydrantInFeet": 100,
    "distanceToFireDepartmentInMiles": 2,
    "features": {
      "hasBurglarAlarm": true,
      "hasFireAlarm": true,
      "hasSupplementalHeating": false
    },
    "addressRaw": "string",
    "ageOfRoofInYears": 4,
    "address": {
      "number": "123",
      "street": "Main",
      "type": "St",
      "sec_unit_type": "Apt",
      "sec_unit_num": "1A",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94111",
      "plus4": "2233",
      "suffix": "Ave",
      "prefix": "W"
    }
  },
  "coverages": [
    {
      "name": "Personal Property",
      "rawName": "Personal Property",
      "perOccurrenceLimitCents": 10000000,
      "perPersonLimitCents": 50000000,
      "maxMonthsLimit": 6,
      "premiumCents": 50000,
      "isDeclined": false,
      "deductibleCents": 50000,
      "hurricaneDeductibleCents": 50000,
      "windstormDeductibleCents": 50000,
      "earthquakeDeductibleCents": 50000
    }
  ],
  "householdMembers": [
    {
      "name": {
        "firstName": "John",
        "middleName": "K",
        "lastName": "Smith"
      },
      "gender": "female",
      "relationship": "Named Insured",
      "birthday": "1985-08-29",
      "birthdayRange": {
        "start": "1988-01-01",
        "end": "1988-12-31"
      },
      "occupation": "Engineer"
    }
  ],
  "mortgages": [
    {
      "type": "First Mortgage",
      "loanNumber": "000-393323-33",
      "lienHolder": "Quicken Loans",
      "lienHolderAddress": {
        "number": "123",
        "street": "Main",
        "type": "St",
        "sec_unit_type": "Apt",
        "sec_unit_num": "1A",
        "city": "San Francisco",
        "state": "CA",
        "zip": "94111",
        "plus4": "2233",
        "suffix": "Ave",
        "prefix": "W"
      },
      "lienHolderAddressRaw": "string"
    }
  ],
  "documents": [
    {
      "url": "https://storage.googleapis.com/...",
      "urlExpiration": "2020-09-24",
      "type": "DEC_PAGE"
    }
  ],
  "incidents": [
    {
      "id": "291e57c2-48ab-4b72-ad4e-b5284d78c32e_0",
      "driverNameRaw": "Jane Doe",
      "driver": 0,
      "descriptionRaw": null,
      "date": "2019-01-01",
      "state": "CA",
      "atFault": "yes",
      "paidAmountCents": 229670,
      "liabilityMedicalPaidAmountCents": 10201,
      "type": "CLAIM",
      "typeDetails": "Hit an animal"
    }
  ]
}

Properties

anyOf

or

or

continued

Enumerated Values

Vehicle

{
  "year": "2015",
  "inStorage": true,
  "isRideSharing": true,
  "vin": "WBA2F7C55FVX55555",
  "make": "BMW",
  "model": "228XI 2D 4X4",
  "type": null,
  "annualMileage": 5000,
  "driver": {
    "firstName": "John",
    "middleName": "K",
    "lastName": "Smith"
  },
  "use": "commute",
  "garagingLocationRaw": "123 Main St, San Francisco CA 94129",
  "garagingLocation": {
    "number": "123",
    "street": "Main",
    "type": "St",
    "sec_unit_type": "Apt",
    "sec_unit_num": "1A",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94111",
    "plus4": "2233",
    "suffix": "Ave",
    "prefix": "W"
  },
  "discounts": [
    {
      "name": "Multi-Product",
      "discountCents": 5000,
      "rawName": "Bundle"
    }
  ],
  "discountTotalCents": 5000,
  "purchaseDate": "1999-04-12",
  "antiTheftDevices": true,
  "bodyStyle": "4 Door Sedan",
  "ownershipStatus": "owned",
  "lienHolder": "TD Auto Finance",
  "lienHolderAddress": {
    "number": "123",
    "street": "Main",
    "type": "St",
    "sec_unit_type": "Apt",
    "sec_unit_num": "1A",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94111",
    "plus4": "2233",
    "suffix": "Ave",
    "prefix": "W"
  },
  "lienHolderAddressRaw": "123 Main Street, New York NY 10011",
  "premiumCents": 12344,
  "coverages": [
    {
      "name": "Bodily Injury Liability",
      "premiumCents": 7400,
      "isDeclined": false,
      "perPersonLimitCents": 20000,
      "perAccidentLimitCents": 40000,
      "deductibleCents": 1000,
      "glassDeductibleCents": 500,
      "perDayLimitCents": 40000,
      "perMonthLimitCents": 45000,
      "perWeekLimitCents": 11500
    }
  ]
}

Details for the vehicles within a PERSONAL_AUTO policy

Properties

anyOf

or

continued

Enumerated Values

SuccessfulResponse

{
  "status": "READY",
  "issuerId": "geico",
  "issuerName": "GEICO",
  "policies": [
    {
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "issuer": "geico",
      "policyNumber": "5232-11-255-22",
      "policyType": "PERSONAL_AUTO",
      "policyHolder": {
        "name": {
          "firstName": "John,",
          "middleName": "K,",
          "lastName": "Smith"
        },
        "address": {
          "number": 123,
          "street": "Main",
          "type": "St",
          "sec_unit_type": "Apt",
          "sec_unit_num": "1A",
          "city": "San Francisco",
          "state": "CA",
          "zip": 94111,
          "plus4": 2233,
          "suffix": "Ave",
          "prefix": "W"
        },
        "phoneNumber": "(123) 456-2233",
        "email": "johnksmith@gmail.com",
        "isHomeOwner": true,
        "isMilitary": true,
        "residenceStatus": "OwnSingleFamily",
        "tenureInYears": 2
      },
      "policyTermMonths": 6,
      "paymentScheduleMonths": 1,
      "numberOfPayments": 6,
      "issueDate": "2019-01-01",
      "renewalDate": "2019-07-01",
      "effectiveDate": "2019-01-01",
      "expirationDate": "2019-07-01",
      "active": true,
      "hasAtFaultAccident": "yes",
      "hasAtFaultClaim": "yes",
      "canceledDate": "2019-04-01",
      "dateRetrieved": "2019-02-01",
      "premiumCents": 94200,
      "operators": [
        {
          "name": {
            "firstName": "John",
            "middleName": "K",
            "lastName": "Smith"
          },
          "gender": "female",
          "maritalStatus": "married",
          "occupation": "Electrical Engineer (Degreed)",
          "education": "associates",
          "rawEducation": "Bachelor's Degree",
          "relationship": "Named Insured",
          "rawRelationship": "Married",
          "birthday": "1985-08-29",
          "birthdayRange": {
            "start": "1988-01-01",
            "end": "1988-12-31"
          },
          "ageLicensed": 16,
          "ageLicensedInternationally": 16,
          "isPrimary": true,
          "driversLicenseState": "MA",
          "driversLicenseStatus": "ValidUSLicense",
          "driversLicenseNumber": "S22229999",
          "hasFullDriversLicenseNumber": true,
          "email": "johnksmith@gmail.com",
          "experienceInYears": 8,
          "addressRaw": "123 Main St San Francisco CA 94129",
          "address": {
            "number": 123,
            "street": "Main",
            "type": "St",
            "sec_unit_type": "Apt",
            "sec_unit_num": "1A",
            "city": "San Francisco",
            "state": "CA",
            "zip": 94111,
            "plus4": 2233,
            "suffix": "Ave",
            "prefix": "W"
          },
          "financialResponsibilityCases": [
            {
              "type": "SR-21",
              "state": "CA",
              "caseNumber": 331476039
            }
          ]
        }
      ],
      "vehicles": [
        {
          "year": 2015,
          "inStorage": true,
          "isRideSharing": true,
          "vin": "WBA2F7C55FVX55555",
          "make": "BMW",
          "model": "228XI 2D 4X4",
          "type": null,
          "annualMileage": 5000,
          "driver": {
            "firstName": "John",
            "middleName": "K",
            "lastName": "Smith"
          },
          "use": "commute",
          "garagingLocationRaw": "123 Main St San Francisco CA 94129",
          "garagingLocation": {
            "number": 123,
            "street": "Main",
            "type": "St",
            "sec_unit_type": "Apt",
            "sec_unit_num": "1A",
            "city": "San Francisco",
            "state": "CA",
            "zip": 94111,
            "plus4": 2233,
            "suffix": "Ave",
            "prefix": "W"
          },
          "discounts": [
            {
              "name": "Multi-Product",
              "discountCents": 5000,
              "rawName": "Bundle"
            }
          ],
          "discountTotalCents": 5000,
          "purchaseDate": "1999-04-12",
          "antiTheftDevices": true,
          "bodyStyle": "4 Door Sedan",
          "ownershipStatus": "owned",
          "lienHolder": "TD Auto Finance",
          "lienHolderAddress": {
            "number": 123,
            "street": "Main",
            "type": "St",
            "sec_unit_type": "Apt",
            "sec_unit_num": "1A",
            "city": "San Francisco",
            "state": "CA",
            "zip": 94111,
            "plus4": 2233,
            "suffix": "Ave",
            "prefix": "W"
          },
          "lienHolderAddressRaw": "123 Main Street New York NY 10011",
          "premiumCents": 12344,
          "coverages": [
            {
              "name": "Bodily Injury Liability",
              "premiumCents": 7400,
              "isDeclined": false,
              "perPersonLimitCents": 20000,
              "perAccidentLimitCents": 40000,
              "deductibleCents": 1000,
              "glassDeductibleCents": 500,
              "perDayLimitCents": 40000,
              "perMonthLimitCents": 45000,
              "perWeekLimitCents": 11500
            }
          ]
        }
      ],
      "discounts": [
        {
          "name": "Multi-Product",
          "discountCents": 5000,
          "rawName": "Bundle"
        }
      ],
      "documents": [
        {
          "url": "https://storage.googleapis.com/...",
          "urlExpiration": "2020-09-24",
          "type": "DEC_PAGE"
        }
      ],
      "incidents": [
        {
          "id": "291e57c2-48ab-4b72-ad4e-b5284d78c32e_0",
          "driverNameRaw": "Jane Doe",
          "driver": 0,
          "descriptionRaw": null,
          "date": "2019-01-01",
          "state": "CA",
          "atFault": "yes",
          "paidAmountCents": 229670,
          "liabilityMedicalPaidAmountCents": 10201,
          "type": "CLAIM",
          "typeDetails": "Hit an animal"
        }
      ]
    },
    {
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0852",
      "issuer": "allstate",
      "policyNumber": "5232-11-255-22",
      "policyType": "HOMEOWNERS",
      "policyHolder": {
        "name": {
          "firstName": "John,",
          "middleName": "K,",
          "lastName": "Smith"
        },
        "address": {
          "number": 123,
          "street": "Main",
          "type": "St",
          "sec_unit_type": "Apt",
          "sec_unit_num": "1A",
          "city": "San Francisco",
          "state": "CA",
          "zip": 94111,
          "plus4": 2233,
          "suffix": "Ave",
          "prefix": "W"
        },
        "phoneNumber": "(123) 456-2233",
        "email": "johnksmith@gmail.com",
        "isHomeOwner": true,
        "isMilitary": true,
        "residenceStatus": "OwnSingleFamily",
        "tenureInYears": 2
      },
      "policyTermMonths": 12,
      "paymentScheduleMonths": 1,
      "numberOfPayments": 12,
      "issueDate": "2019-01-01",
      "renewalDate": "2019-07-01",
      "effectiveDate": "2019-01-01",
      "expirationDate": "2019-07-01",
      "active": true,
      "canceledDate": "2019-04-01",
      "dateRetrieved": "2019-02-01",
      "premiumCents": 94200,
      "discounts": [
        {
          "name": "Multi-Product",
          "discountCents": 5000,
          "rawName": "Bundle"
        }
      ],
      "property": {
        "purchaseDate": "1990-10-12",
        "squareFeet": 2300,
        "usage": "Primary Home",
        "numberOfStories": 2,
        "dwellingType": "Single Family Home",
        "yearBuilt": 1980,
        "constructionType": "Frame",
        "foundationType": "Slab",
        "composition": [
          {
            "type": "Roof",
            "shape": "Flat",
            "descriptionRaw": "string",
            "materials": [
              "Rubber",
              "Wood"
            ],
            "percentage": 75
          }
        ],
        "numberOfKitchens": 1,
        "numberOfBathrooms": 3,
        "numberOfFireplaces": 1,
        "garages": [
          {
            "type": "Attached",
            "capacity": 2
          }
        ],
        "distanceToFireHydrantInFeet": 100,
        "distanceToFireDepartmentInMiles": 2,
        "features": {
          "hasBurglarAlarm": true,
          "hasFireAlarm": true,
          "hasSupplementalHeating": false
        },
        "addressRaw": "string",
        "ageOfRoofInYears": 4,
        "address": {
          "number": 123,
          "street": "Main",
          "type": "St",
          "sec_unit_type": "Apt",
          "sec_unit_num": "1A",
          "city": "San Francisco",
          "state": "CA",
          "zip": 94111,
          "plus4": 2233,
          "suffix": "Ave",
          "prefix": "W"
        }
      },
      "coverages": [
        {
          "name": "Personal Property",
          "rawName": "Personal Property",
          "perOccurrenceLimitCents": 10000000,
          "perPersonLimitCents": 50000000,
          "maxMonthsLimit": 6,
          "premiumCents": 50000,
          "isDeclined": false,
          "deductibleCents": 50000,
          "hurricaneDeductibleCents": 50000,
          "windstormDeductibleCents": 50000,
          "earthquakeDeductibleCents": 50000
        }
      ],
      "householdMembers": [
        {
          "name": {
            "firstName": "John",
            "middleName": "K",
            "lastName": "Smith"
          },
          "gender": "female",
          "relationship": "Named Insured",
          "birthday": "1985-08-29",
          "birthdayRange": {
            "start": "1988-01-01",
            "end": "1988-12-31"
          },
          "occupation": "Engineer"
        }
      ],
      "mortgages": [
        {
          "type": "First Mortgage",
          "loanNumber": "000-393323-33",
          "lienHolder": "Quicken Loans",
          "lienHolderAddress": {
            "number": 123,
            "street": "Main",
            "type": "St",
            "sec_unit_type": "Apt",
            "sec_unit_num": "1A",
            "city": "San Francisco",
            "state": "CA",
            "zip": 94111,
            "plus4": 2233,
            "suffix": "Ave",
            "prefix": "W"
          },
          "lienHolderAddressRaw": "string"
        }
      ],
      "documents": [
        {
          "url": "https://storage.googleapis.com/...",
          "urlExpiration": "2020-09-24",
          "type": "DEC_PAGE"
        }
      ]
    }
  ]
}

Properties

Enumerated Values

AcceptedResponse

{
  "status": "NOT_READY",
  "issuerId": "geico",
  "issuerName": "GEICO",
  "message": "POLICIES NOT READY YET"
}

Properties

NotFoundResponse

{
  "status": "READY",
  "issuerId": "geico",
  "issuerName": "GEICO",
  "message": "ACCOUNT_NOT_FOUND",
  "error": {
    "errorType": "ACCOUNT_NOT_FOUND",
    "errorCode": "TECHNICAL_DIFFICULTIES",
    "errorMessage": "The issuer or Trellis was experiencing technical difficulties."
  }
}

Properties

Enumerated Values