Appearance
Company Profile Endpoints
Manage the organization's Intelligence Profile — sensitive terms, classification policies, and detection settings.
Authentication
All endpoints require a valid bearer token. Write operations (PUT, POST, DELETE) require the Owner or Admin role.
Get Company Profile
Retrieve the full Company Intelligence Profile for an organization.
GET /api/intelligence-profiles/company/{orgId}Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
orgId | path | string | Yes | Organization ID |
Response
json
{
"org_id": "org_abc123",
"sensitivity_floor": "balanced",
"classification_policy": {
"categories": [
{
"name": "project_codename",
"display_name": "Project Codenames",
"default_sensitivity": "critical",
"compliance_tags": ["SOC2"]
},
{
"name": "customer_name",
"display_name": "Customer Names",
"default_sensitivity": "high",
"compliance_tags": []
}
]
},
"safe_terms": [
{
"term": "GhostAI",
"reason": "Public product name"
}
],
"term_count": 42,
"created_at": "2025-09-15T10:30:00Z",
"updated_at": "2026-02-20T14:22:00Z"
}| Field | Type | Description |
|---|---|---|
org_id | string | Organization identifier |
sensitivity_floor | string | Minimum sensitivity level: relaxed, balanced, strict |
classification_policy | object | Category definitions for organizing terms |
safe_terms | array | Allowlisted terms that bypass detection |
term_count | number | Total registered sensitive terms |
created_at | string | Profile creation timestamp (ISO 8601) |
updated_at | string | Last modification timestamp (ISO 8601) |
Update Company Profile
Update the Company Intelligence Profile settings.
PUT /api/intelligence-profiles/company/{orgId}Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
orgId | path | string | Yes | Organization ID |
Request
json
{
"sensitivity_floor": "strict",
"classification_policy": {
"categories": [
{
"name": "project_codename",
"display_name": "Project Codenames",
"default_sensitivity": "critical",
"compliance_tags": ["SOC2", "ITAR"]
}
]
},
"safe_terms": [
{
"term": "GhostAI",
"reason": "Public product name"
}
]
}| Field | Type | Required | Description |
|---|---|---|---|
sensitivity_floor | string | No | relaxed, balanced, or strict |
classification_policy | object | No | Updated category definitions |
safe_terms | array | No | Updated safe terms allowlist |
All fields are optional. Only provided fields are updated.
Response
Returns the updated profile (same schema as GET).
List Terms
Retrieve all registered sensitive terms for an organization.
GET /api/intelligence-profiles/company/{orgId}/termsParameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
orgId | path | string | Yes | Organization ID |
category | query | string | No | Filter by category |
sensitivity | query | string | No | Filter by sensitivity level |
page | query | number | No | Page number (default: 1) |
per_page | query | number | No | Items per page (default: 50, max: 200) |
Response
json
{
"terms": [
{
"id": "term_x1y2z3",
"term": "Project Falcon",
"category": "project_codename",
"sensitivity": "critical",
"metadata": {
"added_by": "admin@company.com",
"notes": "FY26 strategic initiative"
},
"created_at": "2026-01-10T08:00:00Z"
},
{
"id": "term_a1b2c3",
"term": "Acme Corp",
"category": "customer_name",
"sensitivity": "high",
"metadata": {},
"created_at": "2026-01-12T14:30:00Z"
}
],
"total": 42,
"page": 1,
"per_page": 50
}Add Term
Register a new sensitive term.
POST /api/intelligence-profiles/company/{orgId}/termsParameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
orgId | path | string | Yes | Organization ID |
Request
json
{
"term": "Project Falcon",
"category": "project_codename",
"sensitivity": "critical",
"metadata": {
"notes": "FY26 strategic initiative"
}
}| Field | Type | Required | Description |
|---|---|---|---|
term | string | Yes | Word or phrase to detect (case-insensitive) |
category | string | Yes | Classification category (must exist in policy) |
sensitivity | string | No | low, medium, high, critical — defaults to category default |
metadata | object | No | Free-form metadata for audit and reporting |
Response
json
{
"id": "term_x1y2z3",
"term": "Project Falcon",
"category": "project_codename",
"sensitivity": "critical",
"metadata": {
"notes": "FY26 strategic initiative"
},
"created_at": "2026-02-25T10:00:00Z"
}Status: 201 Created
Bulk Add Terms
Register multiple terms in a single request.
POST /api/intelligence-profiles/company/{orgId}/terms/bulkParameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
orgId | path | string | Yes | Organization ID |
Request
json
{
"terms": [
{
"term": "Project Falcon",
"category": "project_codename",
"sensitivity": "critical"
},
{
"term": "Acme Corp",
"category": "customer_name",
"sensitivity": "high"
},
{
"term": "NeuralForge",
"category": "product",
"sensitivity": "medium"
}
]
}| Field | Type | Required | Description |
|---|---|---|---|
terms | array | Yes | Array of term objects (same schema as Add Term) |
Response
json
{
"created": 3,
"skipped": 0,
"errors": [],
"terms": [
{
"id": "term_x1y2z3",
"term": "Project Falcon",
"category": "project_codename",
"sensitivity": "critical",
"created_at": "2026-02-25T10:00:00Z"
},
{
"id": "term_a1b2c3",
"term": "Acme Corp",
"category": "customer_name",
"sensitivity": "high",
"created_at": "2026-02-25T10:00:00Z"
},
{
"id": "term_d4e5f6",
"term": "NeuralForge",
"category": "product",
"sensitivity": "medium",
"created_at": "2026-02-25T10:00:00Z"
}
]
}| Field | Type | Description |
|---|---|---|
created | number | Number of terms successfully created |
skipped | number | Number of duplicate terms skipped |
errors | array | Validation errors for individual terms |
terms | array | Successfully created terms |
Status: 201 Created
Delete Term
Remove a sensitive term from the registry.
DELETE /api/intelligence-profiles/company/{orgId}/terms/{termId}Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
orgId | path | string | Yes | Organization ID |
termId | path | string | Yes | Term ID to delete |
Response
Status: 204 No Content
Auto-Research Company
Research a company from public information and return structured suggestions for the Company Intelligence Profile. This endpoint does not save anything — use the standard PUT/POST endpoints to apply the suggestions.
POST /api/intelligence-profiles/company/{orgId}/auto-researchParameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
orgId | path | string | Yes | Organization ID |
Request
json
{
"company_name": "Acme Technologies",
"domain": "acme.com",
"website_url": "https://www.acme.com"
}| Field | Type | Required | Description |
|---|---|---|---|
company_name | string | No | Company name to research. Falls back to organization name if omitted. |
domain | string | No | Company domain for website scraping. Falls back to admin email domain if omitted. |
website_url | string | No | Direct URL to the company website |
All fields are optional. If company_name is not provided and cannot be inferred from the organization, a 400 error is returned.
Response
json
{
"company_description": "Acme Technologies is a fintech platform that processes payment data for small businesses. They handle credit card numbers, bank account details, and merchant transaction records.",
"industry_details": {
"sector": "Financial Technology",
"sub_industry": "Payment Processing",
"regulated": true
},
"products_services": [
{"name": "AcmePay", "description": "Payment processing API for SMBs"},
{"name": "Acme Dashboard", "description": "Merchant analytics and reporting"}
],
"data_classification_tiers": [
{"tier": "Public", "description": "Marketing materials and public docs", "examples": ["blog posts", "pricing page"]},
{"tier": "Internal", "description": "Internal operations data", "examples": ["employee directory", "internal memos"]},
{"tier": "Confidential", "description": "Customer and financial data", "examples": ["transaction records", "merchant details"]},
{"tier": "Restricted", "description": "PCI-regulated cardholder data", "examples": ["credit card numbers", "CVVs"]}
],
"suggested_sensitivity_floor": "paranoid",
"suggested_sensitive_terms": [
{"term": "AcmePay", "term_type": "sensitive", "category": "product_codename", "reasoning": "Proprietary payment product name", "source": "https://www.acme.com/products"},
{"term": "Merchant ID", "term_type": "sensitive", "category": "internal_id", "reasoning": "Internal merchant identifier", "source": "https://www.acme.com/about"}
],
"suggested_safe_terms": [
{"term": "Acme Technologies", "term_type": "safe", "category": "public_info", "reasoning": "Public company name", "source": "https://www.acme.com/about"},
{"term": "fintech", "term_type": "safe", "category": "false_positive", "reasoning": "Industry standard term", "source": "https://www.acme.com/about"}
],
"field_confidence": {
"company_description": 0.92,
"industry_details": 0.88,
"products_services": 0.85,
"data_classification_tiers": 0.78,
"suggested_sensitivity_floor": 0.80,
"suggested_sensitive_terms": 0.75,
"suggested_safe_terms": 0.82
},
"research_metadata": {
"search_queries": [
"Acme Technologies company overview fintech",
"Acme Technologies products services payment",
"Acme Technologies compliance regulations PCI"
],
"pages_scraped": 4,
"llm_passes": 2,
"elapsed_seconds": 12.3,
"domain_discovered": true,
"detected_vertical": "financial"
},
"sources": ["https://www.acme.com/about", "https://www.acme.com/products", "https://www.acme.com/compliance", "https://techcrunch.com/acme-series-b"],
"confidence": 0.85,
"warnings": []
}| Field | Type | Description |
|---|---|---|
company_description | string | AI-generated company description |
industry_details | object | Sector, sub-industry, and regulation status |
products_services | array | Identified products and services |
data_classification_tiers | array | Suggested data classification tiers |
suggested_sensitivity_floor | string | Recommended sensitivity floor |
suggested_sensitive_terms | array | Terms suggested as sensitive, with reasoning and source URL |
suggested_safe_terms | array | Terms suggested as safe, with reasoning and source URL |
field_confidence | object | Per-field confidence scores (0.0–1.0), computed from source agreement and extraction quality |
research_metadata | object | Pipeline diagnostics: search_queries (array of queries used), pages_scraped (count), llm_passes (number of LLM passes), elapsed_seconds, domain_discovered (boolean), detected_vertical (string) |
sources | array | URLs used during research |
confidence | number | Overall confidence score (0.0 to 1.0) |
warnings | array | Any warnings or limitations encountered |
Rate Limiting
This endpoint is rate-limited to one request per organization per 5 minutes.
Status: 200 OK
Error Responses
All endpoints return standard error responses:
| Status | Description |
|---|---|
400 | Invalid request body or parameters |
401 | Missing or invalid authentication token |
403 | Insufficient permissions (admin role required for writes) |
404 | Organization or term not found |
409 | Duplicate term (on create) |
422 | Validation error (e.g., category does not exist in policy) |
json
{
"error": "forbidden",
"message": "Admin role required to modify the Company Intelligence Profile",
"status": 403
}