Skip to main content

Integration troubleshooting

This topic offers guidance to some commonly experienced issues and possible resolutions.

Issue

Possible cause

Possible solution

New entity stuck “In-progress“ or “Automating…“

Invalid or no response from your integration.

An invalid response from your integration isn't processed, but the check doesn't fail automatically. Maxsight continues to reattempt the check, hoping for a valid response which is why it sits in the status it does. This continues until the check deadline passes.

Check your integration is returning a valid JSON response with a 200 status code. Using the same request JSON and checking how your integration responds is the quickest way to do this.

For check types such as COMPANY_SCREENING and INDIVIDUAL_SCREENING, ensure the number of items in the check_output.screening_hits.flags array does not exceed the flag limit, currently set at 400.

Error: "A data provider has not been configured for this country"

Under the assumption this is not a genuine configuration error; check your check configuration for any country specific settings:

Your JSON response contains the check_output field when returning a handled error.

Ensure that when you are returning an error, either a handled error object or a result.decision as ERROR, that you do not include the check_output field. To learn more about how to correctly return errors, see Request/response examples.

If the check_output field is present along with an error, Maxsight attempts to run additional validations which ultimately fail leading to this error.

Unable to display handled errors

Your JSON response is invalid.

When handling errors in Maxsight, you don't need to include additional fields beyond errors and warnings.

The response status code should always be 200 regardless that you are returning an error.

The following could be a valid error response. Note that only errors and warnings are included:

{
  "errors": [
    {
      "type": "MISSING_CHECK_INPUT",
      "message": "The request is missing required fields."
    }
  ],
  "warnings": [] 
}

For more information, see About error types.

Error adding associates to verification list with error:

"An error occurred whilst adding officers/shareholders to the verification list. Try again later."

This presents itself as a 500 status code at the API level.

This can be due to two possible reasons:

  1. You haven't configured the task with an assessment for associates to apply.

  2. The data returned for the associate doesn't meet the minimum data requirements required by the data provider running checks on the associate.

For reason 1, do the following:

  1. Go to the associated task that you're running. This is the Identify officers, Identify shareholders, or Identify trustees task.

  2. Add an assessment to the Assessment to start for associate entities drop-down.

  3. Ensure that the assessment has a workflow set for both individuals and companies because both of these can be associates.

For reason 2, do the following:

  1. Check what data fields are required for the data provider you're trying to run on the associates. For example, does it need name, address, and DOB?

  2. Once you know what fields are required for the check to run, you can check to see if the data for the associated entity is available or not. If it is not, you must add the data manually to run the check on the associated entity.

Additional information

In this section: