Tourist Policy

Finally, this resource allows you to issue policies. Yes, the end of the road 🏆.

Required Properties

Name
insurance_company_id
Type
string
Description
This is the unique identifier of the insurance company used to issue the policy.
An enum is available for this property in the official SDKs.
Name
start_date
Type
datetime
Description
The start date of the tourist policy. This date marks the beginning of the policy's coverage period.
Name
end_date
Type
datetime
Description
The end date of the tourist policy. This date marks the conclusion of the policy's coverage period.
Name
policy_holder
Type
object
Description
This object contains the tourist policy holder's personal information.
Name
vehicle
Type
object
Description
The vehicle information for policy issuance pertains to the object containing specific details about the insured automobile, including model ID, value, manufacturing year, description, and VIN. These details are crucial for determining insurance costs and ensuring adequate coverage in case of accidents or other insured events.
Name
trim_id
Type
integer
Description
This parameter indicates the vehicle's trim level. It is a required field in the quotation process and helps specify the exact model variant of the vehicle for accurate insurance quoting purposes.
Name
value
Type
string
Description
This property refers to the vehicle's value.
Name
year
Type
string
Description
This property refers to the vehicle's year. Insurance companies typically refrain from insuring vehicles older than a certain period. For instance, at Quálitas, they apply the following rules:

Full or limited coverage: 15 years back from the current year.

Third-party liability (basic coverage): 30 years back from the current year.
Name
vin
Type
string
Description
This property refers to the vehicle's VIN.
Name
description
Type
string
Description
This property refers to the vehicle's description.
Name
is_multi_entry
Type
boolean
Description
This property indicates whether the tourist policy allows for multiple entry types or not.
Name
package
Type
object
Description
The "package" object represents the insurance company's offering or policy package.
Name
id
Type
integer
Description
This property serves as the unique identifier for the issuance's insurance package. It specifies the particular package for which the user seeks an issuance. It's important to note that this property is associated with a specific insurance provider. Hence, there's no need to explicitly specify the insurance provider in the request.
Name
policy_holder
Type
object
Description
This object encapsulates the information of the policy holder or the insured individual. It typically includes details such as name, address, contact information, and any other relevant personal data required for insurance purposes.
Name
name
Type
string
Description
This property refers to the policy holder's name.
Name
last_name
Type
string
Description
This property refers to the policy holder's last name.
Name
birthdate
Type
string
Description
This property refers to the policy holder's birthdate.
Name
mobile_number
Type
string
Description
This property refers to the policy holder's mobile phone number.
Name
residence_type_in_mexico
Type
string
Description
This property refers to the policy holder's residence type.
This property is required when a Mexican address is used.
Name
personal_id_type
Type
string
Description
This property refers to the policy holder's personal identification type.
Name
identification_number
Type
string
Description
This property refers to the policy holder's identification number.
Name
address
Type
object
Description
This property refers to the policy holder's address.
Name
line1
Type
string
Description
This property refers to the address's first line.
Name
district
Type
string
Description
This property refers to the district of the policy holder within the address object.
Name
city
Type
string
Description
This property refers to the city of the policy holder within the address object.
Name
zip_code
Type
int
Description
This property refers to the zip code of the policy holder within the address object.
Name
state
Type
string
Description
This property refers to the state of the policy holder within the address object.
To SDK devs: An enum is available for this data type.

Optional Properties

Name
coverages_optional
Type
array
Description
This optional parameter allows users to include additional coverage options provided by the previously selected insurance package. It enables users to customize their insurance policy by adding supplementary coverages beyond the standard offerings of the selected package.
Name
territoriality
Type
int
Description
This field is required if multi entry is set to true.

Read-only Properties

Certain properties are read-only and available as part of the returned entity after issuing a policy. These properties are not meant to be submitted.

Name
folio_number
Type
string
Description
The unique folio number of the tourist policy. This data is essential for identifying the policy. It's used as a reference in all policy-related transactions.
Name
document
Type
object
Description
This object contains the URLs of the policy-related documents, in PDF format. These documents include the policy agreement, coverage details, and other relevant documentation.
Name
receipt
Type
object
Description
This object contains details of the tourist policy, including the start and end dates, net premium, management fee, surcharge, tax, total premium, and commission.

POST/v1/tourist-policy/issue

Issue a tourist policy

This endpoint allows the retrieval of insurance quotes from a specific insurance provider. It can be used to obtain accurate quotes for specified insurance packages. Upon supplying the required parameters, the endpoint processes the request and provides a detailed quotation, including metadata for each coverage, such as premiums and other pertinent data.

Please refer to the Required Properties and Optional Properties sections for the definitions of the properties to be sent.

Request

POST

/v1/tourist-policy/issue

curl -X POST https://covertier.com/api/v1/policy/issue \
     -H 'Content-Type: application/json' \
     -H 'Authorization: Bearer {TOKEN}' \
     -d '{
            "insurance_company_id": {INSURANCE_COMPANY_ID},
            "package": {
                "id": {PACKAGE_ID}
            },
            "vehicle": {
                "trim_id": {TRIM_ID},
                "vin": {VEHICLE_VIN},
                "description": {VEHICLE_DESCRIPTION}
            },
            "policy_holder": {
                "name": {POLICY_HOLDER_NAME},
                "last_name": {POLICY_HOLDER_LAST_NAME},
                "birthdate": {POLICY_HOLDER_BIRTHDATE},
                "address": {
                    "line1": {ADDRESS},
                    "district": {DISTRICT},
                    "city": {CITY},
                    "zip_code": {ZIP_CODE},
                    "state": {STATE_ID}
                 },
                "mobile_number": {POLICY_HOLDER_MOBILE_NUMBER},
                "residence_type_in_mexico": {POLICY_HOLDER_RESIDENCE_TYPE_IN_MEXICO_ID},
                "personal_id_type": {POLICY_HOLDER_PERSONAL_ID_TYPE},
                "identification_number": {POLICY_HOLDER_IDENTIFICATION_NUMBER}
             },
            "is_multi_entry": {POLICY_IS_MULTI_ENTRY},
            "start_date": {START_DATE}
            "end_date": {END_DATE}
        }'

Response

{
    "data": [
        "folio_number": "040910519525000000",
        "start_date": "24/Apr/2024",
        "end_date": "24/Apr/2025",
        "document": {
            "tos": "https://qa.qualitas.com.mx:8443/poliza/t0910519525.pdf",
            "payment_voucher": "https://qa.qualitas.com.mx:8443/poliza/r0910519525.pdf",
            "only_policy_cover_page": "https://qa.qualitas.com.mx:8443/poliza/a0910519525.pdf",
            "welcome_letter": "https://qa.qualitas.com.mx:8443/poliza/b0910519525.pdf",
            "policy": "https://qa.qualitas.com.mx:8443/poliza/p0910519525.pdf"
        },
        "policy_holder": {
            "number": "0029800693",
            "full_name": "ROBERTO",
            "address": "160 EAST CALLE PRIMERA, SAN YSIDRO BLVD. SAN YSIDRO CALIFORNIA 92173",
            "district": "SAN YSIDRO",
            "city": "CALIFORNIA"
        },
        "vehicle": {
            "vin": "1GNEK13ZX3R000039"
        },
        "package": {
            "id": 1,
            "display": "Amplia",
            "display_en": "Full",
            "coverages": [
            {
                "id": 1,
                "short_name": "DM",
                "display": "Daños Materiales",
                "display_en": "Material Damage",
                "is_add_on": false,
                "is_excludable": false,
                "insured_sum": 15000,
                "deductible": 0.05,
                "premium": 313.08
            },
            {
                "id": 3,
                "short_name": "RT",
                "display": "Robo Total",
                "display_en": "Theft",
                "is_add_on": false,
                "is_excludable": false,
                "insured_sum": 15000,
                "deductible": 0.1,
                "premium": 223.63
            },
            {
                "id": 6,
                "short_name": "MC",
                "display": "Muerte del Conductor X Accidente",
                "display_en": "Driver Death",
                "is_add_on": true,
                "is_excludable": true,
                "insured_sum": 362.26,
                "deductible": 0,
                "premium": 1.27
            },
            {
                "id": 7,
                "short_name": "GL",
                "display": "Gastos Legales",
                "display_en": "Legal Expenses",
                "is_add_on": true,
                "is_excludable": true,
                "insured_sum": 3018.87,
                "deductible": 0,
                "premium": 0.01
            }
            ]
        },
        "receipt": {
            "start_date": "2024-04-24",
            "end_date": "2025-04-24",
            "net_premium": 537.99,
            "management_fee": "25",
            "surcharge": 0,
            "tax": 90.08,
            "total_premium": 653.07,
            "commission": 177.53
        }
    ]
}

GET/v1/policy/document/:insurance_company_id/:policy_number

Documents

This endpoint retrieves an array of document URLs associated with a specific insurance policy identified by its policy number. This endpoint facilitates easy access to policy-related documents, such as policy agreements, coverage details, and other relevant documentation.

Request

GET

/v1/policy/document/{insurance_company_id}/{policy_number}

curl -G https://covertier.com/api/v1/policy/document/{INSURANCE_COMPANY_ID}/{POLICY_NUMBER} \
     -H "Authorization: Bearer {TOKEN}" \

Response

{
    "data": [
        {
            "tos": "https://qa.qualitas.com.mx:8443/poliza/t0910513216.pdf",
            "payment_voucher": "https://qa.qualitas.com.mx:8443/poliza/r0910513216.pdf",
            "only_policy_cover_page": "https://qa.qualitas.com.mx:8443/poliza/a0910513216.pdf",
            "welcome_letter": "https://qa.qualitas.com.mx:8443/poliza/b0910513216.pdf",
            "policy": "https://qa.qualitas.com.mx:8443/poliza/p0910513216.pdf"
        }
    ]
}