IntroducingBroker

Update introducing broker

Updates an existing introducing broker, scoped to the user's regulated entity.

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

put/api-regulated/v1/introducing-brokers/{id}

Request

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

Path parameters

idstring uuid required

Request body

regulatedEntityIdstring uuid

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

piiDataIntroducingBrokerDTOUpdatePiiData

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.

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"
}

Response

OK

Changes

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