CompanyOffboarding

Disable company in regulated entity

Disables a company (reversible operation). Only ENABLED companies can be disabled. Disabled companies can later be re-enabled. The authenticated user must have permission to access the specified regulated entity.

Required entitlement: regulated.companies.canDisableCompany
Entitles the regulated user to disable (suspend) a company within their regulated entity

post/api-regulated/v1/introducing-brokers/{introducingBrokerId}/companies/{companyId}/disable

Request

  • Base URL: https://api.currencyguard.com
  • URL: https://api.currencyguard.com/api-regulated/v1/introducing-brokers/{introducingBrokerId}/companies/{companyId}/disable
  • Auth: OAuth 2 (implicit, authorization URL https://auth.currencyguard.com/oauth2/authorize, scopes: regulated.companies.canDisableCompany)

Path parameters

introducingBrokerIdstring uuid required

Introducing Broker ID

companyIdstring uuid required

Company ID

Response

Company disabled successfully

idstring uuid

The ID for this company.

regulatedEntityIdstring uuid

The ID of the regulated entity this company belongs to.

introducingBrokerIdstring uuid

The ID of the introducing broker this company belongs to.

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

The status of this company.

piiDataCompanyDTOPiiData

Extensible JSONB field - The PII data for this company as encrypted JSON. 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 company's users authenticate against, shared with its broker.

perimeterIdstring uuid

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

baseCurrencystring

The company's functional/home currency (ISO 4217). Defaults the guard currency for this company's guards.

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