API Endpoint: Retrieve State Information
This endpoint is designed to retrieve state information related to insurance policies. It allows users to query specific details about an insurance policy based on various parameters provided in the request body.
Request Method
- GET
Request Body
The request body must be formatted as JSON and include the following parameters:
-
insurance_policy_no (string): The unique identifier for the insurance policy.
-
insurance_until_cancelled (integer): Indicates if the insurance is valid until cancelled (1 for true).
-
insurance_fire (integer): Indicates if fire coverage is included (1 for true).
-
insurance_theft (integer): Indicates if theft coverage is included (1 for true).
-
insurance_collision_deductible (integer): Indicates if collision deductible is applicable (1 for true).
-
insurance_collision_deductible_amount (integer): The amount for the collision deductible.
-
insurance_comprehensive_deductible (integer): Indicates if comprehensive deductible is applicable (1 for true).
-
insurance_comprehensive_deductible_amount (integer): The amount for the comprehensive deductible.
-
doctype (string): The type of document associated with the insurance (e.g., Sales Contract).
-
insurance_provider_addresses (array): An array of addresses associated with the insurance provider (currently empty).
-
insurance_agent_contact_methods (array): An array of contact methods for the insurance agent, containing:
-
phone (string): The phone number of the contact method.
-
do_not_call (boolean): Indicates if the contact prefers not to be called.
-
do_not_text (boolean): Indicates if the contact prefers not to receive text messages.
-
is_priority (integer): Indicates if this contact method is a priority (1 for true).
-
creation (string): The creation timestamp (currently empty).
-
name (string): The name associated with the contact method (currently empty).
-
type (string): The type of contact method (e.g., Mobile).
-
-
insurance_company_phone_no (array): An array of phone numbers for the insurance company, structured similarly to the insurance agent contact methods.
-
insurance_company (string): The name of the insurance company.
-
insurance_agent (string): The name of the insurance agent.
-
insurance_effective_date (string): The effective date of the insurance policy (in YYYY-MM-DD format).
-
insurance_expire_cancel_date (string): The expiration or cancellation date of the insurance policy (currently empty).
Response Structure
The response will provide relevant state information based on the provided insurance policy details. The exact structure of the response may vary, but it typically includes fields that confirm the status of the request, details about the insurance policy, and any applicable state information.
Ensure that all required fields are included in the request body to receive the appropriate response.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Response
The response returns a collection of state or province records wrapped inside a data array.
Each record represents a state or province, typically identified by a code and name.
Example Response
{
"data": [
{
"name": "JAL-Jalisco"
},
{
"name": "PUE-Puebla"
},
{
"name": "NL-Nuevo León"
},
{
"name": "GTO-Guanajuato"
},
{
"name": "OAX-Oaxaca"
},
{
"name": "BA-Buenos Aires"
},
{
"name": "CBA-Córdoba"
},
{
"name": "SF-Santa Fe"
},
{
"name": "TUC-Tucumán"
},
{
"name": "SP-São Paulo"
},
{
"name": "MG-Minas Gerais"
},
{
"name": "PR-Paraná"
},
{
"name": "ANT-Antioquia"
},
{
"name": "VAC-Valle del Cauca"
},
{
"name": "CUN-Cundinamarca"
},
{
"name": "BOL-Bolívar"
},
{
"name": "GUA-Guatemala"
},
{
"name": "QUI-Quiché"
},
{
"name": "HUE-Huehuetenango"
},
{
"name": "AV-Alta Verapaz"
}
]
}