Security policy

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

Access to Intelligent Risk Platform is controlled by means of API keys and security tokens. Every request to an 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 RMS 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 RMS periodically makes updates the Plaform APIs to introduce new resources, update existing resources, or deprecate outdated resources.

Updates to Platform API operations are recorded in the Changelog.

Platform 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 operation.

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 operation.

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

Deprectation policy

Moody's RMS periodically deprecates and retires resources exposed by Platform APIs.

An resource endpoint is marked deprecated whenever an updated version of that operation is released.

The deprecated operation is 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 operations are accessible for a one year period, Moody's RMS 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 operation 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 operation is distinct, provides different functionality, and is documented separately in the API Reference documentation.