Get business configurations

GET

https://api.staging.vrtx.sa/businesses/configurations

Last modified:2026-04-16 11:21:30

Returns the typed business configurations for the authenticated business.

Currently supported configuration keys:

allowed_card_types: Controls which card types are enabled (is_virtual, is_physical)

The business ID is extracted from the authentication token.

Error Scenarios:

400: Business ID missing from token

404: Business not found

503: Failed to fetch configurations from businesses service

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Responses

🟢200

application/json

Typed business configurations

Body

🟠400

🟠401

🟠403

🟠404

🟠405

🟠409

🟠410

🟠422

🟠429

🔴500

🔴501

🔴503

🔴504

🔴505

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.staging.vrtx.sa/businesses/configurations' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "allowed_card_types": {
        "is_virtual": true,
        "is_physical": true
    },
    "theme": {
        "colors": {
            "light": {
                "all_brands": {
                    "primary": "string",
                    "buttons_label": "string"
                },
                "accents": {
                    "property1": "string",
                    "property2": "string"
                },
                "backgrounds": {
                    "primary": "string",
                    "secondary": "string",
                    "tertiary": "string",
                    "elevated": {
                        "primary": "string",
                        "secondary": "string",
                        "tertiary": "string"
                    }
                },
                "backgrounds_gradients": {
                    "property1": "string",
                    "property2": "string"
                },
                "backgrounds_grouped": {
                    "primary": "string",
                    "secondary": "string",
                    "tertiary": "string",
                    "elevated": {
                        "primary": "string",
                        "secondary": "string",
                        "tertiary": "string"
                    }
                },
                "fills": {
                    "property1": "string",
                    "property2": "string"
                },
                "fills_vibrant": {
                    "property1": "string",
                    "property2": "string"
                },
                "grays": {
                    "property1": "string",
                    "property2": "string"
                },
                "labels": {
                    "property1": "string",
                    "property2": "string"
                },
                "overlays": {
                    "property1": "string",
                    "property2": "string"
                },
                "separators": {
                    "property1": "string",
                    "property2": "string"
                },
                "miscellaneous": {
                    "property1": "string",
                    "property2": "string"
                },
                "miscellaneous_buttons": {
                    "property1": "string",
                    "property2": "string"
                },
                "miscellaneous_keyboards": {
                    "property1": "string",
                    "property2": "string"
                },
                "miscellaneous_sidebar": {
                    "property1": "string",
                    "property2": "string"
                },
                "miscellaneous_text_field": {
                    "property1": "string",
                    "property2": "string"
                }
            },
            "dark": {
                "property1": "string",
                "property2": "string"
            }
        },
        "language": {
            "en": {
                "font_family": {
                    "body": "string",
                    "cta": "string",
                    "titles": "string"
                },
                "weight": {
                    "property1": "string",
                    "property2": "string"
                },
                "size": {
                    "property1": 0,
                    "property2": 0
                }
            },
            "ar": {
                "font_family": {
                    "body": "string",
                    "cta": "string",
                    "titles": "string"
                },
                "weight": {
                    "property1": "string",
                    "property2": "string"
                },
                "size": {
                    "property1": 0,
                    "property2": 0
                }
            }
        },
        "specs": {
            "spacing": {
                "property1": 0,
                "property2": 0
            },
            "sizing": {
                "property1": 0,
                "property2": 0
            },
            "radius": {
                "property1": 0,
                "property2": 0
            }
        }
    }
}

Modified at 2026-04-16 11:21:30

Get batch report

Add whitelist entries