Company

Get all companies with customers for introducing broker

Returns a list of all companies belonging to the specified introducing broker, including their associated customers for enhanced search functionality. The authenticated user must have permission to access the specified introducing broker.

get/api-regulated/v1/introducing-brokers/{introducingBrokerId}/companies/with-customers

Request

  • Base URL: https://api.currencyguard.com
  • URL: https://api.currencyguard.com/api-regulated/v1/introducing-brokers/{introducingBrokerId}/companies/with-customers
  • Auth: HTTP bearer

Path parameters

introducingBrokerIdstring uuid required

Introducing Broker ID

Response

Companies with customers retrieved successfully

idstring uuid

The ID for this company.

regulatedEntityIdstring uuid

The ID of the regulated entity this company belongs to.

introducingBrokerIdstring uuid

The ID of the introducing broker this company belongs to.

status'PENDING' | 'ENABLED' | 'DISABLED' | 'DELETED'

The status of this company.

piiDataCompanyWithCustomersDTOPiiData
oauthPoolIdstring uuid

The OAuth pool this company's users authenticate against, shared with its broker.

perimeterIdstring uuid

The tenant perimeter whose KMS key encrypts this record's PII.

baseCurrencystring

The company's functional/home currency (ISO 4217). Defaults the guard currency for this company's guards.

eventSequenceinteger

Event sequence number for event sourcing.

versionNumberinteger

The strictly monotonically increasing version number for this record.

updatedBystring

The username of the person or entity that updated this record.

updatedAtstring

The timestamp of the last update in UTC.

createdAtstring

The timestamp of creation in UTC.

Example response

[
  {
    "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "regulatedEntityId": "aaaaaaaa-aa11-4001-8000-000000000000",
    "introducingBrokerId": "eeeeeeee-ee55-4001-8000-000000000000",
    "status": "ENABLED",
    "oauthPoolId": "0a111111-0000-4000-8000-000000000003",
    "perimeterId": "cccccccc-cc11-4001-8000-000000000000",
    "baseCurrency": "GBP",
    "eventSequence": 12345,
    "versionNumber": 1,
    "updatedBy": "jbloggs24",
    "updatedAt": "2024-10-18T12:30:40Z",
    "createdAt": "2024-10-18T12:30:40Z",
    "customers": [
      {
        "id": "12345678-1234-4001-8000-123456789012",
        "piiData": {
          "email": "john@example.com"
        }
      }
    ]
  }
]

Changes

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