Skip to main content

error-type

Error Type
{
"name": string,
"message": string,
"code": number,
"className": string,
"data": {
"errorCode": string
}
}
PropertyTypeFormatDescriptionExample
namestringPascalCaseName of the error"BadRequest"
messagestringSentence caseMessage for developer that explains the error"Additional information is required to source data for user: birthDate"
codenumber3 digits (0-9)HTTP response status code400
classNamestringkebab-caseClass of errorbad-request
data.errorCode
enum

Possible values (see Error Codes for details):

  • "ERR001"
  • "OCE001"
  • "OCE002"
  • "OCE003"
  • "OCE004"
  • "OCE005"
  • "OCE006"
  • "OCE007"
  • "OCE008"
  • "OCE009"
  • "OCE0010"
  • "OCE0011"
  • "OCE0012"
  • "OCE0013"
  • "OCE0014"
  • "OCE0015"
3 letters and 3 digits (0-9)Verified error codeVerified specific error code (see Error Codes)"OCE011"