Agencies and tenants

Overview

The endpoints in this section cover all operations you can perform with agencies and tenants in the Inspire API.

Agencies

An agency is a representative of Inspire that may or may not also be a tenant.

📘

To view the agency object properties, read Agency object.

Tenants

In the context of this API, tenants are clients of Inspire who use the payment platform to process payments from their customers.

Tenant ID and identifier properties

Each tenant has two identifying properties:

  • Tenant ID: this is the ID of the tenant object in the database.
  • Tenant Identifier: is the unique identifier of the Inspire instance. This value is required in the tenant header of most Inspire API endpoints and used for authentication.
📘

To view the tenant object properties, read Tenant object.