Moody’s strongly recommends that Risk Modeler and UnderwriteIQ tenants use the Platform APIs instead of the Risk Modeler APIs for all future projects. See Migrate to Plaform APIs.

Guides

Policies

Suggest Edits

Overview

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

Security Policy

Moody's encrypts all calls to and from Moody's Intelligent Risk Platform™, including all requests and responses that leverage Risk Modeler APIs.

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

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

Versioning Policy

Moody's periodically makes updates the Risk Modeler API to introduce new resources, update existing resources, or deprecate outdated resources.

Updates to Risk Modeler API resources are recorded in the Changelog.

Risk Modeler APIs may release a new version of a resource 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 attributes returned by resource

The version is indicated by the version path in every Risk Modeler endpoint. For example, /riskmodeler/v1/accounts/{id}/analyses. The v1 version path indicates that this is the endpoint for the first version of this resource.

When a new version of a resource is released the version number is incremented and appended to the endpoint path. For example, /riskmodeler/v2/accounts/{id}/analyses. The v2 base path indicates that this is the second version of this resource.

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

Deprecation Policy

Moody's periodically deprecates and retires resources exposed by Risk Modeler APIs.

A resource is marked deprecated whenever an updated version of that resource is released.

The deprecated resource remains accessible for at least one year after it has been deprecated, but returns a Warning HTTP header in the response. The Warning header identifies the updated endpoint and the date the current endpoint will be retired. For example,

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.

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.

Multiple versions of a resource may exist at the same time. For example, both /riskmodeler/v1/accounts/{id}/analyses and /riskmodeler/v2/accounts/{id}/analyses may be accessible for a one year period. Each version of the resource is distinct, provides different functionality, and is documented separately in the API Reference documentation.

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.

Updated 20 days ago