IntroducingBroker

List introducing brokers with sales users and companies

Returns all introducing brokers for the authenticated user's regulated entity, each with their associated sales users and companies in a single response.

get/api-regulated/v1/introducing-brokers/with-sales-users-and-companies

Request

  • Base URL: https://api.currencyguard.com
  • URL: https://api.currencyguard.com/api-regulated/v1/introducing-brokers/with-sales-users-and-companies
  • Auth: HTTP bearer

Response

Retrieved successfully

Example response

[
  {
    "introducingBroker": {
      "id": "eeeeeeee-ee55-4001-8000-000000000000",
      "regulatedEntityId": "eeeeeeee-ee11-4001-8000-000000000000",
      "status": "ENABLED",
      "piiData": {
        "name": "Baumann Partners",
        "primary_contact_name": "Samuel Paine"
      },
      "oauthPoolId": "0a111111-0000-4000-8000-000000000002",
      "customerOauthPoolId": "0a111111-0000-4000-8000-000000000003",
      "perimeterId": "cccccccc-cc11-4001-8000-000000000000",
      "eventSequence": 12345,
      "versionNumber": 1,
      "updatedBy": "jbloggs24",
      "updatedAt": "2024-10-18T12:30:40Z",
      "createdAt": "2024-10-18T12:30:40Z"
    },
    "salesUsers": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "regulatedEntityId": "aaaaaaaa-aa11-4001-8000-000000000000",
        "introducingBrokerId": "eeeeeeee-ee55-4001-8000-000000000000",
        "isActive": true,
        "eventSequence": 12345,
        "versionNumber": 1,
        "updatedBy": "jbloggs24",
        "updatedAt": "2024-10-18T12:30:40Z",
        "createdAt": "2024-10-18T12:30:40Z"
      }
    ],
    "companies": [
      {
        "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
        "regulatedEntityId": "aaaaaaaa-aa11-4001-8000-000000000000",
        "introducingBrokerId": "eeeeeeee-ee55-4001-8000-000000000000",
        "status": "ENABLED",
        "piiData": {
          "name": "Acme Corp",
          "registered_company_number": "12345678",
          "address": {
            "address_line1": "123 Financial Street",
            "address_line2": "Suite 456",
            "city": "London",
            "postcode": "EC1A 1BB",
            "country": "United Kingdom"
          },
          "phone_number": "+44 20 7946 0958",
          "website": "https://acmecorp.example.com",
          "industry": "Financial Services",
          "primary_contact_name": "Jane Smith"
        },
        "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"
      }
    ]
  }
]

Changes

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