Company
Manage and retrieve organizational metadata and module configurations.
Company
The Company API allows you to retrieve metadata about your own organization and lookup public data for third-party companies using VAT identifiers.
Get Company Profile
Retrieve the core configuration and identification attributes for your company profile. This includes your unique internal identifier and official registered name.
company:readApiAccessPermission::COMPANY_READQuery Parameters
No query parameters required.
Responses
Company profile retrieved successfully.
{
"id": "668ea32f5485467fd7149f48",
"name": "Acme Corp"
}List Active Modules
Discover and monitor the status of functional modules enabled for your organization. Each module represents a specific capability (e.g., Recurring Payments, Email Gateway) along with its configuration and activation state.
company_modules:readApiAccessPermission::COMPANY_MODULES_READQuery Parameters
No query parameters required.
Responses
List of organizational modules.
[
{
"id": "recurring-payments",
"description": "Automated subscription billing and payment orchestration.",
"price": 0,
"active": true
},
{
"id": "email-gateway",
"description": "Transactional email delivery via unified REST interface.",
"price": 0,
"active": true
},
{
"id": "geoip",
"description": "IPv4 geolocation and regional metadata resolution.",
"price": 0,
"active": true
}
]Company Intelligence Stats
Retrieve the company intelligence snapshot used by operational dashboards. This endpoint returns KPI data, usage widgets, revenue chart aggregates, and metadata for the current company context.
company_stats:readApiAccessPermission::COMPANY_STATS_READQuery Parameters
No query parameters required.
Responses
Company intelligence payload retrieved.
{
"kpi": {
"mrr_growth": {
"raw_percent": 12.3,
"display_label": "12.30%"
},
"total_customers": 120,
"active_subscriptions": 93
},
"usage": {
"banner": {
"show": false,
"status": null,
"upgrade_url": null
},
"widgets": []
},
"recent_activity": [],
"revenue_chart": {
"graph": [],
"stats": {
"one_shot": 0,
"subscriptions": 0,
"total": 0
}
},
"revenue_insights": {
"visible": false,
"net_revenue": 0,
"tax_total": 0,
"discounts_total": 0,
"services": [],
"top_services": []
},
"meta": {
"company_id": "668ea32f5485467fd7149f48",
"year": 2026,
"month": 4,
"generated_at": "2026-04-15T10:00:00+00:00"
}
}Lookup Registered Company (Open Data)
Retrieve public business information for a company using its VAT number. This is particularly useful for automating KYC (Know Your Customer) workflows and ensuring data accuracy during customer onboarding.
companies_open_data:readApiAccessPermission::COMPANIES_OPEN_DATA_READQuery Parameters
vatNumberstringRequiredResponses
Public company data found.
{
"vatNumber": "IT12345678901",
"name": "Example Solutions S.r.l.",
"address": "Corso Vittorio Emanuele II, 1, 00186 Roma RM, Italy",
"vies_interrogation": {
"valid": true
}
}No data available for the specified VAT number.
{
"error": "Company not found"
}