API Documentation - fetchdocs

The error message is a human readable message describing the error. It is mainly used for understanding the error by developers. It is not meant to be shown to real users.

Example: API key is missing or invalid.

suggestion string

For many errors we provide suggestions how you can resolve the error on your own.

Example: Either you didn't pass an API key or it is invalid. You can find or create a new API key in the environments section. It must be passed as X-API-Key header.

trace_id string

The trace ID is a unique identifier for the request. It is used to trace the request through the system. Please provide the trace_id when reporting an error to our support team.

Example: 1b935d50c2393af77b1dc92e675876a83f92ffd6

help string

This parameter provides a way to contact support. It is mainly used for developers. It is not meant to be shown to real users.

Example: If you need help, email [email protected] and include the following Trace-ID in your message: 1b935d50c2393af77b1dc92e675876a83f92ffd6.

422 Unprocessable Entity

Content Type:

The error response is returned when the client has provided invalid data in the request.

error string

The error code is a machine readable code describing the error.

Example: VALIDATION_ERROR

message string

The error message is a human readable message describing the error. It is mainly used for understanding the error by developers. It is not meant to be shown to real users.

Example: The identity uuid field is required. | The return url field is required.

suggestion string

For many errors we provide suggestions how you can resolve the error on your own.

Example: There might be some parameters are missing or the values of parameters you have passed are invalid. Please check the payload and make sure it conforms with the rules mentioned in API doc.

trace_id string

The trace ID is a unique identifier for the request. It is used to trace the request through the system. Please provide the trace_id when reporting an error to our support team.

Example: 1b935d50c2393af77b1dc92e675876a83f92ffd6

errors object

The errors object contains a list of fields with their corresponding error messages.

Example: { "identity_uuid": [ "The identity uuid field is required." ], "return_url": [ "The return url field is required." ] }

help string

This parameter provides a way to contact support. It is mainly used for developers. It is not meant to be shown to real users.

Example: If you need help, email [email protected] and include the following Trace-ID in your message: 1b935d50c2393af77b1dc92e675876a83f92ffd6.

500 Internal Server Error

Content Type:

The error response is returned when an unknown server error occurred. Unfortunately, there is nothing you can do to resolve the error on your own. Please try again later or contact support and provide the trace_id.

error string

The error code is a machine readable code describing the error.

Example: UNKNOWN_SERVER_ERROR

message string

The error message is a human readable message describing the error. It is mainly used for understanding the error by developers. It is not meant to be shown to real users.

Example: An unknown server error occurred. Please try again later or contact support.

suggestion string

For many errors we provide suggestions how you can resolve the error on your own.

Example: Either you didn't pass an API key or it is invalid. You can find or create a new API key in the environments section. It must be passed as X-API-Key header.

trace_id string

The trace ID is a unique identifier for the request. It is used to trace the request through the system. Please provide the trace_id when reporting an error to our support team.

Example: 1b935d50c2393af77b1dc92e675876a83f92ffd6

help string

This parameter provides a way to contact support. It is mainly used for developers. It is not meant to be shown to real users.

Example: If you need help, email [email protected] and include the following Trace-ID in your message: 1b935d50c2393af77b1dc92e675876a83f92ffd6.

Response Examples

{
  "data": {
    "environment": {
      "uuid": "3598b23c-31db-4be9-9e6b-6aa1d5b60335",
      "subdomain": "demo-company",
      "theme": "default",
      "primary_color": "#ffffff",
      "secondary_color": "#ffffff",
      "border_radius": "sm",
      "shadow": "sm",
      "background_image": "data:image/png;base64,iVBORw0KGgoAAAAN...ASUVORK5CYII=",
      "background_color": "#ffffff",
      "icon_set": "",
      "show_footer_link": false,
      "logo": "data:image/png;base64,iVBORw0KGgoAAAAN...ASUVORK5CYII="
    },
    "redirect": {
      "url": "https://www.example.com/return-url"
    },
    "pages": [
      {
        "page": "imprint",
        "languages": [
          "en",
          "de"
        ],
        "is_fallback": false,
        "type": "link",
        "url": "https://www.example.com/imprint",
        "content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
      }
    ]
  }
}
    

{ "error": "API_KEY_MISSING_OR_INVALID", "message": "API key is missing or invalid.", "suggestion": "Either you didn't pass an API key or it is invalid. You can find or create a new API key in the environments section. It must be passed as X-API-Key header.", "trace_id": "1b935d50c2393af77b1dc92e675876a83f92ffd6", "help": "If you need help, email [email protected] and include the following Trace-ID in your message: 1b935d50c2393af77b1dc92e675876a83f92ffd6." }

{ "error": "VALIDATION_ERROR", "message": "The identity uuid field is required. | The return url field is required.", "suggestion": "There might be some parameters are missing or the values of parameters you have passed are invalid. Please check the payload and make sure it conforms with the rules mentioned in API doc.", "trace_id": "1b935d50c2393af77b1dc92e675876a83f92ffd6", "errors": { "identity_uuid": [ "The identity uuid field is required." ], "return_url": [ "The return url field is required." ] }, "help": "If you need help, email [email protected] and include the following Trace-ID in your message: 1b935d50c2393af77b1dc92e675876a83f92ffd6." }

{ "error": "UNKNOWN_SERVER_ERROR", "message": "An unknown server error occurred. Please try again later or contact support.", "suggestion": "Either you didn't pass an API key or it is invalid. You can find or create a new API key in the environments section. It must be passed as X-API-Key header.", "trace_id": "1b935d50c2393af77b1dc92e675876a83f92ffd6", "help": "If you need help, email [email protected] and include the following Trace-ID in your message: 1b935d50c2393af77b1dc92e675876a83f92ffd6." }