Skip to main content

Broker identification

Consistent broker identification across all API calls and URL patterns is essential for proper routing, validation and operational management. This section defines the standardised parameters and their usage throughout the SSO (OAuth) solution.

Broker identification parameters​

The API calls defined in the SSO (OAuth) solution take several request body keys and/or query parameters the values of which are provided by Spotware Systems on a per-broker basis.

ParameterData typeDescription
brokerCrmNamestringA unique name designating a broker's CRM system. If several brokers share the same CRM system, they will also have the same brokerCrmName value.
brokerNamestringA unique name denoting a specific broker (including white labels).

Multi-broker scenarios​

Shared CRM systems​

When multiple brokers share the same CRM system:

  • brokerCrmName will be identical across all brokers
  • brokerName will be unique for each broker

White label configurations​

For white label deployments:

  • Each white label gets a unique brokerName
  • brokerCrmName may be shared with parent broker