IntroducingBroker

Create introducing broker

Creates an introducing broker under the authenticated user's regulated entity, along with its Cognito user pools. The broker joins the regulated entity's tenant perimeter; giving it one of its own is a separate, deliberate operation.

Required entitlement: regulated.parties.canModifyIntroducingBroker
Entitles the regulated user to create and update introducing broker records within their regulated entity

post/api-regulated/v1/introducing-brokers

Request

  • Base URL: https://api.currencyguard.com
  • URL: https://api.currencyguard.com/api-regulated/v1/introducing-brokers
  • Auth: OAuth 2 (implicit, authorization URL https://auth.currencyguard.com/oauth2/authorize, scopes: regulated.parties.canModifyIntroducingBroker)

Request body

regulatedEntityIdstring uuid

The ID of the regulated entity this introducing broker belongs to.

piiDataIntroducingBrokerDTOCreatePiiData

Extensible JSONB field - The PII data for this introducing broker as JSONB (includes name, contact info, auth email domains). This field accepts any valid JSON structure and can be extended with additional properties as needed. Note: While the structure is extensible, known fields shown in the example are subject to application validation.

oauthPoolIdstring uuid

The OAuth pool this broker's own staff authenticate against.

customerOauthPoolIdstring uuid

The OAuth pool the customers of this broker's companies authenticate against.

salesAuthSubdomainstring

Optional DNS label for the SALES pool's hosted-UI domain. Blank derives an opaque default; a value here is published in DNS and CT logs and cannot be changed later.

customerAuthSubdomainstring

Optional DNS label for the CUSTOMER pool's hosted-UI domain. Blank derives an opaque default.

totpIssuerstring

Optional name shown in authenticator apps for this broker's users, on both pools. Blank uses the environment default (CurrencyGuard).

Example request

{
  "regulatedEntityId": "eeeeeeee-ee11-4001-8000-000000000000",
  "piiData": {
    "name": "Baumann Partners",
    "primary_contact_name": "Samuel Paine"
  },
  "oauthPoolId": "0a111111-0000-4000-8000-000000000002",
  "customerOauthPoolId": "0a111111-0000-4000-8000-000000000003",
  "salesAuthSubdomain": "psp-a7f3c2-sales",
  "customerAuthSubdomain": "psp-a7f3c2-customers",
  "totpIssuer": "Baumann Partners"
}

Response

OK

Changes

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