Error and Information Messages

Errors are described by a combination of HTTP status code and a Direct+ error code.

IMPORTANT: Please note HTTP status codes are very limited, hence same HTTP status code is returned for various failure responses. Detailed error code returned in the JSON response body uniquely identifies each scenario. It is recommended to use detailed error code for taking further action.

For Authentication v3 API

Below is the format of the JSON response if an error occurs:

{
    "error": "invalid_request",
    "error_description": "Request missing required element: 'grant_type'. ErrorCode: 05007. Transaction ID:  rrt-0c5f3f6b3060c885d-d-ea-19761-46826861-22"
}

Please refer here for the list of errors returned by Authentication V3 API.

For all other Direct+ APIs

There are two formats in the JSON response if an error occurs:

For Web Visitor (WVI)

{...
        "result": {
            "errorMessage": "Access token expired",
            "errorCode": "00040",
            "actionStatus": "401"
        }
    }

For all other APIs

{...
        "error": {
            "errorCode": "10001",
            "errorMessage": "DUNS not found"
        }
    }
{...
	"error": {
		"errorCode": "10002",
		"errorMessage": "Invalid parameters.",
		"errorDetails": [{
			"parameter": "reportFormat",
			"description": "'reportFormat' element contains Invalid value: 'HTML/PDF' in the request."
		}]
	}
    }