Docs

ClerkAPIError

An interface that represents an error returned by the Clerk API.

  • Name
    code
    Type
    string
    Description

    A string code that represents the error, such as username_exists_code.

  • Name
    message
    Type
    string
    Description

    A message that describes the error.

  • Name
    longMessage
    Type
    string
    Description

    A more detailed message that describes the error.

  • Name
    meta
    Type
    object
    Description

    Additional information about the error.

The meta property consists of the following structure:

  meta?: {
    paramName?: string;
    sessionId?: string;
    emailAddresses?: string[];
    identifiers?: string[];
    zxcvbn?: {
      suggestions: {
        code: string;
        message: string;
      }[];
    };
    permissions?: string[];
  };

Feedback

What did you think of this content?