> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tarvah.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Client Onboard
> Onboard a new client from an exported onboarding JSON package — creates semantic model, VDM(s), dashboards, and client registry entry
Full client onboarding from a self-contained JSON package. Creates all resources (semantic model, VDMs, dashboards with experiments and facades) and registers the client as `ACTIVE`.
This endpoint supports both **API key authentication** (`Authorization: Bearer trvh_sdk_...`) and **browser session authentication** (`POST /v1/sdk/client/onboard/{userId}` with CSRF token).
## Request Body
The request body is an onboarding JSON package — the same format produced by the **Download** button in the Client Onboarding UI.
Unique client identifier (e.g., `"DEF"`). Will be uppercased automatically.
Display name for the client (e.g., `"Client DEF Corp"`).
DataBridge connection ID for the client's data source (e.g., `"D2026A00042"`).
The `modelId` of the core semantic model to inherit from. Must exist on the target platform.
Key name used for row-level security user mapping (e.g., `"CRD_ALPHA_CORE"`).
Array of VDM configurations. At least one is required.
VDM display name.
Optional description.
Database vendor.
Source type.
Column selection configuration.
Table join definitions.
Measure definitions.
Calculated expression definitions.
Time series configuration.
Ranking configuration.
Filter configuration.
Arithmetic configuration.
Transformation configuration.
Enable row-level security on this VDM.
Security binding definitions.
User-to-scope mapping table configuration.
Scope definition table configuration.
Array of dashboard definitions. Each dashboard creates experiments and a facade.
Dashboard display name.
Optional description.
Layout template type (e.g., `"realEstate"`).
Exact layout template name. Takes priority over `templateType`.
Dashboard categories (e.g., `["BI"]`).
Dashboard tags.
Array of dashboard sections (same format as [Import Dashboard](/api-reference/import-dashboard) sections).
Section name (appears as category tab label).
Render in the always-visible top section.
Appear as a navigable category tab.
Array of chart definitions (same format as [Import Dashboard](/api-reference/import-dashboard) charts).
Global security settings.
Enable row-level security for the client model.
## Response
Whether the request completed.
`"COMPLETED"` for new clients, `"ALREADY_EXISTS"` if the client was already onboarded.
The created (or existing) client registry record.
Client ID
Client display name
DataBridge connection ID
Client semantic model ID
Created VDM IDs
Created facade IDs
Created experiment IDs
Parent core model ID
`ACTIVE` or `FAILED`
User who performed onboarding
ISO timestamp
```bash API Key Auth theme={null}
curl -X POST https:///v1/sdk/client/onboard \
-H "Authorization: Bearer trvh_sdk_your_key_here" \
-H "Content-Type: application/json" \
-d '{
"clientId": "DEF",
"clientName": "Client DEF Corp",
"connectionId": "D2026A00042",
"externalIdKey": "CRD_ALPHA_CORE",
"coreModelId": "SM2026A00001",
"vdm": [
{
"name": "Main VDM",
"vendor": "SNOWFLAKE",
"selectedColumns": [],
"joinConfiguration": [],
"measureConfiguration": []
}
],
"dashboards": [
{
"name": "DEF Dashboard",
"templateType": "realEstate",
"category": ["BI"],
"sections": [
{
"name": "KPIs",
"topSection": true,
"charts": [
{
"title": "Total AUM",
"type": "kpi",
"measures": [{"field": "MARKET_VALUE", "aggregation": "sum"}],
"dimensions": ["PERIOD"]
}
]
}
]
}
],
"security": { "enabled": true }
}'
```
```bash Browser Session Auth theme={null}
curl -X POST https:///v1/sdk/client/onboard/ \
-H "Content-Type: application/json" \
-H "CTN: " \
--cookie "LASID=;ATN=;RTN=" \
-d '{ ... }'
```
```json 201 Created theme={null}
{
"success": true,
"status": "COMPLETED",
"client": {
"clientId": "DEF",
"clientName": "Client DEF Corp",
"connectionId": "D2026A00042",
"modelId": "SM2026A00004",
"vdmIds": ["V2026A00109"],
"facadeIds": ["F2026A00018"],
"experimentIds": ["E2026A00042"],
"coreModelId": "SM2026A00001",
"status": "ACTIVE",
"onboardedBy": "admin_user_id",
"onboardedDate": "2026-03-17T10:00:00.000Z"
}
}
```
```json 200 Already Exists theme={null}
{
"success": true,
"status": "ALREADY_EXISTS",
"client": { "clientId": "DEF", "..." : "..." }
}
```
```json 400 Validation Error theme={null}
{
"success": false,
"error": "Validation failed: clientId is required; connectionId is required; At least one VDM config is required in the package"
}
```