IntroducingBroker

List introducing brokers with full hierarchy

Returns all IBs with sales users (including PII), companies, customers, and documents in a single response. Designed for full-hierarchy Fuse indexing.

get/api-regulated/v1/introducing-brokers/with-full-details

Request

  • Base URL: https://api.currencyguard.com
  • URL: https://api.currencyguard.com/api-regulated/v1/introducing-brokers/with-full-details
  • 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": [
      {
        "user": {
          "id": "12345678-1234-4001-8000-123456789012",
          "subClaim": "auth0|12345678-1234-4001-8000-123456789012",
          "roleClaims": "ROLE_ADMIN,ROLE_TRADER",
          "status": "ENABLED",
          "onboardedDate": "2024-01-15T00:00:00Z",
          "entitlementsTemplateId": "12345678-1234-4001-8000-123456789012",
          "piiData": {
            "email": "john.doe@example.com",
            "firstName": "John",
            "lastName": "Doe",
            "phone": "+44 20 7946 0958",
            "jobTitle": "Risk Manager",
            "department": "Trading"
          },
          "preferences": {
            "tables": {
              "guard-book": {
                "pageSize": 50
              }
            }
          },
          "perimeterId": "cccccccc-cc11-4001-8000-000000000000",
          "authType": "OAUTH2_AUTHORIZATION_CODE",
          "eventSequence": 12345,
          "versionNumber": 1,
          "updatedBy": "jbloggs24",
          "updatedAt": "2024-10-18T12:30:40Z",
          "createdAt": "2024-10-18T12:30:40Z"
        },
        "salesUser": {
          "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"
        },
        "regulatedEntity": {
          "id": "aaaaaaaa-aa11-4001-8000-000000000000",
          "entityReferenceCode": "SP",
          "piiData": {
            "name": "Acme Financial Services",
            "regulatory_jurisdiction": "UK",
            "primary_regulatory_reference": "123456",
            "additional_regulatory_references": "SEC: 8-12345, CFTC: 0123456",
            "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://example.com",
            "primary_contact_name": "John Doe"
          },
          "oauthPoolId": "0a111111-0000-4000-8000-000000000001",
          "perimeterId": "cccccccc-cc11-4001-8000-000000000000",
          "eventSequence": 12345,
          "versionNumber": 1,
          "updatedBy": "jbloggs24",
          "updatedAt": "2024-10-18T12:30:40Z",
          "createdAt": "2024-10-18T12:30:40Z"
        },
        "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"
        }
      }
    ],
    "companies": [
      {
        "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.