Skip to content
Last updated

Errors

The Solaris API uses standard HTTP response codes to indicate the success or failure of a request.

  • 2xx: Success.
  • 4xx: Client Error (e.g., missing parameters, validation failed, invalid token).
  • 5xx: Server Error (something went wrong on the Solaris platform).

Error response format

Solaris error responses follow a standard JSON format. The response body contains an errors array, allowing multiple errors to be returned for a single request (e.g., multiple validation failures).

Response attributes

AttributeTypeDescription
idstringUnique Error ID. Include this ID when contacting Solaris Support.
statusintegerThe HTTP status code (e.g., 400).
codestringMachine-readable error code (e.g., invalid_model).
titlestringHuman-readable generic error title.
detailstringSpecific details about what went wrong.
sourceobject(Optional) Identifies the specific field that caused the error. Contains field and message.

Example error response (400 Bad Request)

{
    "errors": [
        {
            "id": "84b61fb9bf2117b3653a91ba9fc18d8bex",
            "status": 400,
            "code": "invalid_model",
            "title": "Invalid Model",
            "detail": "employment_status is not included in the list...",
            "source": {
                "field": "employment_status",
                "message": "is not included in the list..."
            }
        }
    ]
}

Common error codes

400 Bad Request

JSON CodeTitleDescription
invalid_modelInvalid ModelA parameter failed validation constraints (e.g., blank, too long).
invalid_webhook_urlInvalid Webhook URLThe provided URL returned a non-200 status during verification.
unsafe_webhook_urlUnsafe Webhook URLThe URL is not HTTPS.
validation_errorValidation ErrorGeneral validation failure.
type_errorType ErrorA parameter had the wrong data type (e.g., String instead of Integer).
invalid_jsonInvalid JSONThe request body was not properly formatted JSON.

401 Unauthorized / 403 Forbidden

JSON CodeTitleDescription
invalid_tokenInvalid TokenThe Access Token is expired or malformed.
token_requiredToken RequiredNo Authorization header was provided.
unauthorized_partnerUnauthorized PartnerYour partner account is not permitted to access this resource.
unauthorized_actionUnauthorized ActionYour token scopes do not allow this specific HTTP method.
authorization_requiredAuthorization RequiredThe action requires a Change Request authorization (SCA).
invalid_tanInvalid TANThe SMS OTP or Device Signature was incorrect.

404 Not Found / 409 Conflict

JSON CodeTitleDescription
model_not_foundModel Not FoundThe requested resource ID does not exist.
record_not_uniqueRecord Not UniqueA unique constraint was violated (e.g., mobile number already exists).

5xx Server Errors

JSON CodeTitleDescription
generic_errorGeneric ErrorInternal server error. Please retry or contact support.
not_implemented_errorNot ImplementedThis endpoint is not yet available.
bad_gatewayBad GatewayUpstream error.
gateway_timeoutGateway TimeoutThe request took too long to process.

Requesting support

If you encounter persistent errors, please contact Solaris Support. To ensure a fast resolution, ensure you include the following:

  1. The Error ID: Found in the id field of the error response.
  2. The Endpoint: The URL and HTTP method you called.
  3. Timestamp: When the error occurred.
Log Retention

Solaris stores request logs for 30 days. Please report issues promptly. Note that for security reasons, Solaris does not store the request payload (body) in the logs.

Previous page
Next page