GetInsurerLocations

Supporting API for patchQuote. Returns a list of Insurance Locations as seen on Comprehensive Insurance profile.

Supplementary SWAGGER documentation is available here: api.catch-e.com/docs/#/Quote%20%2F%20Insurance

Permissions

To run this API, the nominated 'web-services' role needs to be given permission.

If you are not actively using the API, leave the permission off for better security.

Go to Roles / APIs and check on InsurerLocations:Get.

Note: This API is not configured for external use. Contact your Account Manager to discuss access to this API.

Authentication

Authenticate with the API before running this API.

HTTP Method

GET

URL

https://api.catch-e.com/qt/insurer-locations

Query Parameters

Key

Format

Notes

Mandatory

supplier_id

string

Get list of Insurer Locations for specific Insurer (Supplier)

No

policy_owner_type

string

Get list of Insurer Locations for specific Policy Owner. Choose from: 'insurer_internal', 'client', 'driver'

No

name

string

Supports wildcard % operator (See Wildcard % operator notes below)

No

page

string

Skip to specific page of results

No

page_size

string

Number of records to return per page

No

Wildcard % Operator Notes

If using Postman, wildcard searches like %ab% or %ba% may return: "field_name": {"isEmpty": "Value is required and can't be empty"}. Use URL encoding instead: %25ab%25 or %25ba%25 to return results as expected.

GetLtiPlans

Supporting API for patchQuote. Returns a list of LTI Plan details as seen in the Loan Termination Insurance (LTI) profile.

Supplementary SWAGGER documentation is available here: https://api.catch-e.com/docs/#/Quote%20%2F%20Loan%20Termination%20Insurance

Permissions

To run this API, the nominated 'web-services' role needs to be given permission.

If you are not actively using the API, leave the permission off for better security.

Go to Roles / APIs and check on LtiPlans:Get.

Note: This API is not configured for external use. Contact your Account Manager to discuss access to this API.

Authentication

Authenticate with the API before running this API.

HTTP Method

GET

URL

https://api.catch-e.com/qt/lti-plans

Query Parameters

Key

Format

Notes

Mandatory

lti_plan_code

string

Get values for specific LTI Plan. Supports wildcard % operator (See Wildcard % operator notes below)

No

page

number

Optional page number. Default: 1

No

page_size

number

Optional page size. Default: 25 records per page

No

Wildcard % Operator Notes

If using Postman, wildcard searches like %ab% or %ba% may return: "field_name": {"isEmpty": "Value is required and can't be empty"}. Use URL encoding instead: %25ab%25 or %25ba%25 to return results as expected.

GetLtiTopUpBenefits

Supporting API for patchQuote. Returns a list of LTI Top Up Benefits as seen in the Loan Termination Insurance (LTI) profile.

Supplementary SWAGGER documentation is available here: https://api.catch-e.com/docs/#/Quote%20%2F%20Loan%20Termination%20Insurance

Permissions

To run this API, the nominated 'web-services' role needs to be given permission.

If you are not actively using the API, leave the permission off for better security.

Go to Roles / APIs and check on LtiTopUpBenefits:Get.

Note: This API is not configured for external use. Contact your Account Manager to discuss access to this API.

Authentication

Authenticate with the API before running this API.

HTTP Method

GET

URL

https://api.catch-e.com/qt/lti-top-up-benefits

Query Parameters

Key

Format

Notes Mandatory

name

string

Get values for LTI Top Up Benefits. Supports wildcard % operator (See Wildcard % operator notes below)

No

page

number

Optional page number. Default: 1

No

page_size

number

Optional page size. Default: 25 records per page

No

Wildcard % Operator Notes

If using Postman, wildcard searches like %ab% or %ba% may return: "field_name": {"isEmpty": "Value is required and can't be empty"}. Use URL encoding instead: %25ab%25 or %25ba%25 to return results as expected.