API Reference

This API documentation provides information about the error codes that the API endpoints can return.

Famasi Africa's API is RESTful, so we use conventional HTTP response codes to indicate whether your request was successful or a (hopefully rare) massive fail.

This way, you can always tell if something goes wrong and fix it without wasting time.

Try out the API to see for yourself.

Error CodesDescriptions
200, 201Woo-hoo, success alert! Your request went through like a charm and the intended action has been carried out! You can sit back, relax and revel in the fact that everything worked out just the way you wanted it to.
400Uh-oh! Looks like we've got a bit of an issue here. We got a validation or client side error message and regrettably, your request could not be fulfilled. Don't panic, though! Double-check your request, try again and let's get this sorted out. We've got your back!
401Oops! Sorry to say but your request was not authorised. This can happen if you pass an invalid key in the authorisation header or if you forget to send it altogether. Double-check your authorisation details and make sure you're following the correct procedure. Let's make some magic happen!
404Well, well, it looks like we've got an error on our hands! Unfortunately, your request can't be fulfilled as the requested resource doesn't exist. Don't worry; it's probably just a simple mistake that can be easily fixed. Check the resource details again and ensure that all necessary parameters are correctly inputted.
500, 501, 502, 503, 504Oh snap! We're so sorry but it seems like there's been an error on our end and your request couldn't be fulfilled. This definitely shouldn't happen, so please let us know right away if you encounter this issue! Your smooth experience is important to us!