Errors

The following is a list of common errors you may encounter when interacting with our API:

400 Bad Request

Encountered when making a request that is passing invalid value types or is in the wrong format. Multiple validation errors will listed in the errors array:

{
  "errors": [
    {
      "field": "payer.name",
      "message": "Expected name to be of type string, but received number"
    },
    {
      "field": "filingYear",
      "message": "Expected filingYear to be of type number, but received string"
    }
  ]
}

401 Unauthorized

Typically encountered when making a request with invalid credentials.

{
  "message": "Unauthorized"
}

404 Not Found

Typically encountered when trying to fetch a record that has not been created or you don't have access to.

{
  "message": "Not Found"
}

409 Conflict

Encountered when trying to create a record with a foreignId that already exists.

{
  "message": "Conflict"
}

500 Internal Server Error

Typically encountered when something unexpected went wrong. We automatically generate high-priority tickets for these types of errors and address them ASAP.

{
  "message": "Internal Server Error"
}