Quickstart to building a Maxsight integration
Building an integration with Maxsight requires a number of steps and considerations to meet the requirements of the integration framework.
Determine your check type. The check type determines the kind of information you’ll provide to Maxsight users. For example, the Identity check type is used to confirm an individual is who they say they are, and the Company data check type is used to get basic information about a company. Learn more About check types.
Determine your check template. For example, one-time sync or one-time callback. The check template determines how the check behaves, including how long it takes to return the check result and whether you provide ongoing monitoring or not. Note that each check type supports specific templates, as described in the documentation.
Consider how you’ll map your data to the check result. We ask that you use the structures described in this documentation. Note that when Maxsight displays check data to the user, there may be slight differences or certain fields may be hidden.
Consider which configuration options you’d like to provide Maxsight customers. You could, for example, allow customers to specify which countries users can run the check for or require customers to provide authorization credentials. Any configuration options returned from the Configuration endpoint are displayed in Maxsight for customers to see and engage with.
Check the associated workflow and integration endpoints required, based on your check type and template.
Check the associated data schemas for requests to and responses from your integration.
Build your integration REST API.
Complete the integration checklist to confirm your integration has been built and tested in accordance with the integration framework.