A list of API error codes and how to fix them.
You may receive a 400 Bad Request
if:
A required field is missing.
"information": {
"addresses": ["This field is required."]
}
How to fix this issue
Add all the required fields to the body of your request.
You used the wrong format or data type for a field.
How to fix this issue
Format all your fields according to their data type.
Your account isn't configured to run this check or your account does not have payment configured.
How to fix this issue
Contact our support team to have your account configured for this check or to confirm that your payment method is correctly configured.
For a demo account, use this payment method.
You tried to generate a report, but the application is still processing.
How to fix this issue
Wait for the application's status
field to show Returned
before generating the final report.
You requested a check with a min
and a max
but set your min
value to a number greater than your max
value.
How to fix this issue
Edit the request's check settings to make sure that any min
values are less than or equal to the corresponding max
values.
You may receive a 401 Unauthorized
if:
You sent your request without an authorization header.
You sent your request with an authorization header, but without an API Key.
You provided an incorrect API key in the header of your request.
How to fix this issue
Add an authorization header to your request and make sure it includes your API Key.
You may receive a 403 Forbidden
if:
You sent your request to an endpoint you don't have access to.
How to fix this issue
Use the URL that corresponds to your industry and make sure you're authorized to access this endpoint.
You may receive a 404 Not Found
if:
You sent a request to retrieve all your applications, but the page number you provided doesn't exist.
How to fix this issue
Make sure the page number you entered is a valid integer and within the bounds of your expected results.
You sent a request to retrieve an application or a report, but the application ID you provided couldn't be found.
You sent a request to retrieve an application or a report, but the application ID you provided is a string of letters.
How to fix this issue
Add your application ID to the URL and make sure it's in the proper format.
You sent a request to retrieve questionnaire reference templates for a team, but the team ID you provided couldn't be found.
You sent a request to retrieve questionnaire reference templates for a team, but the team ID you provided is a string of letters.
How to fix this issue
Add your team ID to the URL and make sure it's in the proper format.
You may receive a 500 Internal Server Error
if:
Some fields in your request are using the wrong data type.
How to fix this issue
Format all your fields according to their data type. Most fields in our API take strings, while request flags take booleans.