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 }
  }'

curl -X POST https://<your-instance>/v1/sdk/client/onboard/<userToken> \
  -H "Content-Type: application/json" \
  -H "CTN: <csrf-token>" \
  --cookie "LASID=<session>;ATN=<access>;RTN=<refresh>" \
  -d '{ ... }'

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

{
  "success": true,
  "status": "ALREADY_EXISTS",
  "client": { "clientId": "DEF", "..." : "..." }
}

{
  "success": false,
  "error": "Validation failed: clientId is required; connectionId is required; At least one VDM config is required in the package"
}

POST

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 }
  }'

curl -X POST https://<your-instance>/v1/sdk/client/onboard/<userToken> \
  -H "Content-Type: application/json" \
  -H "CTN: <csrf-token>" \
  --cookie "LASID=<session>;ATN=<access>;RTN=<refresh>" \
  -d '{ ... }'

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

{
  "success": true,
  "status": "ALREADY_EXISTS",
  "client": { "clientId": "DEF", "..." : "..." }
}

{
  "success": false,
  "error": "Validation failed: clientId is required; connectionId is required; At least one VDM config is required in the package"
}

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.

Show VDM object

name

string

VDM display name.

description

string

Optional description.

vendor

string

default:"SNOWFLAKE"

Database vendor.

sourceType

string

default:"bi_semantic_model"

Source type.

selectedColumns

array

Column selection configuration.

joinConfiguration

array

Table join definitions.

measureConfiguration

array

Measure definitions.

expressionConfiguration

array

Calculated expression definitions.

timeSeriesConfiguration

array

Time series configuration.

rankingConfiguration

array

Ranking configuration.

filterConfiguration

array

Filter configuration.

arithmeticConfiguration

array

Arithmetic configuration.

transformationConfiguration

array

Transformation configuration.

securityEnabled

boolean

default:false

Enable row-level security on this VDM.

securityBindings

object

Security binding definitions.

userScopeTable

object

User-to-scope mapping table configuration.

scopeDefnTable

object

Scope definition table configuration.

dashboards

array

Array of dashboard definitions. Each dashboard creates experiments and a facade.

Show dashboard object

name

string

Dashboard display name.

description

string

Optional description.

templateType

string

Layout template type (e.g., "realEstate").

layoutTemplateName

string

Exact layout template name. Takes priority over templateType.

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.

Show client properties

clientId

string

Client ID

clientName

string

Client display name

connectionId

string

DataBridge connection ID

modelId

string

Client semantic model ID

vdmIds

array

Created VDM IDs

facadeIds

array

Created facade IDs

experimentIds

array

Created experiment IDs

coreModelId

string

Parent core model ID

status

string

ACTIVE or FAILED

onboardedBy

string

User who performed onboarding

onboardedDate

string

ISO timestamp

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 }
  }'

curl -X POST https://<your-instance>/v1/sdk/client/onboard/<userToken> \
  -H "Content-Type: application/json" \
  -H "CTN: <csrf-token>" \
  --cookie "LASID=<session>;ATN=<access>;RTN=<refresh>" \
  -d '{ ... }'

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

{
  "success": true,
  "status": "ALREADY_EXISTS",
  "client": { "clientId": "DEF", "..." : "..." }
}

{
  "success": false,
  "error": "Validation failed: clientId is required; connectionId is required; At least one VDM config is required in the package"
}

Import Data Pipeline Get Chart Types

SDK API

BI Administration API

Client Onboard

Request Body

Response

​Request Body

​Response

Request Body

Response