Skip to main content
POST
/
v1
/
sdk
/
client
/
onboard
curl -X POST https://<your-instance>/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 }
  }'

{
  "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"
  }
}

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.

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.
​
clientId
string
required
Unique client identifier (e.g., "DEF"). Will be uppercased automatically.
​
clientName
string
required
Display name for the client (e.g., "Client DEF Corp").
​
connectionId
string
required
DataBridge connection ID for the client’s data source (e.g., "D2026A00042").
​
coreModelId
string
required
The modelId of the core semantic model to inherit from. Must exist on the target platform.
​
externalIdKey
string
Key name used for row-level security user mapping (e.g., "CRD_ALPHA_CORE").
​
vdm
array
required
Array of VDM configurations. At least one is required.
​
dashboards
array
Array of dashboard definitions. Each dashboard creates experiments and a facade.
​
security
object
Global security settings.

​
Response

​
success
boolean
Whether the request completed.
​
status
string
"COMPLETED" for new clients, "ALREADY_EXISTS" if the client was already onboarded.
​
client
object
The created (or existing) client registry record.
curl -X POST https://<your-instance>/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 }
  }'

{
  "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"
  }
}