Tesser API

Tenants (v1)

Endpointhttps://sandbox.tesserx.co

Download schema

List all tenants

GET

https://sandbox.tesserx.co

/v1/entities/tenants

Retrieve all tenants for your workspace with optional search filtering and pagination.

List all tenants › query Parameters

search

string

Search by name (legal name or DBA)

include_secure

boolean

Include masked vault data (address, legal entity identifier)

page

number · min: 1 · max: 9007199254740991

Page number for pagination (1-based)

limit

number · min: 1 · max: 100

Number of items per page (max 100)

List all tenants › Responses

Tenants retrieved successfully

object[] · required

object

GET/v1/entities/tenants

curl --request GET \
  --url https://sandbox.tesserx.co/v1/entities/tenants

shell

Example Responses

{
  "data": [
    {
      "id": "4e8c2a6f-1b9d-4f37-a5e0-7c3b8d2f1a9e",
      "workspace_id": "b53f6690-3242-4942-9907-885779632832",
      "name": "Acme Co",
      "business_legal_name": "Acme Corporation",
      "business_dba": "Acme Co",
      "business_address_country": "US",
      "webhook_url": "https://acme.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": null,
      "created_at": "2024-01-15T10:30:00.000Z",
      "updated_at": "2024-01-15T10:30:00.000Z"
    },
    {
      "id": "7a1f5c9e-3b2d-4e68-b0a4-6e9c1f3d8a2b",
      "workspace_id": "b53f6690-3242-4942-9907-885779632832",
      "name": "TechStart Inc",
      "business_legal_name": "TechStart Inc",
      "business_dba": null,
      "business_address_country": "CA",
      "webhook_url": null,
      "business_street_address1": "789 Startup Ave",
      "business_street_address2": null,
      "business_city": "Toronto",
      "business_state": "ON",
      "business_postal_code": "M5V 2T6",
      "business_legal_entity_identifier": null,
      "created_at": "2024-02-01T14:00:00.000Z",
      "updated_at": "2024-02-01T14:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 2,
    "total_pages": 1,
    "has_next": false,
    "has_prev": false
  }
}

json

application/json

Create a new tenant

POST

https://sandbox.tesserx.co

/v1/entities/tenants

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

Create a new tenant › Request Body

business_legal_name

string · minLength: 1 · maxLength: 255 · required

Legal business name (required)

business_dba

string · maxLength: 255

DBA - Doing Business As name

business_address_country

string · minLength: 2 · maxLength: 3 · pattern: ^[A-Za-z]{2,3}$

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

webhook_url

string · uri

Webhook URL for payment creation notifications

business_street_address1

string · maxLength: 255

Street address line 1

business_street_address2

string · maxLength: 255

Street address line 2

business_city

string · maxLength: 255

City

business_state

string · maxLength: 255

State/region

business_postal_code

string · maxLength: 50

Postal code

business_legal_entity_identifier

string · maxLength: 255

Legal Entity Identifier

Create a new tenant › Responses

Tenant created successfully

object · required

POST/v1/entities/tenants

curl --request POST \
  --url https://sandbox.tesserx.co/v1/entities/tenants \
  --header 'Content-Type: application/json' \
  --data '
{
  "business_legal_name": "Acme Corporation",
  "business_dba": "Acme Co",
  "business_address_country": "US",
  "business_street_address1": "456 Corp Blvd",
  "business_street_address2": "Suite 200",
  "business_city": "San Francisco",
  "business_state": "CA",
  "business_postal_code": "94105",
  "webhook_url": "https://acme.com/webhooks/tesser"
}
'

shell

Example Request Body

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

json

application/json

Example Responses

{
  "data": {
    "tenant": {
      "id": "0c6e3a9f-2b1d-4f84-a7e5-8d4c1b2f9a3e",
      "workspace_id": "b53f6690-3242-4942-9907-885779632832",
      "name": "Acme Co",
      "business_legal_name": "Acme Corporation",
      "business_dba": "Acme Co",
      "business_address_country": "US",
      "webhook_url": "https://acme.com/webhooks/tesser",
      "business_street_address1": null,
      "business_street_address2": null,
      "business_city": null,
      "business_state": null,
      "business_postal_code": null,
      "business_legal_entity_identifier": null,
      "created_at": "2024-03-01T10:00:00.000Z",
      "updated_at": "2024-03-01T10:00:00.000Z"
    }
  }
}

json

application/json

Get a tenant by ID

GET

https://sandbox.tesserx.co

/v1/entities/tenants/{id}

Retrieve a specific tenant by its unique identifier.

Get a tenant by ID › path Parameters

id

string · required

Tenant ID (UUID)

Get a tenant by ID › query Parameters

include_secure

boolean

Include masked vault data (address, legal entity identifier)

Get a tenant by ID › Responses

Tenant retrieved successfully

object · required

GET/v1/entities/tenants/{id}

curl --request GET \
  --url https://sandbox.tesserx.co/v1/entities/tenants/:id

shell

Example Responses

{
  "data": {
    "id": "4e8c2a6f-1b9d-4f37-a5e0-7c3b8d2f1a9e",
    "workspace_id": "b53f6690-3242-4942-9907-885779632832",
    "name": "Acme Co",
    "business_legal_name": "Acme Corporation",
    "business_dba": "Acme Co",
    "business_address_country": "US",
    "webhook_url": "https://acme.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": null,
    "created_at": "2024-01-15T10:30:00.000Z",
    "updated_at": "2024-01-15T10:30:00.000Z"
  }
}

json

application/json

Counterparties Networks

List all tenants

GET

https://sandbox.tesserx.co

/v1/entities/tenants

Retrieve all tenants for your workspace with optional search filtering and pagination.

List all tenants › query Parameters

search

string

Search by name (legal name or DBA)

include_secure

boolean

Include masked vault data (address, legal entity identifier)

page

number · min: 1 · max: 9007199254740991

Page number for pagination (1-based)

limit

number · min: 1 · max: 100

Number of items per page (max 100)

List all tenants › Responses

Tenants retrieved successfully

object[] · required

object

{ "data": [ { "id": "4e8c2a6f-1b9d-4f37-a5e0-7c3b8d2f1a9e", "workspace_id": "b53f6690-3242-4942-9907-885779632832", "name": "Acme Co", "business_legal_name": "Acme Corporation", "business_dba": "Acme Co", "business_address_country": "US", "webhook_url": "https://acme.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": null, "created_at": "2024-01-15T10:30:00.000Z", "updated_at": "2024-01-15T10:30:00.000Z" }, { "id": "7a1f5c9e-3b2d-4e68-b0a4-6e9c1f3d8a2b", "workspace_id": "b53f6690-3242-4942-9907-885779632832", "name": "TechStart Inc", "business_legal_name": "TechStart Inc", "business_dba": null, "business_address_country": "CA", "webhook_url": null, "business_street_address1": "789 Startup Ave", "business_street_address2": null, "business_city": "Toronto", "business_state": "ON", "business_postal_code": "M5V 2T6", "business_legal_entity_identifier": null, "created_at": "2024-02-01T14:00:00.000Z", "updated_at": "2024-02-01T14:00:00.000Z" } ], "pagination": { "page": 1, "limit": 10, "total": 2, "total_pages": 1, "has_next": false, "has_prev": false } }

Create a new tenant

POST

https://sandbox.tesserx.co

/v1/entities/tenants

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

Create a new tenant › Request Body

business_legal_name

string · minLength: 1 · maxLength: 255 · required

Legal business name (required)

business_dba

string · maxLength: 255

DBA - Doing Business As name

business_address_country

string · minLength: 2 · maxLength: 3 · pattern: ^[A-Za-z]{2,3}$

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

webhook_url

string · uri

Webhook URL for payment creation notifications

business_street_address1

string · maxLength: 255

Street address line 1

business_street_address2

string · maxLength: 255

Street address line 2

business_city

string · maxLength: 255

City

business_state

string · maxLength: 255

State/region

business_postal_code

string · maxLength: 50

Postal code

business_legal_entity_identifier

string · maxLength: 255

Legal Entity Identifier

Create a new tenant › Responses

Tenant created successfully

object · required

curl --request POST \ --url https://sandbox.tesserx.co/v1/entities/tenants \ --header 'Content-Type: application/json' \ --data ' { "business_legal_name": "Acme Corporation", "business_dba": "Acme Co", "business_address_country": "US", "business_street_address1": "456 Corp Blvd", "business_street_address2": "Suite 200", "business_city": "San Francisco", "business_state": "CA", "business_postal_code": "94105", "webhook_url": "https://acme.com/webhooks/tesser" } '

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

{ "data": { "tenant": { "id": "0c6e3a9f-2b1d-4f84-a7e5-8d4c1b2f9a3e", "workspace_id": "b53f6690-3242-4942-9907-885779632832", "name": "Acme Co", "business_legal_name": "Acme Corporation", "business_dba": "Acme Co", "business_address_country": "US", "webhook_url": "https://acme.com/webhooks/tesser", "business_street_address1": null, "business_street_address2": null, "business_city": null, "business_state": null, "business_postal_code": null, "business_legal_entity_identifier": null, "created_at": "2024-03-01T10:00:00.000Z", "updated_at": "2024-03-01T10:00:00.000Z" } } }

Get a tenant by ID

GET

https://sandbox.tesserx.co

/v1/entities/tenants/{id}

Retrieve a specific tenant by its unique identifier.

Get a tenant by ID › path Parameters

id

string · required

Tenant ID (UUID)

Get a tenant by ID › query Parameters

include_secure

boolean

Include masked vault data (address, legal entity identifier)

Get a tenant by ID › Responses

Tenant retrieved successfully

object · required

{ "data": { "id": "4e8c2a6f-1b9d-4f37-a5e0-7c3b8d2f1a9e", "workspace_id": "b53f6690-3242-4942-9907-885779632832", "name": "Acme Co", "business_legal_name": "Acme Corporation", "business_dba": "Acme Co", "business_address_country": "US", "webhook_url": "https://acme.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": null, "created_at": "2024-01-15T10:30:00.000Z", "updated_at": "2024-01-15T10:30:00.000Z" } }