Skip to main content
GET
Tenant Configuration
Manage tenant configuration including notification channels, keywords, industries, risk matrix, website validation settings, billing, and account status. Tenant endpoints allow both self-service management (/me endpoints) and administrative management (/{tenant_id} endpoints).

Overview

Tenant management endpoints provide:
  • Self-Service: Tenants can manage their own configuration via /me endpoints
  • Administrative: Admins can manage any tenant via /{tenant_id} endpoints
  • Configuration Areas: Notifications, keywords, industries, risk matrix, website config, billing
  • Account Status: Credits, subscription, usage tracking, watchlist seats

Endpoints Overview

Self-Service Endpoints (/me)

Administrative Endpoints (/{tenant_id})

Authentication

  • Self-Service Endpoints: Require appropriate read/update permissions
  • Administrative Endpoints: Require tenant:manage permission
  • Include your Bearer token in the Authorization header

Get Current Tenant Configuration

Retrieve the current tenant’s full configuration.

Endpoint

Request Example

Response Format


Account Status

Get comprehensive account status including subscription, credits, usage, and watchlist seats.

Endpoint

Request Example

Response Format

Response Fields


Credits

Get available one-time credits (separate from subscription).

Endpoint

Response Format


Watchlist Seats

Get watchlist monitoring seats information.

Endpoint

Response Format


Notification Channels

Update notification channels for alerts and webhooks.

Endpoint

Request Body Parameters

Request Example

When setting webhook_url for the first time, a webhook_secret is automatically generated if not provided. The secret follows the format whsec_ + 64 hex characters.

Risk Matrix Configuration

Configure weights for web validation reliability score calculation.

Get Risk Matrix

Update Risk Matrix

Request Body Parameters

Important: The sum of all provided weights must equal exactly 1.0. Only include weights for checks you want to enable.

Request Example

Response Format


Website Validation Config

Configure default settings for web validation checks.

Get Website Config

Update Website Config

Request Body Parameters

Request Example

These settings define the default behavior for web validations. Individual requests can override these defaults using request parameters.

Keywords Management

Keywords are used for website content blacklist filtering during web validation.

Get Keywords

Update Keywords

Request Body Parameters

Request Example


Industries Management

Industries define which business categories are allowed or blocked for the tenant.

Get Industries

Update Industries

Request Body Parameters

Keep IDs stable across updates. This endpoint replaces the complete industry list. First read the current list with GET /kyc/tenants/me/industries, then include the id of every existing industry in the PATCH. If an item is sent without an id, LegalTalent assigns a new one. IDs belong to the tenant’s catalog and must not be inferred from array order.

Request Example


Create Tenant (Admin Only)

Create a new tenant with full configuration.

Endpoint

Request Body Parameters

Request Example


Update Billing Configuration (Admin Only)

Update billing settings for a tenant.

Endpoint

Request Body Parameters

Request Example


Delete Tenant (Admin Only)

Soft-delete (deactivate) a tenant.

Endpoint

Request Example

Response Format


Permissions Reference


Status Codes


Best Practices

Use Account Status

Use /me/account-status for dashboard displays - it provides all relevant information in a single call.

Risk Matrix Design

Design your risk matrix weights to sum exactly to 1.0. Only include weights for checks you actually use.

Webhook Security

Always verify webhook signatures using your webhook_secret. It’s auto-generated for security.

List Replacement

Keywords and industries are fully replaced on update. Include all items when updating.

Integration Tips

  1. Configuration Hierarchy: Website config sets defaults → Request parameters override defaults
  2. Credit Priority: Free tier credits are used after subscription quota is exhausted
  3. Watchlist Seats: Track remaining_seats to prevent over-enrollment
  4. Risk Matrix: Weights dynamically adjust based on which checks are enabled in the request
  5. Audit Trail: created_by and updated_by fields track who made changes