Response messages

Edit online

Information about the various errors and response messages that Verify application programming interfaces (APIs) return.

HTTP status codes indicate whether an operation is successful or not. The following types of errors can be returned when you send requests and get responses from the Verify APIs:

2xx success: Indicates the success status of the operation.
4xx client errors: Indicates a problem with the request that the client application submitted. Fix the problem in the request before you resubmit the request.
5xx server errors: Indicates a problem with the server. Resubmit or retry the request until it succeeds.

The body of the response contains a message identifier (messageId) and text that is translated into the locale of the requester (messageDescription).

Table 1. Response messages
HTTP Status Code	Description
200	Successful retrieval of an object
201	Successful creation of an object
202	Request was accepted but not completed (asynchronous operation).
204	Requested operation such as update or deletion of an object was successful.
207	Multi Status - a mixture of results were returned. This status can occur with PATCH and bulk operations.
400	Bad request. The request was malformed or cannot be handled. The input parameters might contain invalid values.
401	The client was not authenticated. For example, the access token that is used is not valid.
403	Forbidden access. For example, the access token does not allow access to the requested resource.
404	Resource was not found. The requested information does not exist.
405	HTTP Method that is specified in the request is not supported by the resource.
406	The resource cannot produce representation that is specified in the Accept header of the request.
409	The information exists.
415	The resource cannot consume representation that is specified in the Content-Type header of the request.
429	Too many requests
500	Internal server error occurred while processing the request.
501	The requested method was disabled.
502	Notification was not sent.

If all operations are successful during PATCH operations, a

status is returned. If there are one or more failures, a 207 status is returned and the client can parse the results.

If all operations are successful during bulk management operations like POST or DELETE, a

status is returned. If there are one or more failures, a 207 status is returned and the client can parse the results.

For error handling, use the HTTP response code and messageId from the error response body. The messageDescription is to be used for information only, and is subject to change. Any such changes do not constitute changes to the API semantics.