{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-api-reference/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Errors","siteUrl":"https://docs.solarisgroup.com/","description":"Official technical reference for Solaris Embedded Finance APIs (Banking, Lending, KYC).","keywords":"Banking-as-a-Service, BaaS, Embedded Finance, Solaris, solarisbank, solarisgroup, solaris group, fintech, api reference docs, developer portal","lang":"en-US","llmstxt":{"hide":false,"title":"Solaris Developer Hub","description":"Comprehensive documentation for Solaris Embedded Finance APIs.","sections":[{"title":"Guides and release notes","includeFiles":["guides/**/*.md","release-notes/**/*.md","help/**/*.md"],"excludeFiles":[]},{"title":"API reference","includeFiles":["api-reference/**/*.yaml","api-reference/**/*.md"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"errors","__idx":0},"children":["Errors"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Solaris API uses standard HTTP response codes to indicate the success or failure of a request."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["2xx:"]}," Success."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["4xx:"]}," Client Error (e.g., missing parameters, validation failed, invalid token)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["5xx:"]}," Server Error (something went wrong on the Solaris platform)."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"error-response-format","__idx":1},"children":["Error response format"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Solaris error responses follow a standard JSON format. The response body contains an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}," array, allowing multiple errors to be returned for a single request (e.g., multiple validation failures)."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response-attributes","__idx":2},"children":["Response attributes"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Attribute"},"children":["Attribute"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Unique Error ID."]}," Include this ID when contacting Solaris Support."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The HTTP status code (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]},")."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["code"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Machine-readable error code (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["invalid_model"]},")."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["title"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Human-readable generic error title."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["detail"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Specific details about what went wrong."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["source"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["(Optional) Identifies the specific field that caused the error. Contains ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["field"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-error-response-400-bad-request","__idx":3},"children":["Example error response (400 Bad Request)"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"errors\": [\n        {\n            \"id\": \"84b61fb9bf2117b3653a91ba9fc18d8bex\",\n            \"status\": 400,\n            \"code\": \"invalid_model\",\n            \"title\": \"Invalid Model\",\n            \"detail\": \"employment_status is not included in the list...\",\n            \"source\": {\n                \"field\": \"employment_status\",\n                \"message\": \"is not included in the list...\"\n            }\n        }\n    ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"common-error-codes","__idx":4},"children":["Common error codes"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"400-bad-request","__idx":5},"children":["400 Bad Request"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"JSON Code"},"children":["JSON Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Title"},"children":["Title"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["invalid_model"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Invalid Model"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["A parameter failed validation constraints (e.g., blank, too long)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["invalid_webhook_url"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Invalid Webhook URL"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The provided URL returned a non-200 status during verification."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unsafe_webhook_url"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Unsafe Webhook URL"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The URL is not HTTPS."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["validation_error"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Validation Error"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["General validation failure."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type_error"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Type Error"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["A parameter had the wrong data type (e.g., String instead of Integer)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["invalid_json"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Invalid JSON"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The request body was not properly formatted JSON."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"401-unauthorized--403-forbidden","__idx":6},"children":["401 Unauthorized / 403 Forbidden"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"JSON Code"},"children":["JSON Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Title"},"children":["Title"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["invalid_token"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Invalid Token"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The Access Token is expired or malformed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["token_required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Token Required"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," header was provided."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unauthorized_partner"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Unauthorized Partner"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Your partner account is not permitted to access this resource."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unauthorized_action"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Unauthorized Action"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Your token scopes do not allow this specific HTTP method."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authorization_required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Authorization Required"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The action requires a Change Request authorization (SCA)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["invalid_tan"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Invalid TAN"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The SMS OTP or Device Signature was incorrect."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"404-not-found--409-conflict","__idx":7},"children":["404 Not Found / 409 Conflict"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"JSON Code"},"children":["JSON Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Title"},"children":["Title"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["model_not_found"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Model Not Found"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The requested resource ID does not exist."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["record_not_unique"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Record Not Unique"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["A unique constraint was violated (e.g., mobile number already exists)."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"5xx-server-errors","__idx":8},"children":["5xx Server Errors"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"JSON Code"},"children":["JSON Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Title"},"children":["Title"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["generic_error"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Generic Error"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Internal server error. Please retry or contact support."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["not_implemented_error"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Not Implemented"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["This endpoint is not yet available."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bad_gateway"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Bad Gateway"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Upstream error."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["gateway_timeout"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Gateway Timeout"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The request took too long to process."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"requesting-support","__idx":9},"children":["Requesting support"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you encounter persistent errors, please ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/help/"},"children":["contact Solaris Support"]},". To ensure a fast resolution, ensure you include the following:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["The Error ID:"]}," Found in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," field of the error response."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["The Endpoint:"]}," The URL and HTTP method you called."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Timestamp:"]}," When the error occurred."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Log Retention"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Solaris stores request logs for ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["30 days"]},". Please report issues promptly. Note that for security reasons, Solaris ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["does not"]}," store the request payload (body) in the logs."]}]}]},"headings":[{"value":"Errors","id":"errors","depth":1},{"value":"Error response format","id":"error-response-format","depth":2},{"value":"Response attributes","id":"response-attributes","depth":3},{"value":"Example error response (400 Bad Request)","id":"example-error-response-400-bad-request","depth":3},{"value":"Common error codes","id":"common-error-codes","depth":2},{"value":"400 Bad Request","id":"400-bad-request","depth":3},{"value":"401 Unauthorized / 403 Forbidden","id":"401-unauthorized--403-forbidden","depth":3},{"value":"404 Not Found / 409 Conflict","id":"404-not-found--409-conflict","depth":3},{"value":"5xx Server Errors","id":"5xx-server-errors","depth":3},{"value":"Requesting support","id":"requesting-support","depth":2}],"frontmatter":{"seo":{"title":"Errors"}},"lastModified":"2025-12-10T17:13:46.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/api-reference/errors","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}