Overview

This page provides information about Moody's Insurance Solutions policies that apply to the Platform APIs including our security policy, versioning policy, deprecation policy, and support policy.

• The security policy defines our process for securing traffic to and from the Intelligent Risk Platform.
• The versioning policy defines our process for managing breaking changes to existing API operations.
• The deprecation policy defines our process for deprecating API operations and communicating this process to tenants.
• The Moody's Insurance Solutions Support policy defines the level of technical support provided for public API operations.

Security policy

The Moody's Insurance Solutions Security Policy defines we secure traffic to an from the Intelligent Risk Platform and the strategies and protocols that govern how the API is accessed, used, and protected.

Authentication and authorization

Access to the Intelligent Risk Platform is controlled by means of API keys and security tokens. Every request to an Moody's Insurance Solutions API operation must provide either a valid API key or security token or the request will be rejected.

API keys and access tokens enable Moody's to ensure that the correct licensing, access control, and other tenant-specific customizations are in place. To learn more, see Authentication and Authorization.

Access rights and permissions

The Platform API provides tenants with tools within the API that enable tenants to define and manage granular access controls and permissions based on role-based permissions and group-based access rights. To learn more, see Access Controls.

Encryption

All calls to and from the Intelligent Risk Platform™ are encrypted, including all requests and responses that leverage Platform API operations.

Versioning policy

The Moody's Insurance Solutions Versioning Policy defines our process for releasing new versions of API operations.

Moody's periodically makes updates to the Platform APIs to introduce new API operations, update existing API operations or the resources managed using those operations, or deprecate outdated API operations and resources. Updates to Platform API operations are recorded in the Changelog.

Platform APIs may release a new version of an API operation whenever the following changes are made:

• A change is made to the endpoint path.
• A change is made to the parameters specified in an operation request.
• A change is made to the resource properties returned by an API operation.

As soon as the new version of the service is released, the previous version of the resource is immediately deprecated.

Deprecation policy

The Moody's Insurance Solutions Deprecation Policy defines the process by which Moody's Insurance Solutions manages changes to an API and notifies Intelligent Risk Platform tenants of these changes.

Moody's Insurance Solutions marks API resources as deprecated whenever an updated version of that resource is released.

Deprecated operations remain operational for a one-year period, but are no longer recommended for use. The deprecated API resource remains accessible for at least one year after it has been deprecated. Although deprecated resources are accessible for a one year period, Moody's encourages you to transition to the updated operation as soon as possible to take advantage of greater functionality and improved workflows.

This deprecation notice serves as a formal warning to developers that an aspect of the API is scheduled to be retired or replaced in a future update.

The Deprecation Policy applies to all public API operations.

Deprecation Notifications

Moody's Insurance Solutions provides formal notification whenever an operation is deprecated and scheduled for retirement.

Moody's Insurance Solution notifies Intelligent Risk Platform tenants of deprecated API operations by means of HTTP headers, API reference documentation, API changelogs:

HTTP headers

API operations that are marked for deprecation are accompanied by a deprecation notice in a Warning HTTP header.

This deprecation notice identifies the date that the API operation will become unavailable. The Warning header identifies the updated endpoint and the date the current endpoint will be retired.

This API endpoint is deprecated, please switch to riskmodeler/v2/accounts/{id}/analyses.
Support for this endpoint will end on Wednesday, 26 Jan 2022 00:00:00 GMT.

API reference documentation

The API reference documentation for deprecated API operations are marked by an admonition that identifies the API operation as deprecated:

🍏

Deprecated

This endpoint has been deprecated. Support for this endpoint will end on Wed, 9 May 2022 00:00:00 GMT. Use the v2 operation Export data module.

API changelogs

The Platform API identifies API operations that are marked for deprecation in the changelog.

In addition, the Platform API changelog provides detailed information about all newly deprecated operations. The deprecation notice identifies the API operation, the deprecated version, the replacement version, and the end of life date. The Changelog provides information about changes to that API including new operations, updates to existing operations, and detailed information about the deprecation of existing operations.

Support Policy

The Moody's Insurance Solutions Support Policy covers all public Platform API operations.

A public API operation is any operation that is documented in Moody's Insurance Solutions Developer Portal. API operations that are not documented in the Developer Portal are not supported and not covered by the support policy,

The Moody's Insurance Solutions support policy ensures that Intelligent Risk Platform tenants are entitled to API reference documentation for all public API operations and for technical support related those operations. These public APIs are supported by Moody's Customer Support and Moody's Global Customer Success. For more information on Moody's support for the Intelligent Risk Platform see Moody's Support Guide.

Supported APIs

The Moody's Insurance Solutions Support policy covers public Intelligent Risk Platform APIs including the Risk Modeler API, Data Bridge API, Data Bridge API, Location Intelligence API, Climate on Demand API, and all Platform APIs. For a complete list of Platform APIs see Introduction to Platform APIs.

Unsupported APIs and API operations

The Moody's Insurance Solutions support policy does not apply to private or internal Intelligent Risk Platform APIs or API operations.

Unsupported APIs include all internal API that are utilized by Intelligence Risk Platform applications, but which are not documented in the Moody's Insurance Solutions Developer Portal. These include the ExposureIQ GraphQL API and TreatyIQ API. The only supported API operations for these entitlements are defined in the Platform APIs. All operations defined in these unsupported APIs are unsupported.

Unsupported API operations include all operations defined in unsupported APIs (e.g. the ExposureIQ API and TreatyIQ API) as well as supported Risk Modeler and Platform APIs.

• Private or internal Intelligent Risk Platform API operations.
• Deprecated or retired API operations.

Public Platform API operations are covered by Moody's Insurance Solutions security policy, versioning policy, and deprecation policy.

Non-public API operations are not covered by the support policy or any other Moody's Insurance Solutions policy. Unsupported API operations are liable to change at any time without notice.

Legacy API

The Legacy API is a collection of API operations that support the management of Intelligent Risk Platform domain data including model and output profiles, templates, and domain reference data.

Unlike other Platform APIs, the Legacy API consists of operations are inter-operable with the Risk Modeler API. Legacy API operations may incorporated into either Risk Modeler API workflows or Platform API operations. To learn more, see Legacy API Overview.

These Legacy API operations continue to be used by the Risk Modeler application to manage these processes. In the past these operations were private, internal API operations that were used exclusively by the Risk Modeler API. Our plan over time is to make these API operations public to Intelligent Risk Platform tenants. Undocumented Legacy API operations are not covered the Moody's Insurance Solutions Support Policy.