When opening a support ticket for an API issue, providing the right technical details helps DQE Support reproduce the behavior, identify the service involved, and investigate faster.
Required context
- your organization name;
- the DQE service or API concerned;
- the environment used, such as production, staging, test, or sandbox;
- the endpoint and HTTP method;
- the date and time of the request, including timezone;
- the business impact of the issue.
Request and response details
Include a complete example whenever possible. Remove or mask sensitive information such as credentials, tokens, licences, and personal data before sharing it in a ticket.
- request parameters or body;
- headers used, with sensitive values masked;
- response body;
- HTTP status code if available;
- error message returned by the API;
- correlation ID or request ID if available.
Expected behavior
Explain what result you expected and why. If the issue concerns address, email, phone, or geocoding results, include the expected validation or response outcome.
Recent changes
Mention any recent changes that may have affected the integration, such as deployment, network update, credential change, endpoint change, new environment, or configuration update.
Related articles
- How to troubleshoot API authentication issues
- Why is my API request rejected?
- Why does the API return no result?