If you purchase leads from an aggregator, they can post those leads to Insureio for you. Your lead provider's developer can help set this up using our API. Then, when your lead provider posts a lead into Insureio, it will appear with all the relevant tags and pieces of data you need for lead distribution, marketing, and reporting purposes.


Before You Get Started

You may post leads to Insureio using either of our two available methods: a flattened HTTP post option, or the structured JSON method.

Your lead provider's developer (or yours, if you have one) can help you set up your queries correctly using the information and examples provided on this page. The minimum amount of data you need in order to post a lead is a profile ID, full name, and either a valid phone or email. If you like, you can also add more information about policies, quotes, and the client's financial history. All available tags and fields are described below, with formatting examples. If your lead aggregator collects a piece of data you want to import, simply find the matching field or tag on this page and ask your lead provider's developer to include that data. To get started, you'll need the API endpoint shown below.

Insureio uses numeric codes to represent certain pieces of data, including state, policy type (term, perm, etc.), carrier, and health class. You may want to bookmark our Enum page to help you as you format your queries.

Insureio also uses some specific vocabulary you'll need to be familiar with as you're formatting your queries.

  • A case implies business that is in the later stages and has been worked on by an agent.
  • An opportunity implies quote data that has not yet been verified by an agent.
  • Primary tags help you identify where a lead came from - they include lead type, source, and referrer.
  • Marketing tags help you identify demographic or other useful data - they are represented by key:value pairs.

DEVELOPER'S NOTE: The lead import API creates one resource per request, so there can only be one "crm_connection" object per request.

Get Started: Request Header Format

API endpoint. The API endpoint is: https://pinney.insureio.com/crm/connections.json

Content-type. Insureio expects a POST request with a JSON body. Recommended headers for your request include:

Content-type: application/json Accept: application/json

Authorization. See API Authentication. Note: You do not need any form of authentication to post leads. As mentioned above, the minimum amount of data you need in order to post a lead is a profile ID, full name, and either a valid phone or email. Authentication is related to using Insureio's quoting capabilities.

The rest of this page provides more detail about JSON formatting, the flattened HTTP post option, and the specific data fields you can import via our API, with examples.


Jump to a section of this page:

Quick Start: Basic Examples and JSON Formatting
Quick Start - JSON Formatting
Quick Start - Minimal Example
Quick Start - Sample with All Associations
Flattened HTTP Post Option

Detailed Information: Available Fields & Formatting
ID Numbers, Tracking & Marketing Tags: Includes profile ID, agent ID, lead type, referrer, source, and marketing tags
Request Body Format: Includes client data, policy data, contact info (address, email, phone), stakeholder relationships, notes, financial info, health info, tagging and tracking, and lead distribution

Detailed Examples
Example
Full Example with All Fields
Example Response


Quick Start - JSON Formatting

The body of your request will contain objects and arrays. Objects are simply curly braces around a set of key/value pairs. Arrays are a list of values surrounded by square brackets, used to pass multiple pieces of related information into our API. Click here to jump down the page and view a full example, including other “attributes” keys whose values must be an array. This page also contains a complete list of keys and values Insureio will accept.

Here's a quick example to get you started:


Quick Start - Minimal Example

Use this if you just need a quick example to get started. Not detailed enough? Click here to jump down to a full example with all fields.

"crm_connection":{
     "full_name":"Brad Pitt",
     "feet":5,
     "inches":11,
     "weight":150,
     "tobacco":false,
     "addresses_attributes":[
          {"street":"123 Some Street Apt. 8","city":"Hollywood","state_id":5,"zip":"99999"}
     ],
     "emails_attributes":[
          {"value":"username@host.com"}
     ]
}

Quick Start - Sample with All Associations

This shell contains all possible associations without the actual fields; those are found further down the page here. You do not need to use every association in order to post.

"crm_connection":{
         "addresses_attributes":[],
    "phones_attributes":[],
    "emails_attributes":[],
    "notes_attributes":[],
    "tags_attributes":[],
    "health_info_attributes":{
      "health_history_attributes":{},
      "family_diseases_attributes":{},
      "moving_violation_history_attributes":{}
    },
    "financial_info_attributes":{},
    "opportunities_attributes":[],
    "cases_attributes":[
      {
        "quoting_details_attributes":[],
        "stakeholder_relationships_attributes":[
          {
            "stakeholder_attributes":{}
          }
        ],
        "notes_attributes":[]
      }
    ]
  }
}

Flattened HTTP Post Option

This is one of two methods we offer for posting lead data to Insureio. You can post all your data using either this flattened HTTP post method or the structured JSON method. However, if you have a smaller set of data to post (consumer data only, for example – rather than consumer data and policy details), this method may be faster and easier for you than our structured JSON method. Our server will translate the data you pass using the flattened HTTP method into structured JSON. (In other words, it all works the same on the back end.)

Here's a sample:

{
  "agent_id": 16,
  "profile_id": 132,
  "full_name": "Test FlatJsonToLeadImportAPIv2",
  "birth_or_trust_date": "1950-10-01",
  "gender": "Male",
  "health_info.feet": 5,
  "health_info.inches": 9,
  "health_info.weight": 180,
  "health_info.tobacco": false,
  "address1.street": "123 fshassh",
  "address1.city": "sfhsfh",
  "address1.state_id": 49,
  "address1.zip": "99999",
  "email1.value": "test@test.com",
  "phone1.phone_type_id": 1,
  "phone1.value": "9998887777",
  "phone2.phone_type_id": 2,
  "phone2.value": "8889997777",
  "phone2.ext": "ask for Test",
  "case1.status_type_id": 671,
  "case1.quoting_details1.carrier_id": 1,
  "case1.quoting_details1.plan_name": "Select-a-Term/T01A10",
  "case1.quoting_details1.category_id": 1,
  "case1.quoting_details1.carrier_health_class": "Preferred Plus Non-Smoker",
  "case1.quoting_details1.face_amount": 500000,
  "case1.quoting_details1.planned_modal_premium": 2579,
  "case1.quoting_details1.premium_mode_id": 1
}

ID Numbers, Tracking, and Marketing Tags

Jump to a section:

Profile ID
Agent ID (Full Numeric ID)
Lead Type
Referrer
Source
Marketing Tags

Profile ID

REMINDER: This is one of the three minimum pieces of data you need in order to post a lead (along with a full name, and either a valid phone or email).

The profile ID is the unique ID assigned to the brand to which you want to post the lead. For the purposes of the JSON query, your "brand" and your "profile" are the same thing. The profile ID will trigger things like the lead's initial status, the logo applied to email templates sent to this lead, the data pulled into that email template, etc.

To find a branding profile's ID, look in your My Account / Branding Profiles tab. Each profile has an ID number listed as shown here:How to Find Your Profile ID

Agent ID (Full Numeric ID)

You may also want to post leads to your direct account, in addition to your brand. You can also post a team member's Agent ID, if you wish.

To find your agent ID, look in your My Account / Personal section. In the Account column on the right, you'll see an ID. Hover your mouse over the "i" icon. Your agent ID (full numeric ID) will appear, as shown below. Note that your full numeric ID may not be the same as the ID listed in your profile. How to Find Your Agent ID

To find a team member's agent ID, go to the Agency Management / User Hierarchy section of Insureio. Find your agent's name, then hover your mouse over the link icon to the right of their name. At the bottom of your screen, you'll see the text of a URL (https: // pinney.dataraptor/usage/users/XXX/personal... ). The number you see in the XXX slot is that team member's agent ID, as shown below: How to Find a Team Member's Profile ID

Primary Tags: For Tracking Purposes

There are 3 primary tags set directly on the crm_connection record: lead type, source, referrer. They allow for a single entry each. They are the most common form of tracking in Insureio relative to leads and lead posting. That's how we recommend using them, but it's not required. You can handle additional fields using marketing tags, which allow for an unlimited number of additional tagging details to be added to a consumer record.

Lead Type

Represented by the field title "lead_type," this tag is typically used to aid in lead distribution (which is based on lead_type). It is required for distributing leads according to the weights you set up in the Agency Management section. It is often associated with the name of a specific marketing campaign run as part of a brand profile's marketing efforts. For example, the brand profile Connected Benefits may be running a special campaign to new group members using the lead_type “CB New” to aid in lead distribution to agents specifically versed in a special offer. They can also use the lead_type “CB New” to provide additional/specific reporting details on this subset of the larger Connected Benefits marketing efforts.

NOTE: If you are a single-person operation, you don't necessarily need to use this field, since all leads are going to post directly to you and bypass any distribution rules.

Automated Lead Distribution

By default, Insureio interprets the authenticated user (i.e., the user whose credentials you pass in your Authorization header) as the agent assigned to the lead you're submitting. If you'd rather have Insureio automatically distribute your leads among eligible members of your Branding Profile (indicated as profile_id, include an auto_assign parameter with a true (boolean) value in the main object of your request body. Click here to jump down to our example - you'll see the auto-assign near the top of the post.

Be advised that presence of a crm_connection.agent_id or crm_case.agent_id parameter will override the auto_assign parameter. Inclusion of either of these agent_id parameters will prevent automated distribution of your lead.

Referrer

This is a good field to include for reporting purposes. It can tell you where the lead came from in a general sense. It's typically used to identify a specific marketing piece/advertisement, person, or similar lead generation method associated with a specific marketing endeavor. For example, a brand named Connected Benefits may have managers who refer new group members; these referrals would then be posted to their “CB New” lead_type so Connected Benefits can track and reward these managers for their efforts. Alternatively, you can use this tag to indicate a medium, such as the internet. For example, your referrer might be "internetlead," which is the broad category of where this lead came from. To make this more specific, you could pair it with a source tag (see below) such as "MyInsuranceSite1." Click here to jump down to a more detailed explanation below.

Source

This is also a good field to include for reporting purposes. It can give you more granular detail about where your lead came from. It's typically used to identify the specific URL/link used to generate the lead/consumer contact record. When used in combination with other tracking tools like Google Analytics, the "source" tag aids in tracking conversion metrics (lead received to placed, received to submitted, etc.) on a per-URL/page basis. For example, our fictional brand Connected Benefits may have several landing/information pages (i.e., connectedbenefits.com/new-1, connectedbenefits.com/new-2, etc.), each with a unique URL. The brand wants to track these to find out which is the most effective in converting visitors to leads, submitted applications, paid policies, etc. In this example, their general "referrer" tag might be "website." Their more specific "source" tag might be "connectedbenefits.com/new-1" or "connectedbenefits.com/new-2." Click here to jump down to a more detailed explanation below.

Secondary Tags: For Marketing Purposes

Secondary (marketing) tags can help you sort clients based on particular attributes, demographics, or needs. This is especially helpful for planning future marketing campaigns. You can use as many marketing tags as you like per record. They can be attached to each lead by specifying tags in your crm_connection.tags_attributes array. Tags are joined together in a query string as shown below, by using an ampersand between the tags.

For example, let's say Connected Benefits decides to ask several questions as part of the lead acquisition process that identifies specific demographic data. They could then tag leads to identify group members who participate in piloting an aircraft (tag of “avocation-pilot”), scuba diving (tag of “avocation-scuba”), or those with a specific health issue like diabetes (tag of “health – diabetes”) to use as part of a separate risk mitigation or wellness program.

PRO TIP: We recommend adding tags to client records before bringing in a book of business. As soon as that book is imported into Insureio, you can start sorting and putting those clients into marketing campaigns. The more tags you give a client or prospect, the easier it will be to market and cross-sell to them. Click here to jump down to a more detailed explanation below.

Formatting Primary and Secondary Tags

A well-formatted tag object has the following fields:

  • key: string
  • value: string (optional)

For example, if I have a lead I want to tag with a lead type of "referral" and referrer of "Paul" and "over 50 years of age," I would supply the following array:

[ {"key": "referrer", "value": "Paul"}, {"key": "over 50 years of age"} ]

Be advised that in order to avoid duplication, all tag keys are normalized, so the following key values would all become the same key in Insureio: "Lead type," "lead type," "lead type."

In addition to the normal lead posting process, many of the items discussed above can be captured/inserted via the page URL string of the quote widgets themselves. Click here for specific information to set this up.

Multi-Level Tracking

 If you like to think of your tracking as a collection of tags, that's great. You don't need to do anything special to preserve your paradigm. Feel free to skip the rest of this section.

If you like to think of your tracking as "tiered" or "multi-leveled," you can preserve the data from all of those tiers/levels, but there is no hierarchy of tracking data in Insureio. However, when pulling reports, you can achieve mimicry of hierarchical tracking fields if you specify not only the field in which you are interested, but all superordinate tracking fields.

To illustrate, if you have a tracking hierarchy where "lead type" is a top-level field and "referrer" is a level-2 field (i.e., subordinate to lead type), and you simply run a report on all clients whose referrer is "Google," Insureio will return all clients whose referrer is Google, regardless of what their lead type is or whether they even have a lead type. If you wish to enforce your hierarchy when you run reports, you must specify the superordinate tracking fields as well. In our illustration, this means that I must indicate on the reporting form that lead type is not null (or is set as whatever lead type I have in mind) in addition to specifying a referrer of "Google."


Below, you will find the technical documentation your developer or IT team will need to configure your lead import correctly.


Request body format

Jump to a section:

Client
Tracking
Tagging
Multi-Level Tracking
Policies
Multiple Policies Per Client
Policy Details
Address
Email
Phone
Website
Stakeholder Relationships
Notes
Financial Info
Health Info
Health History
Relatives Disease
Moving Violation History
Automated Lead Distribution

 

Client

The main object for the lead import JSON document is the client, represented by key "crm_connection". A well formed "crm_connection" includes the following fields. All fields and nested objects are optional and may be omitted, with the exclusion of "profile_id", "full_name", and either a valid phone or email. Should you choose to add a given object (like a phone), that object type may have its own required fields.

Note: If you read the system’s response to verify that your data was saved properly, birth, gender, title, and trustee will be shown within the contact object. The response for birth will be called birth_or_trust_date.

Key Primitive Data Type Format Default Value Required? Note
addresses_attributes array Should hold one or more address objects. See address for duplicate record detection, and for application fulfillment
agent_id integer the numeric id of an agent in order to assign to a specific agent In the absence of an agent, lead distribution logic will be used.
profile_id integer see profile ID Always In the Insureio interface, the terms "profile" and "brand" are used interchangeably.
lead_type string for lead distribution Like tags, this field can mean whatever your organization designates it to mean for the sake of lead tracking. Searching by lead type is faster than searching by tags. Any member of your Profile/Brand may see your Lead Types.
referrer string Like tags, this field can mean whatever your organization designates it to mean for the sake of lead tracking. Searching by lead type is faster than searching by tags. Any member of your Profile/Brand may see your Referrers.
source string Like tags, this field can mean whatever your organization designates it to mean for the sake of lead tracking. Searching by lead type is faster than searching by tags. Any member of your Profile/Brand may see your Sources.
birth_or_trust_date string date (YYYY-MM-DD). see ISO 8601 for duplicate record detection, and for application fulfillment
birth_country string see Birth Countries table
birth_state_id integer see Enum#State Only applicable if birth country is United States.
cases_attributes array Should hold one or more case objects. See policies
opportunities_attributes array Should hold one or more policy details objects. See policy details
citizenship_id integer see Enum#Crm::Citizenship
company string
critical_note string Is a shorter equivalent to specifying a note object with the critical flag set to true.
dln string a valid drivers license number
dl_state_nam string see name in Enum#State
emails_attributes array Should hold one or more email objects. See email
financial_info_attributes object See financial info for quoting and for application fulfillment
full_name string Space separated. Characters before the first space will be considered the first name. Characters after the last space will be considered the last name. Always
gender string "Male" or "Female" for duplicate record detection, for quoting, and for application fulfillment Is a shorter equivalent to passing gender within the health info object. Is stored and returned in the response as a boolean. The string representation when setting the field is for clarity.
health_info_attributes object See health info for duplicate record detection, for quoting, and for application fulfillment
notes_attributes array Should hold one or more note objects. See notes
occupation string
phones_attributes array Should hold one or more phone objects. See phone
preferred_contact_method_id integer see Enum#Crm::ContactMethod for application fulfillment
preferred_contact_time string for application fulfillment
ssn string representation of Social Security number, consisting only of numeric digits for duplicate record detection and for application fulfillment
tags_attributes array Should hold one or more tag objects. See tagging
title string
trustee string Only relevant if the consumer record being created is a Company or Trust.
websites_attributes array Should hold one or more website objects. See website

Policies

A well-formed policy has the following properties:

Key Primitive Data Type Format Default Value Required? Note
agent_id integer the numeric id of an agent inherited from consumer in order to assign to a specific agent
agent_of_record_id integer
bind boolean null Required for app fulfillment This is referred to on the front end and in error messages as temporary insurance.
business_insurance boolean DEPRECATED. Will soon be removed as an option. Instead, specify "purpose_id". If the purpose for insurance is business related, then this case will be treated as business insurance.
purpose_id integer See id in Enum#Crm::Purpose
category_id integer See id in Enum#Quoting::TliCategoryOption
collateral_assignment boolean
cross_sell boolean
effective_date string date (YYYY-MM-DD). see ISO 8601
esign boolean
exam_company string
exam_completed boolean
exam_num string
exam_status string
exam_time string datetime. see ISO 8601
ezl_id integer
face_amount integer
flat_extra decimal
flat_extra_years integer
incl_1035 decimal
is_a_preexisting_policy boolean
ipo boolean
needs_1035 boolean
notes_attributes array Should hold one or more note objects. See notes
owner_id integer
packet boolean
placed boolean
policy_number string
policy_period_expiration string date (YYYY-MM-DD). see ISO 8601
policy_type_name string
product_type_id integer
product_type_name string see name field for Enum#Crm::PolicyType
purpose_id integer see id Enum#Crm::Purpose
purpose_type_id integer see id Enum#Crm::Purpose
quoting_details_attributes array Should hold one or more policy details objects. See policy details Always Insureio allows one details record per sales stage, in order to document and report on any changes that are made through the sales process. See Enum#Crm::SalesStage.
submitted_details_attributes object See policy details This is a shorter way to specify a policy details object with an implied sales stage of 4 - "Submitted to Carrier". See Enum#Crm::SalesStage.
replaced_by_id integer
replacing boolean
sent boolean
sent_to_igo string date (YYYY-MM-DD). see ISO 8601
sales_stage_id integer See Enum#Crm::SalesStage. 1
status_type_id integer
termination_date string date (YYYY-MM-DD). see ISO 8601
underwriter_assist boolean
up_sell integer
xrae_case_id string

Multiple Policies per Client

When submitting a lead to Insureio, any number of policies (cases) can be supplied in the submission. These are represented as objects in the array:

 crm_connection.cases_attributes

Policy Details

A well-formed policy detail attribute set has the following properties:

Key Primitive Data Type Format Default Value Required? Note
carrier_id integer see id on Carrier Names page
carrier_health_class string (differs for each carrier)
category_id integer see id in Enum#Quoting::TliCategoryOption
category_name string see name in Enum#Quoting::TliCategoryOption DEPRECATED. May soon be removed as an option. Instead, specify a "category_id".
plan_name string Plan name as defined by the carrier that offers the plan.
face_amount integer
health_class_id integer see id in Enum#Quoting::TliHealthClassOption This is the standardized health class initially selected when running the quote. If health impairments disqualified the client from this class, then it may not correspond directly with the carrier health class.
annual_premium decimal {precision: 10, scale: 2} DEPRECATED. May soon be removed as an option. Instead, specify "planned_modal_premium" and "premium_mode_id".
monthly_premium decimal {precision: 10, scale: 2} DEPRECATED. May soon be removed as an option. Instead, specify "planned_modal_premium" and "premium_mode_id".
planned_modal_premium decimal Setting "planned_modal_premium" and "premium_mode_id" is equivalent to setting a monthly or annual premium. It is the preferred approach.
policy_type_id integer see Enum#Crm::PolicyType
premium_mode_id string see Enum#Quoting::PremiumModeOption

Address

A well-formatted address object has the following properties:

Key Primitive Data Type Format Default Value Required? Note
address_type_id integer see Enum#AddressType
city string
state_id integer see Enum#State Always
street string may contain multiple lines
zip string 5 digits

Email

A well-formatted email object has the following properties:

Key Primitive Data Type Format Default Value Required? Note
value string see RFC 2606 Always

Phone

A well-formatted phone object has the following properties:

Key Primitive Data Type Format Default Value Required? Note
ext string Freeform. Can be numeric extension or a phrase like "ask for Mr. Monroe in the Sales Department".
phone_type_id integer see Enum#PhoneType
value string Any non-numeric characters will be automatically stripped. Should be 10 digits in length, starting with a valid area code. Always

Website

A well-formatted website object has the following properties:

Key Primitive Data Type Format Default Value Required? Note
value string Always

Stakeholder Relationships

A beneficiary, owner, and/or premium payer should each be represented as an object in the array at:

crm_connection.crm_stakeholder_relationships
Key Primitive Data Type Format Default Value Required? Note
stakeholder_id integer the id of an existing client record unless "stakeholder_attributes" is provided Provide either an id for an existing client record or attributes for a new record, not both.
stakeholder_attributes object See Client Fields unless "stakeholder_id" is provided Provide either an id for an existing client record or attributes for a new record, not both.
relationship_type_id integer see Enum#relationshiptype Always
is_owner boolean false unless "is_payer" or "is_beneficiary" is true A stakeholder can be any combination of owner, payer, or a beneficiary. But they must fill at least one of those roles.
is_payer boolean false unless "is_owner" or "is_beneficiary" is true A stakeholder can be any combination of owner, payer, or a beneficiary. But they must fill at least one of those roles.
is_beneficiary boolean false unless "is_owner" or "is_payer" is true A stakeholder can be any combination of owner, payer, or a beneficiary. But they must fill at least one of those roles.
percentage integer in the range 1 to 100 inclusive if "is_beneficiary" is true The total percentages for all primary beneficiaries and all contingent beneficiaries must be 100.
contingent boolean false

If you are NOT specifying a stakeholder_id (the most common usage), the object(s) in the stakeholder_relationships_attributes list should each have a stakeholder_attributes object, with name, emails, phones for the stakeholder. Stakeholders are stored as consumers, so this object can have any of the keys that a consumer could have. Here’s an example of what this section should look like:

"stakeholder_relationships_attributes": [
          {
            "relationship_type_id": 1,
            "is_beneficiary":true,
            "percentage": 29,
            "contingent": true,
            "stakeholder_attributes":{
              "full_name": "Sarah Conner",
              "birth_or_trust_date": "2013-07-23",
              “title”: “The title goes here”,
              "genre_id":2,
  "trustee": "A relative",
  "ssn": "1234566789",
              "gender": false,
              "addresses_attributes": [
                {
                  "address_type_id": 1,
                  "city": "Dallas",
                  "state_id": 45,
                  "street": "1234 Parkview Drive",
                  "zip": "75201"
                }
              ]
            }
          }
        ],
 

Notes

An array of notes can be embedded in the Client or Case model (or both). A well-formed note object has the following fields:

Key Primitive Data Type Format Default Value Required? Note
confidential boolean false If true, only the creator or a super user should be able to view this note.
text string Always Notes are not searchable via reporting. For short, freeform comments that you may want to search by later, use tags instead.
note_type_id integer see Enum#Crm::NoteType 1

Financial Info

Financial info is represented as an object at:

crm_connection.financial_info

A well-formed financial info object has the following fields:

Key Primitive Data Type Format Default Value Required? Note
annual_income decimal
asset_checking integer
asset_earned_income integer (excludes dividends from investments, etc.)
asset_home_equity integer
asset_investments integer
asset_life_insurance integer
asset_pension integer
asset_real_estate integer
asset_retirement integer (pension, IRA, etc.)
asset_savings integer
asset_unearned_income integer (income from dividends etc.)
assets decimal Total assets; you are free to make this not coincide with the sum of the other assets fields if you wish.
assumed_inflation_rate float
bankruptcy string date (YYYY-MM-DD). see ISO 8601
bankruptcy_discharged string date (YYYY-MM-DD). see ISO 8601
liability_auto integer
liability_credit integer
liability_education integer
liability_final_expense integer
liability_heloc integer (home equity loan)
liability_mortgage_1 integer
liability_mortgage_2 integer
liability_other integer
liability_personal_loans integer
liability_student_loans integer
liability_years_income_needed integer
liabilities decimal (total liabilities; you are free to make this not coincide with the sum of the other liabilities fields if you wish)
net_worth_specified integer
net_worth_use_specified boolean
spouse_income integer (annual income)
spouse_marginal_tax_rate float
spouse_retirement date

Health Info

Health info is represented as an object at: crm_connection.health_info A well-formatted health info object contains the following fields:

Key Primitive Data Type Format Default Value Required? Note
bp boolean no Represents whether or not the consumer has ever been diagnosed with or treated for high blood pressure. If left blank, will be treated as “no” for quoting purposes. If set to “no,” no other blood pressure fields need to be passed in. Will be automatically set to “yes” if any other blood pressure fields contain data.
bp_control_start string date If a date is passed in, the blood pressure boolean field (bp) will automatically be set to "yes."
bp_diastolic integer If an integer is passed in, the blood pressure boolean field (bp) will automatically be set to "yes."
bp_systolic integer If an integer is passed in, the blood pressure boolean field (bp) will automatically be set to "yes."
cholesterol boolean Represents whether or not the consumer has ever been diagnosed with or treated for high cholesterol. If left blank, will be treated as “no” for quoting purposes. If set to “no,” no other cholesterol fields need to be passed in. Will be automatically set to “yes” if any other cholesterol fields contain data.
cholesterol_control_start string date If a date is passed in, the cholesterol boolean field will automatically be set to "yes."
cholesterol_hdl float If data is passed in, the cholesterol boolean field will automatically be set to "yes."
cholesterol_level integer If an integer is passed in, the cholesterol boolean field will automatically be set to "yes."
cigarettes_current boolean
cigarettes_per_day integer
cigars_current boolean
cigars_per_day integer
criminal boolean
family_diseases_attributes array Should hold one or more family disease objects. See relatives disease
feet integer Foot portion of height, in range 1 to 7 inclusive.
foreign_travel boolean
gender string "Male" or "Female" for duplicate record detection, for quoting, and for application fulfillment Is stored and returned in the response as a boolean. The string representation when setting the field is for clarity.
hazardous_avocation boolean
hazardous_avocation_aeronautics
hazardous_avocation_aeronautics_hang_gliding
hazardous_avocation_aeronautics_sky_diving
hazardous_avocation_aeronautics_parachuting
hazardous_avocation_aeronautics_ballooning
hazardous_avocation_aeronautics_other
hazardous_avocation_racing
hazardous_avocation_racing_car
hazardous_avocation_racing_motorcycle
hazardous_avocation_racing_boat
hazardous_avocation_racing_other
hazardous_avocation_scuba_skin_diving
hazardous_avocation_scuba_skin_diving_lte_75_ft
hazardous_avocation_scuba_skin_diving_gt_75_ft
hazardous_avocation_climbing_hiking
hazardous_avocation_climbing_hiking_trail
hazardous_avocation_climbing_hiking_mountain
hazardous_avocation_climbing_hiking_rock
hazardous_avocation_flying
hazardous_avocation_flying_non_pilot_crew
hazardous_avocation_flying_student_pilot
hazardous_avocation_flying_private_pilot
hazardous_avocation_flying_private_pilot_lt_50_h
hazardous_avocation_flying_private_pilot_50_to_250
hazardous_avocation_flying_private_pilot_gt_250_h
hazardous_avocation_flying_private_pilot_lt_100_solo_h
hazardous_avocation_flying_commercial_pilot
hazardous_avocation_flying_corporate_pilot
hazardous_avocation_flying_military_pilot
hazardous_avocation_flying_test_pilot
hazardous_avocation_flying_flight_instructor
hazardous_avocation_flying_other
hazardous_avocation_detail string
health_history_attributes object See health history
inches integer Inch portion of height, in range 0 to 11 inclusive.
bp_last_treatment string date (YYYY-MM-DD). see ISO 8601
cholesterol_last_treatment string date (YYYY-MM-DD). see ISO 8601
last_cigar string date (YYYY-MM-DD). see ISO 8601
last_cigarette string date (YYYY-MM-DD). see ISO 8601
last_dl_suspension string date (YYYY-MM-DD). see ISO 8601
last_dui_dwi string date (YYYY-MM-DD). see ISO 8601
last_nicotine_patch_or_gum string date (YYYY-MM-DD). see ISO 8601
last_pipe string date (YYYY-MM-DD). see ISO 8601
last_reckless_driving string date (YYYY-MM-DD). see ISO 8601
last_tobacco_chewed string date (YYYY-MM-DD). see ISO 8601
moving_violation boolean Represents whether or not the consumer indicates any history of moving violations. If left blank, will be treated as "no" for quoting purposes. If set to "no," no other moving violation fields need to be passed in. Will be automatically set to "yes" if any other moving violation fields contain data.
moving_violation_history_attributes string object see moving violation history If data is passed in, the moving_violation boolean field will automatically be set to "yes."
nicotine_patch_or_gum_current boolean
penultimate_car_accident string date (YYYY-MM-DD). see ISO 8601
pipe_current boolean
pipes_per_year integer
tobacco boolean null no Represents whether or not the consumer has used any form of tobacco in the past 5 years. If left blank, will be treated as "no" for quoting purposes. If set to "no," no other tobacco fields need to be passed in. Will be automatically set to "yes" if any other tobacco questions are answered as "yes."
tobacco_chewed_current boolean
travel_when string no
travel_where string no
weight integer US pounds

Health History

A well-formed health history object has the following fields:

Key Primitive Data Type Format Default Value Required? Note
alcohol_abuse boolean
anxiety boolean
asthma boolean
atrial_fibrillations boolean
breast_cancer boolean
copd boolean
crohns boolean
depression boolean
diabetes_1 boolean
diabetes_2 boolean
diabetes_neuropathy boolean
elft boolean
emphysema boolean
epilepsy boolean
heart_attack boolean
heart_murmur_valve_disorder boolean
hepatitis_c boolean
internal_cancer boolean
irregular_heart_beat boolean
mental_illness boolean
parkinsons boolean
prostate_cancer boolean
rheumatoid_arthritis boolean
sleep_apnea boolean
skin_cancer boolean
stroke boolean
ulcerative_colitis_iletis boolean
vascular_disease boolean
weight_loss_surgery boolean

Relatives' Disease

A well-formed relatives disease object has the following fields:

Key Primitive Data Type Format Default Value Required? Note
basal_cell_carcinoma boolean
breast_cancer boolean
cardiovascular_disease boolean
cardiovascular_impairments boolean
cerebrovascular_disease boolean
colon_cancer boolean
coronary_artery_disease boolean
diabetes boolean
intestinal_cancer boolean
kidney_disease boolean
malignant_melanoma boolean
other_internal_cancer boolean
ovarian_cancer boolean
prostate_cancer boolean
age_of_contraction integer
age_of_death integer
parent boolean

Moving Violation History

A well-formed moving violation history object has the following fields, each of which indicates the number of moving violations cited during the indicated time period:

Key Primitive Data Type Format Default Value Required? Note
last_6_mo integer
last_1_yr integer
last_2_yr integer
last_3_yr integer
last_5_yr integer

Example

{
  "auto_assign": true,
  "crm_connection": {
    "birth_or_trust_date": "1957-05-20",
    "occupation": "Ceo/Principal",
    "emails_attributes": [
        {
          "value": "credfern@stars.gov "
        }
      ],
      "addresses_attributes": [
        {
          "street": "123 Fake St.",
          "city": "Racoon City",
          "zip": "94610",
          "state_id": 11,
          "address_type_id": 2
        }
      ],
      "phones_attributes": [
        {
          "phone_type_id": 1,
          "value": "8889997777"
        },
        {
          "phone_type_id": 2,
          "value": "1112223333"
        }
      ]
    },
    "lead_type": "EZL",
    "tags_attributes": [
      {
        "key": "morbidly_obese"
      },
      {
        "key": "source_agency",
        "value": "EZLifeSales.com"
      },
      {
        "key": "source_user",
        "value": "Leon Kennedy"
      }
    ],
    "birth_country": "United States",
    "birth_state_id": "California",
    "gender": "Female",
    "full_name": "Cindy Redfern",
    "health_info_attributes": {
      "weight": 150,
      "inches": 6,
      "feet": 5
    },
    "opportunities_attributes": [
      {
        "category_id": "1",
        "product_type_name": "Term",
        "annual_premium": "1340.0",
        "face_amount": "1000000",
        "health": "Preferred Plus",
        "carrier_health_class": "Preferred Plus Non-Smoker",
        "premium_mode_name": "Annually",
        "carrier_id": 2,
        "planned_modal_premium": "1340.0"
      }
    ],
    "cases_attributes": [
      {
        "submitted_details_attributes": {
          "category_id": "1",
          "product_type_name": "Term",
          "annual_premium": "1340.0",
          "face_amount": "1000000",
          "health": "Preferred Plus",
          "premium_mode_name": "Annually",
          "carrier_id": 2,
          "planned_modal_premium": "1340.0"
        },
        "quoted_details_attributes": {
          "category_id": "1",
          "product_type_name": "Term",
          "annual_premium": "1340.0",
          "face_amount": "1000000",
          "health": "Preferred Plus",
          "carrier_health_class": "Preferred Plus Non-Smoker",
          "premium_mode_name": "Annually",
          "carrier_id": 2,
          "planned_modal_premium": "1340.0"
        },
        "product_type_name": "Term",
      }
    ],
    "full_name": "Claire Smith",
    "profile_id": 31
  }
}

Full Example with All Fields

{
	"crm_connection": {
		"agent_id": 1,
		"birth_or_trust_date": "1963-09-19",
		"birth_country": "Farway",
		"birth_state_id": "Texas",
		"opportunities_attributes": [{      
			"category_id": "1",
			      "product_type_name": "Term",
			      "annual_premium": "1340.0",
			      "face_amount": "1000000",
			      "health": "Preferred Plus",
			      "carrier_health_class": "Preferred Plus Non-Smoker",
			      "premium_mode_name": "Annually",
			      "carrier_id": 2,
			      "planned_modal_premium": "1340.0"    
		}],
		"cases_attributes": [{
			"agent_id": 2,
			"agent_of_record_id": 1,
			"approved_details_attributes": {
				"annual_premium": 10000.00,
				"carrier_id": 1,
				"carrier_health_class": "A Health Class",
				"category_id": 1,
				"category_name": "10 Years",
				"face_amount": 10,
				"health": "PP",
				"health_class_id": 1,
				"monthly_premium": 2000.00,
				"plan_name": "Some Plan",
				"planned_modal_premium": 2000.00,
				"policy_type_id": 1,
				"premium_mode_name": "Annually"
			},
			"approved_premium_due": 2000.00,
			"stakeholder_relationships_attributes": [{
				"relationship_type_id": 1,
				"is_beneficiary": true,
				"percentage": 29,
				"contingent": true,
				"stakeholder_attributes": {
					"full_name": "Sarah Conner",
					"birth_or_trust_date": "2013-07-23",
					“title”: “The title goes here”,
					"genre_id": 2,
					"trustee": "A relative",
					"ssn": "1234566789",
					"gender": false,
					"addresses_attributes": [{
						"address_type_id": 1,
						"city": "Dallas",
						"state_id": 45,
						"street": "1234 Parkview Drive",
						"zip": "75201"
					}]
				}
			}],
			"bind": true,
			"business_insurance": true,
			"category_id": 1,
			"collateral_assignment": true,
			"connection_id": 1,
			"created_at": "2012-09-23T00:00:00-07:00",
			"cross_sell": true,
			"effective_date": "2012-09-23T00:00:00-07:00",
			"equal_share_contingent_bens": true,
			"equal_share_primary_bens": true,
			"esign": true,
			"exam_company": "An Exam Company",
			"exam_completed": true,
			"exam_num": "1234",
			"exam_status": "An Exam Status",
			"exam_time": "2013-09-23T00:00:00-07:00",
			"ezl_id": 123,
			"face_amount": 1234,
			"flat_extra": 1234.00,
			"flat_extra_years": 1234,
			"incl_1035": 123.00,
			"ipo": true,
			"needs_1035": false,
			"notes_attributes": [{
				"confidential": true,
				"note_type_id": 1,
				"text": "This is a great case."
			}],
			"owner_id": 123,
			"packet": true,
			"policy_number": "fadsfasd",
			"policy_period_expiration": "2013-09-23T00:00:00-07:00",
			"policy_type_name": "A policy type",
			"premium_payer_id": 123,
			"product_type_id": 3,
			"product_type_name": "Whole Life",
			"purpose_id": 1,
			"purpose_type_id": 1,
			"quoted_at": "2013-09-23T00:00:00-07:00",
			"quoted_details_attributes": {
				"annual_premium": 46954.00,
				"carrier_id": 51,
				"carrier_health_class": "car heal clas q",
				"carrier_name": "Presidential Life ",
				"category_id": 1,
				"category_id": "10 Years",
				"health": "PP",
				"health_class_id": 1,
				"monthly_premium": 500.00,
				"plan_name": "A Plan for life",
				"planned_modal_premium": 6000.00,
				"policy_type_id": 3,
				"premium_mode_name": "Monthly",
				"product_type_name": "Whole Life",
				"face_amount": 3000000
			},
			"reason": "Some valid reason",
			"replaced_by_id": 123,
			"replacing": true,
			"sent_to_igo": "2013-08-23T00:00:00-07:00",
			"stage": 123,
			"submitted_details_attributes": {
				"annual_premium": 46954.00,
				"carrier_id": 51,
				"carrier_health_class": "car heal clas q",
				"carrier_name": "Presidential Life ",
				"category_id": 1,
				"category_id": "10 Years",
				"health": "PP",
				"health_class_id": 1,
				"monthly_premium": 500.00,
				"plan_name": "A Plan for life",
				"planned_modal_premium": 6000.00,
				"policy_type_id": 3,
				"premium_mode_name": "Monthly",
				"product_type_name": "Whole Life",
				"face_amount": 3000000
			},
			"submitted_qualified": 123,
			"termination_date": "2013-09-23T00:00:00-07:00",
			"underwriter_assist": true,
			"up_sell": 1,
			"updated_at": "2013-09-23T00:00:00-07:00",
			"xrae_case_id": "1",
			"is_a_preexisting_policy": true,
			"product_type_name": "Whole Life"
		}],
		"citizenship_id": 1,
		"addresses_attributes": [{
			"street": "123 Sesame Street",
			"city": "Townsville",
			"state_id": 41,
			"zip": "99999"
		}],
		"emails_attributes": [{
			"value": "test@bar.com"
		}],
		"phones_attributes": [{
			"phone_type_id": 2,
			"value": "2222222222"
		}, {
			"phone_type_id": 4,
			"value": "2341234453"
		}, {
			"phone_type_id": 1,
			"value": "2111111111"
		}],
		"company": "Bigcorp",
		"critical_note": "some seriously critical stuff",
		"dl_state_name": "North Dakota",
		"dl_expiration": "2013-09-14T00:00:00-07:00",
		"dln": "test this",
		"financial_info_attributes": {
			"annual_income": 50000,
			"asset_checking": 2000,
			"asset_earned_income": 40000,
			"asset_home_equity": 100000,
			"asset_investments": 24000,
			"asset_life_insurance": 100000,
			"asset_pension": 35000,
			"asset_real_estate": 2500000,
			"asset_retirement": 30000,
			"asset_savings": 23000,
			"asset_unearned_income": 10000,
			"assets": 10000.00,
			"assumed_inflation_rate": 0.04,
			"assumed_interest_rate": 0.06,
			"bankruptcy": "2012-12-08",
			"bankruptcy_discharged": "2012-12-09",
			"liability_auto": 20000,
			"liability_credit": 50000,
			"liability_education": 10000,
			"liability_final_expense": 0,
			"liability_heloc": 50000,
			"liability_mortgage_1": 100000,
			"liability_mortgage_2": 100000,
			"liability_other": 0,
			"liability_personal_loans": 10000,
			"liability_student_loans": 5000,
			"liability_years_income_needed": 5,
			"liabilities": 200000,
			"net_worth_specified": 230000,
			"net_worth_use_specified": true,
			"spouse_income": 50000,
			"spouse_marginal_tax_rate": 0.12,
			"spouse_retirement": "2020-12-31"
		},
		"full_name": "Kim Hwa",
		"gender": "Male",
		"health_info_attributes": {
			"bp": yes,
			"bp_control_start": "2007-03-04",
			"bp_diastolic": 201,
			"bp_systolic": 101,
			"cholesterol": yes,
			"cholesterol_level": 230;
			"cholesterol_control_start": "2009-02-02",
			"cholesterol_hdl": 101,
			"cigarettes_current": true,
			"cigars_current": false,
			"cigars_per_month": 0,
			"criminal": false,
			"family_diseases_attributes": [{
				"basal_cell_carcinoma": false,
				"breast_cancer": false,
				"cardiovascular_disease": false,
				"cardiovascular_impairments": false,
				"cerebrovascular_disease": false,
				"colon_cancer": false,
				"coronary_artery_disease": false,
				"diabetes": false,
				"intestinal_cancer": false,
				"kidney_disease": false,
				"malignant_melanoma": false,
				"other_internal_cancer": false,
				"ovarian_cancer": false,
				"prostate_cancer": true,
				"age_of_contraction": 67,
				"age_of_death": 90,
				"parent": false
			}],
			"feet": 7,
			"foreign_travel": false,
			"gender": true,
			"hazardous_avocation": false,
			"hazardous_avocation_detail": "A student of life",
			"health_history_attributes": {
				"alcohol_abuse": false,
				"anxiety": true,
				"asthma": true,
				"atrial_fibrillations": false,
				"breast_cancer": false,
				"copd": false,
				"crohns": false,
				"depression": false,
				"diabetes_1": false,
				"diabetes_2": false,
				"diabetes_neuropathy": false,
				"elft": false,
				"emphysema": false,
				"epilepsy": false,
				"heart_attack": false,
				"heart_murmur_valve_disorder": false,
				"hepatitis_c": false,
				"internal_cancer": false,
				"irregular_heart_beat": false,
				"mental_illness": false,
				"parkinsons": false,
				"prostate_cancer": false,
				"rheumatoid_arthritis": false,
				"sleep_apnea": false,
				"skin_cancer": false,
				"stroke": false,
				"ulcerative_colitis_iletis": false,
				"vascular_disease": false,
				"weight_loss_surgery": false
			},
			"inches": 8,
			"bp_last_treatment": "2015-03-03",
			"cholesterol_last_treatment": "2015-03-03",
			"last_cigar": "2012-02-04",
			"last_cigarette": "2012-12-12",
			"last_dl_suspension": "2010-02-02",
			"last_dui_dwi": "2010-02-02",
			"last_nicotine_patch_or_gum": "2012-02-02",
			"last_pipe": "2010-02-02",
			"last_reckless_driving": "2012-04-12",
			"last_tobacco_chewed": "2012-08-23",
			"moving_violation_history_attributes": {
				"last_6_mo": 1,
				"last_1_yr": 2,
				"last_2_yr": 3,
				"last_3_yr": 4,
				"last_5_yr": 5
			},
			"nicotine_patch_or_gum_current": true,
			"penultimate_car_accident": "2015-02-23",
			"pipe_current": false,
			"pipes_per_year": 0,
			"tobacco": true,
			"tobacco_chewed_current": false,
			"weight": 200
		},
		"ip_address": "127.0.0.3",
		"lead_type": "CLU",
		"marital_status_name": "Single",
		"nickname": "K",
		"notes_attributes": [{
			"confidential": true,
			"note_type_id": 1,
			"text": "This guy is a great lead."
		}],
		"occupation": "My Job",
		"priority_note": "p.nt",
		"profile_id": 30,
		"referrer": "Joe Referrer",
		"salutation": "you there",
		"source": "Joe Source",
		"ssn": "123121234",
		"tags_attributes": [{
				"value": "CLU",
				"key": "lead_type"
			},
			{
				"key": "source_code"
			},
			{
				"key": "source_id"
			},
			{
				"key": "source_agency"
			},
			{
				"key": "source_user"
			}
		],
		"years_at_address": 834
	}
}

Response

Success

A 201 response with a json body. For faster turnaround, you can limit the scope of the data in the json response by including a parameter named response in the top-level object of your POST data.

  • response=empty results in a response body consisting of an empty json object.
  • response=short results in a response body whose json object describes only the primary contact information for the consumer whose case you submitted in your request.
  • response=medium results in a response body whose json object describes the crm_connection record of the consumer whose case you submitted in your request (i.e. no associated records, like contact, shall be included).

Sample successful response

{
    "agent_id": 2,
    "anniversary": null,
    "birth_or_trust_date": "1963-09-19",
    "birth_country": "Farway",
    "birth_state_id": 45,
    "case_manager_name": null,
    "cases": [
        {
            "agent_id": 2,
            "agent_of_record_id": 2,
            "approved": false,
            "approved_details_id": null,
            "approved_premium_due": null,
            "bind": null,
            "business_insurance": false,
            "category_id": 1,
            "collateral_assignment": false,
            "connection_id": 11309,
            "created_at": "2015-06-04T07:43:23-07:00",
            "cross_sell": null,
            "effective_date": null,
            "equal_share_contingent_bens": null,
            "equal_share_primary_bens": null,
            "esign": true,
            "exam_company": null,
            "exam_completed": false,
            "exam_num": null,
            "exam_status": null,
            "exam_time": null,
            "ezl_id": null,
            "face_amount": null,
            "flat_extra": null,
            "flat_extra_years": null,
            "id": 10915,
            "incl_1035": null,
            "is_a_preexisting_policy": true,
            "ipo": null,
            "needs_1035": false,
            "owner_id": null,
            "packet": null,
            "placed": false,
            "policy_number": "fadsfasd",
            "policy_period_expiration": "2013-09-23",
            "policy_type_name": null,
            "premium_payer_id": null,
            "product_type_id": 3,
            "purpose_id": null,
            "purpose_type_id": null,
            "quoted_at": "2015-06-04T07:43:23-07:00",
            "quoted_details": {
                "amount_for_1035": 0,
                "annual_premium": "46954.0",
                "carrier_health_class": "car heal clas q",
                "carrier_id": null,
                "case_id": null,
                "category_id": 1,
                "connection_id": null,
                "created_at": "2015-06-04T07:43:23-07:00",
                "face_amount": 3000000,
                "health_class_id": null,
                "id": 19145,
                "illustration_content_type": null,
                "illustration_file_name": null,
                "illustration_file_size": null,
                "illustration_updated_at": null,
                "monthly_premium": "4800.0",
                "plan_name": null,
                "planned_modal_premium": "4800.0",
                "policy_type_id": 3,
                "premium_mode_id": 4,
                "quarterly_premium": false,
                "quote_param_dyn_id": null,
                "semiannual_premium": false,
                "updated_at": "2015-06-04T07:43:23-07:00",
                "user_id": null
            },
            "quoted_details_id": 19145,
            "reason": null,
            "replaced_by_id": null,
            "replacing": null,
            "sent": false,
            "sent_to_igo": null,
            "stage": 0,
            "status_type_id": 24316,
            "submitted": false,
            "submitted_details_id": 19144,
            "submitted_qualified": null,
            "termination_date": null,
            "underwriter_assist": true,
            "up_sell": 1,
            "updated_at": "2015-06-04T07:43:23-07:00",
            "xrae_case_id": null
        }
    ],
    "citizenship_id": 1,
    "completed_application": null,
    "completed_basic": null,
    "completed_compare": null,
    "completed_discovery": null,
    "completed_financial": null,
    "completed_underwriting": null,
    "addresses": [
            {
                "address_type_id": null,
                "city": "Ci",
                "contact_id": 9031,
                "created_at": "2015-06-04T07:43:23-07:00",
                "id": 86180,
                "state_id": 41,
                "street": "street address\ncity, AL 99999",
                "updated_at": "2015-06-04T07:43:23-07:00",
                "zip": "12344"
            }
        ],
        "city": "Ci",
        "company": "Bigcorp",
        "created_at": "2015-06-04T07:43:23-07:00",
        "emails": [
            {
                "contact_id": 9031,
                "created_at": "2015-06-04T07:43:23-07:00",
                "id": 11786,
                "updated_at": "2015-06-04T07:43:23-07:00",
                "value": "test@bar.com"
            }
        ],
        "full_name": "Kim150604- Hwa",
        "id": 9031,
        "owner_id": 2,
        "owner_name": "Markham A Anderson",
        "person_id": 11309,
        "person_type": "Crm::Connection",
        "phones": [
            {
                "contact_id": 9031,
                "created_at": "2015-06-04T07:43:23-07:00",
                "ext": null,
                "id": 8650,
                "phone_type_id": 1,
                "updated_at": "2015-06-04T07:43:23-07:00",
                "value": "2111111111"
            },
            {
                "contact_id": 9031,
                "created_at": "2015-06-04T07:43:23-07:00",
                "ext": "234",
                "id": 8651,
                "phone_type_id": 2,
                "updated_at": "2015-06-04T07:43:23-07:00",
                "value": "2222222222"
            },
            {
                "contact_id": 9031,
                "created_at": "2015-06-04T07:43:23-07:00",
                "ext": null,
                "id": 8652,
                "phone_type_id": 4,
                "updated_at": "2015-06-04T07:43:23-07:00",
                "value": "2341234453"
            }
        ],
        "preferred_contact_method_id": null,
        "preferred_contact_time": null,
        "primary_address_id": 86180,
        "primary_address_string": "street address\ncity, AL 99999\nCi, RI 12344",
        "primary_email_id": 11786,
        "primary_email_string": "test@bar.com",
        "primary_phone_id": 8650,
        "primary_phone_string": "H: 211-111-1111",
        "profile_id": 30,
        "role": null,
        "state_abbrev": "RI",
        "state_id": 41,
        "tenant_name": null,
        "updated_at": "2015-06-04T07:43:23-07:00",
        "zip": "12344"
    },
    "created_at": "2015-06-04T07:43:23-07:00",
    "dl_expiration": "2013-09-14",
    "dl_state_id": 36,
    "email_send_failed": null,
    "encrypted_dln": "test this",
    "encrypted_ssn": "123121234",
    "financial_info": {
        "annual_income": null,
        "asset_checking": null,
        "asset_earned_income": 75000,
        "asset_home_equity": null,
        "asset_investments": null,
        "asset_life_insurance": null,
        "asset_pension": null,
        "asset_real_estate": null,
        "asset_retirement": null,
        "asset_savings": null,
        "asset_unearned_income": null,
        "assets": null,
        "assumed_inflation_rate": null,
        "assumed_interest_rate": null,
        "bankruptcy": null,
        "bankruptcy_discharged": null,
        "created_at": "2015-06-04T07:43:22-07:00",
        "id": 3412,
        "liabilities": null,
        "liability_auto": null,
        "liability_credit": null,
        "liability_education": null,
        "liability_final_expense": null,
        "liability_heloc": null,
        "liability_mortgage_1": null,
        "liability_mortgage_2": null,
        "liability_other": null,
        "liability_personal_loans": null,
        "liability_student_loans": null,
        "liability_years_income_needed": null,
        "net_worth_specified": 999000,
        "net_worth_use_specified": true,
        "spouse_income": null,
        "spouse_marginal_tax_rate": null,
        "spouse_retirement": null,
        "updated_at": "2015-06-04T07:43:23-07:00"
    },
    "financial_info_id": 3412,
    "gender": true,
    "health_completed": true,
    "health_info": {
        "bp_control_start": null,
        "bp_diastolic": null,
        "bp_systolic": null,
        "cholesterol": null,
        "cholesterol_control_start": null,
        "cholesterol_hdl": null,
        "cigarettes_current": null,
        "cigarettes_per_day": null,
        "cigars_current": null,
        "cigars_per_month": null,
        "created_at": "2015-06-04T07:43:23-07:00",
        "criminal": null,
        "criminal_detail": null,
        "feet": 7,
        "foreign_travel": false,
        "gender": null,
        "hazardous_avocation": null,
        "hazardous_avocation_detail": null,
        "health_history_id": null,
        "id": 10237,
        "inches": 8,
        "bp_last_treatment": null,
        "cholesterol_last_treatment": null,
        "last_cigar": null,
        "last_cigarette": null,
        "last_dl_suspension": null,
        "last_dui_dwi": null,
        "last_nicotine_patch_or_gum": null,
        "last_pipe": null,
        "last_reckless_driving": null,
        "last_tobacco_chewed": null,
        "moving_violation_history_id": null,
        "nicotine_patch_or_gum_current": null,
        "penultimate_car_accident": null,
        "pipe_current": null,
        "pipes_per_year": 0,
        "tobacco": true,
        "tobacco_chewed_current": null,
        "travel_duration": null,
        "travel_when": null,
        "travel_where": null,
        "updated_at": "2015-06-04T07:43:23-07:00",
        "weight": 1
    },
    "health_info_id": 10237,
    "id": 11309,
    "ip_address": "127.0.0.3",
    "last_applied_for_life_ins_date": null,
    "last_applied_for_life_ins_outcome_id": null,
    "last_contacted": null,
    "lead_type": "clu",
    "marital_status_id": 1,
    "marketing_unsubscribe": null,
    "nickname": "K",
    "note": null,
    "occupation": "My Job",
    "personal_completed": false,
    "physician_name": null,
    "primary_contact_relationship_id": null,
    "product_cat_id": null,
    "product_type_id": null,
    "profile_id": 30,
    "referrer": null,
    "relationship_to_agent": null,
    "relationship_to_agent_start": null,
    "salutation": "you there",
    "saved_quotes": [],
    "source": null,
    "status_unsubscribe": null,
    "suffix": null,
    "tags": {
        "additions": [],
        "deletions": [],
        "hash": {
            "lead_type": "clu",
            "referrer": null,
            "source": null,
            "source_agency": null,
            "source_code": null,
            "source_id": null,
            "source_user": null
        }
    },
    "test_lead": false,
    "title": null,
    "total_life_coverage_in_force": null,
    "updated_at": "2015-06-04T07:43:23-07:00",
    "years_at_address": 834.0
}

Failure

Any response other than 201. In most cases, this will be a 406, and the response body will be a json object which describes a problem with the request data.

Sample failure response

{"profile":["Every consumer must be attached to a branding profile."]}

You can learn more about how the lead import fields and reporting work together in the Reporting section of the Academy.

You can also find additional API documentation here: