Responses

The error response object will contain information about the nature of the error.

{
  "message": "Access token expired.",
  "errorCode": "tokenExpired",
}

HTTP Code	Error Code	Error Message
400	`validationFailed`	Validation failed, please modify your request and try again.
401	`tokenExpired`	Access token expired.
401	`missingAuthorization`	Access token is missing or invalid.
403	`notAuthorized`	Request not authorized.
404	`notFound`	Resource not found, please validate the requested unique identifier.
500	`serverError`	An error has occurred, please try your request again or contact support.

In the case of validation errors, the error object may also contain a fieldErrors array with details about specific fields which did not pass validation. Fields will be specified in JSONPath notation.

{
  "message": "Validation failed, please modify your request and try again.",
  "errorCode": "validationFailed",
  "fieldErrors": [
    {
      "message": "First name is required",
      "errorCode": "required",
      "field": "$.applicant.firstName"
    }
  ]
}

Field Error Code	Field	Error Message
`required`	`$.applicant.firstName`	First name is required.