Errors

Check uses standard HTTP response codes to indicate the success or failure of an API request. Codes in the 2xx range indicate success, codes in the 4xx range indicate client errors, and codes in the 5xx range indicate a server error that we will immediately work to fix. All Check errors conform to the following schema:

Attribute

Description

type
string

Type of the error.

message
string

Description of the error and how to fix it.

input_errors
list

Optional. Array of input error objects. Each input error object contains field, field_path, and message string attributes.

For example, the following JSON error will be returned when attempting to update a Payroll resource with a nested payroll item that's missing an employee field:

{
  "error": {
    "type": "validation_error",
    "message": "Please correct the required fields and try again.",
    "input_errors": [
      {
        "message": "This field is required.",
        "field": "employee",
        "field_path": ["items", "0", "employee"]
      }
    ]
  }
}