Policy Retrieval API
The policy retrieval API is intended to retrieve details of policies that were issued previously, or possibly issued outside of the API system.
URLs
API Endpoint: https://sb.iigins.com/api/policy.html
API Example: https://sb.iigins.com/api/policy_api_example.html
Sections
The policy retrieval API is by far the simplest requiring only authentication data and the Policy ID of the policy being retrieved. Bold items are required. The sections of the request are:
-
auth
- username - Your v3 Username.
- api_key - This will be supplied by an account rep from IIG.
- agtdst - Additional information for specifying an agent / district code. Required for certain affiliates.
- office_code - Additional information for specifying agent's originating office. Required for certain affiliates.
-
policy
- policy_id - Policy ID number.
Return
The return includes many of the details of the policy, similar to what is returned after a policy is purchased. It includes the Policy ID, owner information, and some details on the power unit. Here is an example of the data returned for Policy ID "445769":
-
quote
- expiration_date: 04162015
- effective_date: 04152015
-
policy
- policy_num: 11014893
- total_price: 30.32
- underwriter: 5
- policy_id: 445769
- opt_travel_premium: 0.40
- underwriter_fee: 0.00
- opt_travel_tnc_pdf: https://sb.iigins.com/get_policy/do/get_mexassist_tnc.mhtml?policy_id=445769&policy_id_cq=9bc156f3745023f0ae6b6363ea9d5be1&aff_id=1091&agtdst=&office_code=
- tnc_pdf: https://sb.iigins.com/get_policy/do/get_u_tnc.mhtml?policy_id=445769&policy_id_cq=9bc156f3745023f0ae6b6363ea9d5be1&aff_id=1091&agtdst=&office_code=
- underwriter_tax: 0.00
- agency_fee: 20.00
- opt_travel_fee: 1.00
- policy_pdf: https://sb.iigins.com/get_policy/do/get_u_pol.mhtml?policy_id=445769&policy_id_cq=9bc156f3745023f0ae6b6363ea9d5be1&aff_id=1091&agtdst=&office_code=
- underwriter_name: ACE Seguros
- underwriter_premium: 8.92
- agtdst: 12345
- underwriter_coverage_desc: Standard
- voided: 1
-
power_unit
- license_plate_state: AL
- finance_company: app[finance_company]
- finance_state: AL
- finance_city: app[finance_city]
- finance_zip: 90210
- license_plate: app[license_plate]
- finance_address: app[finance_address]
- vin: app[vin]
- finance_account: app[finance_account]
-
policyholder
- password: <redacted>
- middle_name:
- license_state: AL
- address: app[address]
- last_name: app[last_name]
- email: example@example.com
- zip: 90210
- phone: 9289289288
- first_name: app[first_name]
- license_number: app[license_number]
- city: app[city]
- state: AGS