Status and error codes

The Kiteworks API adheres to standard RESTful practices by using conventional HTTP response codes to clearly define the status of every API request.

Success (2xx): These codes confirm that your request was successfully received, understood, and processed (e.g., 200 OK or 201 Created).
Client Errors (4xx): These indicate that the request could not be completed due to the information provided by the client. This range covers issues such as validation errors, missing required parameters, authentication failures, or business logic failures like a declined card.
Server Errors (5xx): These codes are reserved for rare, unexpected internal failures. They indicate that while your request appears valid, our infrastructure encountered an issue and was unable to fulfill it.

List of status and error codes

Name	Reason	Description
200	OK	The request was successful.
201	Created	An object was created successfully. In cases of action endpoints, the action was successful.
204	Deleted	The object was deleted successfully.
401	Unauthorized	Authentication is required and has failed or has not yet been provided.
403	Forbidden	The request was valid, but the server refuses action. This may be because of insufficient permissions.
404	Not found	The requested resource was not found.
409	Conflict	The request could not be processed because of conflict in the current state of the resource.
422	Unprocessable Entity	The request was well-formed (i.e., syntactically correct) but could not be processed. This is usually caused by an invalid parameter (or parameter value) being present in the request body.
490	Request blocked by WAF	The request was blocked by Web Application Firewall.
503	Service Unavailable	The request cannot be processed due to server maintenance.

Name	Description
code	A machine-readable identifier for the specific error type. This is usually used for programmatic error handling.
field	Indicates which specific field name in the request triggered this error. This parameter only appears for errors like 422 Unprocessable Entity, where the request could not be processed due to an invalid parameter or value in the request body.
message	A human-readable description providing details about the error that occurred.