Get Quote Endpoints: GetInsurerLocations

API endpoints for retrieving quotes, inclusions, and insurance

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 / Insurance

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

Use the HTTP Method 'GET' for consuming this web service.

URL Examples

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

Parameters (Query Params)

Key	Format	Notes	Mandatory
supplier_id	string	Get a list of Insurer Locations for a specific Insurer (Supplier).	No
policyownertype	string	Get a list of Insurer Locations for a specific Policy Owner. Choose from 'insurer_internal', 'client' or 'driver'.	No
name	string	This field supports the wildcard % operator (See Wildcard % operator notes below).	No
page	string	Skip to a specific page of results.	No
page_size	string	Number of records to return per page.	No

Wildcard % operator notes:

If you are using "Postman" app, with the wildcard operator, the search string of either %ab% or %ba%, will give this response:

"field_name": {"isEmpty": "Value is required and can't be empty"}.

If you need to search either %ab% or %ba%, please use %25ab%25 or %25ba%25 as required to return results as expected.

GetLtiPlans

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

Supplementary SWAGGER documentation is available here: https://api.test.catch-e.com/docs/#/Quote%20%2F%20Loan%20Termination%20Insurance(https://api.test.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

Use the HTTP Method 'GET' for consuming this web service.

URL Examples

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

Parameters (Query Params)

Key	Format	Notes	Mandatory
ltiplancode	string	Get values for a specific LTI Plan. This field supports the wildcard % operator (See Wildcard % operator notes below).	No
page	number	Optional page number. Default 1 page.	no
page_size	number	Optional page size. Default 25 records per page.	no

Wildcard % operator notes:

If you are using "Postman" app, with the wildcard operator, the search string of either %ab% or %ba%, will give this response:

"field_name": {"isEmpty": "Value is required and can't be empty"}.

If you need to search either %ab% or %ba%, please use %25ab%25 or %25ba%25 as required to return results as expected.

GetLtiTopUpBenefits

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

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

Use the HTTP Method 'GET' for consuming this web service.

URL Examples

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

Parameters (Query Params)

Key	Format	Notes	Mandatory
name	string	Get values for LTI Top Up Benefits. This field supports the wildcard % operator (See Wildcard % operator notes below).	No
page	number	Optional page number. Default 1 page.	no
page_size	number	Optional page size. Default 25 records per page.	no

Wildcard % operator notes:

If you are using "Postman" app, with the wildcard operator, the search string of either %ab% or %ba%, will give this response:

"field_name": {"isEmpty": "Value is required and can't be empty"}.

If you need to search either %ab% or %ba%, please use %25ab%25 or %25ba%25 as required to return results as expected.