Tenants

Create a new tenant

Create a new tenant for your workspace. Tenants are business customers that can have their own counterparties and accounts.

Tenants can be assigned to counterparties to organize your workspace by customer.

Required fields: business_legal_name

post/v1/entities/tenants

Request

Request body

business_legal_namestring required

Legal business name (required)

business_dbastring nullable

DBA - Doing Business As name

business_address_countrystring nullable

Country code in ISO 3166-1 alpha-2 or alpha-3 format

webhook_urlstring uri nullable

HTTPS webhook URL for payment creation notifications; omit the port or use port 443

business_street_address1string nullable

Street address line 1

business_street_address2string nullable

Street address line 2

business_citystring nullable

City

business_statestring nullable

State/region

business_postal_codestring nullable

Postal code

business_legal_entity_identifierstring nullable

Legal Entity Identifier

Example request

{
  "business_legal_name": "Acme Corporation",
  "business_dba": "Acme Co",
  "business_address_country": "US",
  "webhook_url": "https://your-api.com/webhooks/tesser",
  "business_street_address1": "456 Corp Blvd",
  "business_street_address2": "Suite 200",
  "business_city": "San Francisco",
  "business_state": "CA",
  "business_postal_code": "94105",
  "business_legal_entity_identifier": "1234567890"
}

Response

Tenant created successfully

Example response

{
  "data": {
    "tenant": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "workspace_id": "550e8400-e29b-41d4-a716-446655440001",
      "name": "Acme Corporation",
      "business_legal_name": "Acme Corporation",
      "business_dba": "Acme Co",
      "business_address_country": "US",
      "webhook_url": "https://your-api.com/webhooks/tesser",
      "business_street_address1": "456 Corp Blvd",
      "business_street_address2": "Suite 200",
      "business_city": "San Francisco",
      "business_state": "CA",
      "business_postal_code": "94105",
      "business_legal_entity_identifier": "1234567890",
      "created_at": "2024-01-15T10:30:00.000Z",
      "updated_at": "2024-01-15T10:30:00.000Z"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.