CurrencyguardCompany

Get CurrencyGuard company by ID

Retrieves a specific CurrencyGuard company by its ID. Available to regulated and customer users.

get/api-regulated/v1/currencyguard-companies/{currencyguardCompanyId}

Request

  • Base URL: https://api.currencyguard.com
  • URL: https://api.currencyguard.com/api-regulated/v1/currencyguard-companies/{currencyguardCompanyId}
  • Auth: HTTP bearer

Path parameters

currencyguardCompanyIdstring uuid required

CurrencyGuard Company ID

Response

CurrencyGuard company retrieved successfully

idstring uuid

The ID for CurrencyGuard company.

companyNamestring

The company name.

registeredCompanyNumberstring

The registered company number.

contactEmailstring

The main contact email address.

websiteUrlstring

The company website URL.

phoneNumberstring

The primary contact phone number.

addressLine1string

The head office address line 1.

addressLine2string

The head office address line 2.

citystring

The head office city.

stateProvincestring

The head office state/province.

postcodestring

The head office postcode.

countryCodestring

The head office country code.

companyLogoDocumentIdstring uuid

The company logo document.

calendarCodestring

The calendar code for this company's trading operations.

calendarTimezonestring

The timezone for this company's trading operations.

operatingHoursCurrencyguardCompanyDTOOperatingHours

Extensible JSONB field - Operating hours for trading operations in JSON format 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.

isActiveboolean

Whether CurrencyGuard company record is active.

oauthPoolIdstring uuid

The OAuth pool CurrencyGuard staff authenticate against.

systemOauthPoolIdstring uuid

The OAuth pool system accounts 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": "00000000-0000-4000-8000-000000000000",
  "companyName": "CurrencyGuard Limited",
  "registeredCompanyNumber": "12345678",
  "contactEmail": "info@currencyguard.co.uk",
  "websiteUrl": "https://www.currencyguard.co.uk",
  "phoneNumber": "+44 7768 298148",
  "addressLine1": "CurrencyGuard House",
  "addressLine2": "123 Financial District",
  "city": "London",
  "stateProvince": "England",
  "postcode": "EC2A 4DP",
  "countryCode": "GB",
  "companyLogoDocumentId": "12345678-1234-4001-8000-123456789012",
  "calendarCode": "GBLO",
  "calendarTimezone": "Europe/London",
  "operatingHours": {
    "monday": {
      "open": "09:15:00",
      "close": "16:15:00"
    },
    "tuesday": {
      "open": "09:15:00",
      "close": "16:15:00"
    },
    "wednesday": {
      "open": "09:15:00",
      "close": "16:15:00"
    },
    "thursday": {
      "open": "09:15:00",
      "close": "16:15:00"
    },
    "friday": {
      "open": "09:15:00",
      "close": "16:15:00"
    }
  },
  "isActive": true,
  "oauthPoolId": "0a111111-0000-4000-8000-000000000004",
  "systemOauthPoolId": "0a111111-0000-4000-8000-000000000005",
  "perimeterId": "cccccccc-cc11-4001-8000-000000000000",
  "eventSequence": 12345,
  "versionNumber": 1,
  "updatedBy": "system",
  "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.