Skip to main content

If you are using our backend SDK that is lesser than the following versions, please visit the older documentation link here.

Custom error response using GENERAL_ERROR status

Sometimes, you may want to send a custom error message from your API override to display to the user on the frontend. This can be done by sending the following JSON response from the API:

"status": "GENERAL_ERROR",
"message": "Some custom error message"

If you are using our pre-built ReactJS UI, the above response will render the mesage "Some custom error message" on the frontend UI. For custom UI, you can read this response and display the message in an error UI. This response can be returned from most of the APIs exposed by the backend SDK.

Let's take an example in which we want to prevent the user from signing up (via email / password) unless their email is preapproved by the app's admin. For this, we will override the sign up API to check if the input email is approved or not, and if not, we prevent the sign up, and send a custom error message.

import EmailPassword from "supertokens-node/recipe/emailpassword";

override: {
apis: (oI) => {
return {
signUpPOST: async function (input) {
let email = input.formFields.find(i => === "email")!.value;

if (emailNotAllowed(email)) {
return {
status: "GENERAL_ERROR",
message: "You are not allowed to sign up. Please contact the app's admin to get permission"
return oI.signUpPOST!(input);

function emailNotAllowed(email: string) {
// TODO: your impl to check if email is allowed or not
return true;
Looking for older versions of the documentation?
Which UI do you use?
Custom UI
Pre built UI