Errors 🚩

This is a restful API; If we return any status code that isn't 200 or 201 its definitely an error.

Validation error - 422

We return this status code when request payload parameters aren't met.

Sample body

{
"message": "The given data was invalid.",
"errors": {
"name": [
"The name field is required."
],
"email": [
"The email field is required."
],
"identifier": [
"The identifier field is required."
]
}
}

Not acceptable - 406

This is returned when conditions are not met to proceed with a request in transit.

Sample body

{
"message": "you need to work to get some money"
}

Unauthorized - 401

Not allowed to continue because we do not know who you are.

Sample body

{
"message": "who are you?"
}

Forbidden - 403

Authorized but forbidden to access a specific resorce or action.

Sample body

{
"message": "you shall not pass"
}

Not found - 404

Returned when a resource or endpoint cannot be located

Sample body

{
"message": "you are definitely lost"
}

Server error - 500

You'd definitely see this when something goes wrong on our end

Sample body

{
"message": "We played a little bit too much and broke something"
}