To view a case, send a GET request as detailed below. Be sure you use one of the methods listed for authentication.

Jump to a section of this page:

Authentication
Read


Authentication

There are 3 ways to authenticate your identity so you can view personally identifiable information. Those methods are:
  • Log into the app, which will give you a session cookie.
  • Add "agent_id" and "key" query parameters to your request. The Requirements section above explains how to find your agent ID. The key needed for API endpoints is different from your quoter key, and should be guarded more closely. Until further notice, you will need to ask an Insureio representative for your API key, as it is not currently displayed within the system.
  • Use a basic auth header with your numeric ID and API key. You can read more about this standard here.

Read

GET /crm/cases/.json

Success: A 200 response with a json body.

Example:

 {
	"active": true,
	"agent_id": 2,
	"agent_of_record_id": 2,
	"approved": null,
	"approved_details_id": null,
	"approved_premium_due": null,
	"bind": true,
	"business_insurance": false,
	"category_name": "10 Years",
	"collateral_assignment": false,
	"connection_id": 11303,
	"created_at": "2015-03-24T07:19:49-07:00",
	"cross_sell": null,
	"effective_date": null,
	"equal_share_contingent_bens": true,
	"equal_share_primary_bens": true,
	"esign": true,
	"exam_company": null,
	"exam_completed": false,
	"exam_num": null,
	"exam_status": null,
	"exam_time": null,
	"ezl_id": null,
	"face_amount": 750000,
	"flat_extra": null,
	"flat_extra_years": null,
	"id": 10911,
	"incl_1035": null,
	"insurance_exists": null,
	"insured_is_owner": true,
	"insured_is_premium_payer": true,
	"ipo": null,
	"needs_1035": false,
	"owner_id": 1110,
	"owner_is_beneficiary": null,
	"owner_is_premium_payer": null,
	"packet": null,
	"placed": null,
	"policy_number": null,
	"policy_period_expiration": null,
	"policy_type_name": null,
	"premium_payer_id": 1111,
	"product_type_id": null,
	"purpose_id": null,
	"purpose_type_id": null,
	"quoted_at": "2015-03-24T07:19:49-07:00",
	"quoted_details_id": 19136,
	"reason": null,
	"replaced_by_id": null,
	"replacing": null,
	"sent": null,
	"sent_to_igo": null,
	"stage": 0,
	"status_id": 24303,
	"submitted": null,
	"submitted_details_id": 19135,
	"submitted_qualified": null,
	"termination_date": null,
	"underwriter_assist": null,
	"up_sell": null,
	"updated_at": "2015-03-24T07:20:33-07:00",
	"xrae_case_id": null
}

List

Unfortunately, this function is not yet implemented in the API. Contact your Insureio vendor to express a preference for its prioritization or the prioritization of a broader API generally.

Error: Any response other than 200.

You can find additional API documentation here: