RegulatedEntity

Get own regulated entity

Returns the regulated entity details for the authenticated regulated user.

get/api-regulated/v1/regulated-entities/self

Request

  • Base URL: https://api.currencyguard.com
  • URL: https://api.currencyguard.com/api-regulated/v1/regulated-entities/self
  • Auth: HTTP bearer

Response

Regulated entity retrieved successfully

idstring uuid

The ID for this regulated entity.

entityReferenceCodestring

Two-character code identifying this regulated entity in customer-facing references, e.g. the 'SP' in Guard reference GSP1000104. Immutable once a Guard has been issued under it.

piiDataRegulatedEntityDTOPiiData

Extensible JSONB field - The PII data for this regulated entity as JSONB (includes name, regulatory info, address, phone, website, and contact). 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 regulated entity's staff 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": "aaaaaaaa-aa11-4001-8000-000000000000",
  "entityReferenceCode": "SP",
  "piiData": {
    "name": "Acme Financial Services",
    "regulatory_jurisdiction": "UK",
    "primary_regulatory_reference": "123456",
    "additional_regulatory_references": "SEC: 8-12345, CFTC: 0123456",
    "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://example.com",
    "primary_contact_name": "John Doe"
  },
  "oauthPoolId": "0a111111-0000-4000-8000-000000000001",
  "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.