v3

latestOpenAPI 3.0.0raw.githubusercontent.com2025-03-19480223.6 KB
Utils

Retrieves detailed error data related to the error code.

This endpoint is used to retrieve detailed error data related to the error code. The endpoint is referenced within error responses for other API endpoints to provide more information about the error. This endpoint provides a JSON based response and can thus be used for programmatic error handling, but can also provide plain text error messages for human readability and usage in UI.

get/dx/api/people/v1/errors/{errorCode}

Path parameters

The error code to retrieve detailed error data for.

Query parameters

The format of the response. Can be either "json" or "text". Default is "json".

Response

Error retrieval successful.