Integration checklist
To confirm your integration has been built and tested in accordance with the Maxsight integration framework, you should ensure you've completed the steps of the integration checklist.
Note
Give us as much prior knowledge of your integration as possible. This allows us to communicate internally with the relevant teams and provide you with the necessary support.
As soon as you begin work on your integration, let us know by contacting passfort_partners@moodys.com.
Confirm all required endpoints exist.
Depending on your check template, there are a number of additional endpoints that may be required but are not checked or tested in the validation suite. For example, monitored callback integrations must also implement the
cancel_checksendpoint.Confirm your integration name.
This seems obvious, but the name specified on your metadata endpoint is displayed in the exact same way in the data provider drop-down list in Maxsight. Changing the name requires a re-run of the process.
Confirm your credentials and configuration options.
You should aim to make integrations as configurable as possible to cater for as many customers and use cases as possible without the need for code changes or workarounds. Ensure the required credentials and configuration options are present and working as per the Configuration endpoint.
This should include confirming if any API token or password fields should be in the password format and not plain text or string.
Pass the platform validation suite.
This ensures that your metadata endpoint and config endpoint options are valid and where they should be, as well as tests your integration works as it should in demo institutions.
Test your integration.
After passing the validation suite, you should test your integration and prepare it for live deployment.
The validation suite ensures your integration has the necessary authentication and demo responses, but it doesn't test how your integration behaves under live conditions.
We recommend you run bulk tests of your integration with requests that contain too much, too little, and invalid data to ensure your integration responds appropriately. The reason for this is that Maxsight doesn't need to be used exclusively through the user interface. Many users use Maxsight as an API only, meaning they can create and send their own requests which may not contain the same fields as you'd expect from a request triggered through the portal.
Confirm your documentation is ready and up to date.
Implementation and solution specialists, as well as support, rely on documentation to get your integration setup working as effectively for customers as possible. We advise including the following details:
How to add your integration to an institution in the platform. This should include a description of what the provider configuration options are and how they impact the check result, as well as how required credentials are assigned.
Best practices for configuring a check using your integration in platform. This should include where it is expected to run the a policy, and how different tasks are used by your integration.
Additional details about how your integration works, for example whether it relies on any other data sources to operate correctly like Moody's Orbis.
How any outputs are determined by your integration, for example how matching thresholds or scoring are used.
Request your integration be made live.
Once ready, we can make your integration live. As soon as you know your preferred go live date, email passfort_partners@moodys.com with the date, your integration URL, and any other relevant information.
It's often advisable to put certain institutions on an allow list for the initial release. If this is the case, include a list of the institution IDs that you'd like to have initial access to your integration. These can be removed at a later date as required.
Share test/demo credentials with us.
Our implementation engineers and our integration team require a set of valid credentials to demo your integration and provide support respectively.
Share test/demo credentials with us using the passfort_partners@moodys.com email.