IntroducingBroker

Upload introducing broker logo

Upload a logo for a specific introducing broker within the authenticated regulated user's regulated entity. Returns the updated introducing broker.

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/{id}/logo

Request

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

Path parameters

idstring uuid required

Response

Logo uploaded successfully - returns updated introducing broker

idstring uuid

The ID for this introducing broker.

regulatedEntityIdstring uuid

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

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

The status of this introducing broker.

piiDataIntroducingBrokerDTOPiiData

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.

perimeterIdstring uuid

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

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

Changes

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