logo

Errors

400 Bad Request

Bad Request

Response Schema: application/vnd.api+json
required
Array of objects (ErrorBadRequestError)

A list of errors that occurred.

Array
code
required
string

A code that indicates what went wrong. Please consider this an open enum, where new codes may be added over time.

Enum Value Description
INVALID_USER_INPUT

The server was unable to understand the request. Check for syntax or structural errors.

INVALID_PARAMETERS

Missing or invalid request parameters provided. See the details field for specifics.

INVALID_IDEMPOTENCY_KEY

Idempotency key is missing or was used for a dissimilar request.

INVALID_RESOURCE_LINK

The target resource URI is missing or invalid.

INVALID_VERSION_HEADER

Request contained an API version header that is not supported

INVALID_FILTER_QUERY

The filter query is malformed.

INVALID_FILTER_FIELD

Filter query is valid, but contains a field that is unsupported for this resource

INVALID_FILTER_VALUE

Filter query is valid, but contains a value in a format that is unsupported for the associated field

INVALID_FIELD_OPERATION

Indicates an filter operation that is not supported for the field

Example: "INVALID_PARAMETERS"
status
required
string

The HTTP status code for the error.

Example: "400"
detail
required
string

A message that explains the meaning of the error code. Developers are advised not to make programmatic use of this value, as it may change

Example: "The request failed because it was not in the correct format or did not contain valid data."
required
object

A list of links to resources that may be helpful in resolving the error.

object

Location in the request that may have caused the error.

required
object

Additional information about the error.

application/vnd.api+json
{
  • "errors": [
    • {
      • "code": "INVALID_PARAMETERS",
      • "status": "400",
      • "detail": "The request failed because it was not in the correct format or did not contain valid data.",
      • "links": {},
      • "source": {
        • "parameter": "filter[first_name]",
        • "pointer": "/data/attributes/first_name",
        • "header": "Accept"
        },
      • "meta": {
        • "request_id": "3c526bf4-f3c0-4c4a-a4cb-95f7db8b3bbe",
        • "trace_id": "4016616108459136584"
        }
      }
    ]
}

400 Unprocessable Account

400 Unprocessable Transfer

401 Unauthorized

Invalid authentication credentials

Response Schema: application/vnd.api+json
required
Array of objects (ErrorUnauthorizedError)

A list of errors that occurred.

Array
status
required
string

The HTTP status code for the error.

Example: "400"
detail
required
string

A message that explains the meaning of the error code. Developers are advised not to make programmatic use of this value, as it may change

Example: "The request failed because it was not in the correct format or did not contain valid data."
required
object

A list of links to resources that may be helpful in resolving the error.

object

Location in the request that may have caused the error.

required
object

Additional information about the error.

code
required
string

A code that indicates what went wrong.

Enum Value Description
INVALID_TOKEN

Provided token is missing, expired, revoked, or otherwise invalid.

UNAUTHORIZED

Authentication has not been provided or is invalid.

Example: "INVALID_TOKEN"
application/vnd.api+json
{
  • "errors": [
    • {
      • "status": "400",
      • "detail": "The request failed because it was not in the correct format or did not contain valid data.",
      • "links": {},
      • "source": {
        • "parameter": "filter[first_name]",
        • "pointer": "/data/attributes/first_name",
        • "header": "Accept"
        },
      • "meta": {
        • "request_id": "3c526bf4-f3c0-4c4a-a4cb-95f7db8b3bbe",
        • "trace_id": "4016616108459136584"
        },
      • "code": "INVALID_TOKEN"
      }
    ]
}

403 Forbidden

Not authorized to perform this operation

Response Schema: application/vnd.api+json
required
Array of objects (ErrorForbiddenError)

A list of errors that occurred.

Array
status
required
string

The HTTP status code for the error.

Example: "400"
detail
required
string

A message that explains the meaning of the error code. Developers are advised not to make programmatic use of this value, as it may change

Example: "The request failed because it was not in the correct format or did not contain valid data."
required
object

A list of links to resources that may be helpful in resolving the error.

object

Location in the request that may have caused the error.

required
object

Additional information about the error.

code
required
string

A code that indicates what went wrong.

Value Description
FORBIDDEN

Requester is not allowed to access this resource or endpoint

Example: "FORBIDDEN"
application/vnd.api+json
{
  • "errors": [
    • {
      • "status": "400",
      • "detail": "The request failed because it was not in the correct format or did not contain valid data.",
      • "links": {},
      • "source": {
        • "parameter": "filter[first_name]",
        • "pointer": "/data/attributes/first_name",
        • "header": "Accept"
        },
      • "meta": {
        • "request_id": "3c526bf4-f3c0-4c4a-a4cb-95f7db8b3bbe",
        • "trace_id": "4016616108459136584"
        },
      • "code": "FORBIDDEN"
      }
    ]
}

404 Not Found

Resource was not found

Response Schema: application/vnd.api+json
required
Array of objects (ErrorNotFoundError)

A list of errors that occurred.

Array
status
required
string

The HTTP status code for the error.

Example: "400"
detail
required
string

A message that explains the meaning of the error code. Developers are advised not to make programmatic use of this value, as it may change

Example: "The request failed because it was not in the correct format or did not contain valid data."
required
object

A list of links to resources that may be helpful in resolving the error.

object

Location in the request that may have caused the error.

required
object

Additional information about the error.

code
required
string

A code that indicates what went wrong.

Enum Value Description
RECORD_NOT_FOUND

Could not find a record with the provided ID

NOT_FOUND

Could not find resources matching the query parameters

Example: "RECORD_NOT_FOUND"
application/vnd.api+json
{
  • "errors": [
    • {
      • "status": "400",
      • "detail": "The request failed because it was not in the correct format or did not contain valid data.",
      • "links": {},
      • "source": {
        • "parameter": "filter[first_name]",
        • "pointer": "/data/attributes/first_name",
        • "header": "Accept"
        },
      • "meta": {
        • "request_id": "3c526bf4-f3c0-4c4a-a4cb-95f7db8b3bbe",
        • "trace_id": "4016616108459136584"
        },
      • "code": "RECORD_NOT_FOUND"
      }
    ]
}

500 Unexpected Error

Unexpected error occured

Response Schema: application/vnd.api+json
required
Array of objects (ErrorUnexpectedError)

A list of errors that occurred.

Array
status
required
string

The HTTP status code for the error.

Example: "400"
detail
required
string

A message that explains the meaning of the error code. Developers are advised not to make programmatic use of this value, as it may change

Example: "The request failed because it was not in the correct format or did not contain valid data."
required
object

A list of links to resources that may be helpful in resolving the error.

object

Location in the request that may have caused the error.

required
object

Additional information about the error.

code
required
string

A code that indicates what went wrong.

Value Description
UNEXPECTED_ERROR

This one is on us. Something unexpected went wrong

Example: "UNEXPECTED_ERROR"
application/vnd.api+json
{
  • "errors": [
    • {
      • "status": "400",
      • "detail": "The request failed because it was not in the correct format or did not contain valid data.",
      • "links": {},
      • "source": {
        • "parameter": "filter[first_name]",
        • "pointer": "/data/attributes/first_name",
        • "header": "Accept"
        },
      • "meta": {
        • "request_id": "3c526bf4-f3c0-4c4a-a4cb-95f7db8b3bbe",
        • "trace_id": "4016616108459136584"
        },
      • "code": "UNEXPECTED_ERROR"
      }
    ]
}
➔ Next to Client Portal