Skip to main content

Error codes

When you make an API call to Signicat and an error occurs, you will receive a response message with an error code.

If you have encountered an error, check the information on this page to investigate what might have caused the error. Specifically, the errors listed here are generic to all Signicat APIs.

If you require assistance, you can contact us by creating a support ticket in the Signicat Dashboard.

Error object​

A generic error object contains the following fields:

Additional fields

Many APIs also define additional error fields to address and communicate product-specific errors.

Example of an error​

Generic error

An example response with a generic error object:

{
    "type": "https://developer.signicat.com/docs/error-codes/",
    "title": "Invalid authentication token.",
    "detail": "The authentication token provided is invalid. This may be due to an incorrect signature, expiration, or insufficient permissions.",
    "code": "invalid_token"
}

Validation error

When validation of request parameters fails, you receive an error message similar to:

{
    "type": "https://api.signicat.com/mobileid/core/openapi.json",
    "title": "Invalid request parameter",
    "code": "invalid_request_parameter",
    "status": 400,
    "traceId": "4bf239c088089f2bca77d3a413909f1d",
    "detail": "Your request body parameters have failed validation."
    "invalidParams": [
        {
            "name": "userId"
            "reason": "userId cannot be null or empty"
        },
        {
            "name": "deviceId"
            "reason": "deviceId cannot be null or empty"
        }
    ]
}

The invalidParams describes which request parameters have failed the validation, so that you can modify them to pass the validation.

Generic error codes​

Product-specific error codes​

All APIs can return generic error codes. There are also error codes specific to a service, such as an API product or a protocol.

To learn more about error codes and descriptions specific to a service, visit the respective documentation:

Last updated:
On this page