Clerk.io Developer Documentation

Welcome to the Clerk.io Developer Documentation.

Here you find our developer documentation for our API and all our SKDs.

Get Started    

Errors

How errors are reported across the Clerk.io API.

All requests resulting in an error will return an object with the status error and the following structure:

{
  "status": "error",
  "message": "A message explaining the error.",
  "moreInfo": "http://my.clerk.io/error/{ERROR_ID}",
  "type": "ErrorType",
  "id": "{ERROR_ID}"
}
Entry
Content

status

The status of the request. This is always error.

message

A message explaining the error.

moreInfo

A link to a unique, and more detailed, error page for this error. This can also be used when in contact with our support. These reports will be deleted after 24 hours if not opened, or after 7 days of inactivity.

type

The error type. See the table of error types below.

id

The unique ID of this error instance.

Error Type
Meaning

AuthenticationError

The request could not be authenticated. This is caused by an invalid API key or a disabled account.

ParsingError

The request is either not valid JSON, or some of the parameters are missing, or it has a wrong type.

LogicalError

One or more parameters did not follow the documented behaviour.

InternalError

An unexpected error occurred. These errors are logged internally, then manually verified and fixed by our developers.

Errors


How errors are reported across the Clerk.io API.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.