openapi: 3.2.0
info:
  title: transaction-monitoring Entities API
  version: '1.0'
servers:
- url: https://sandbox-oxygen.fiatrepublic.com/api/v1
security:
- sec0: []
tags:
- name: Entities
paths:
  /entities:
    get:
      summary: List Entities
      description: ''
      operationId: oxygen-list-entities
      parameters:
      - name: id
        in: query
        description: Id of the entity within Oxygen
        schema:
          type: string
      - name: externalId
        in: query
        description: Id of the entity within Member's system
        schema:
          type: string
      - name: name
        in: query
        description: Name, surname, company name, trading name
        schema:
          type: string
      - name: country
        in: query
        description: Country provided for the company or individual address
        schema:
          type: string
      - name: search
        in: query
        schema:
          type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Entities
  /entities/{id}:
    get:
      summary: Get Entity
      description: ''
      operationId: oxygen-get-entity
      parameters:
      - name: entityId
        in: path
        description: Id of the entity based on the Member's system
        schema:
          type: string
        required: true
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Entities
components:
  securitySchemes:
    sec0:
      type: oauth2
      flows: {}
x-readme-fauxas: true
x-provenance:
  method: searched
  source: https://docs.fiatrepublic.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.fiatrepublic.com/reference/create-transaction.md
  - https://docs.fiatrepublic.com/reference/oxygen-create-entity.md
  - https://docs.fiatrepublic.com/reference/oxygen-create-investigations.md
  - https://docs.fiatrepublic.com/reference/oxygen-create-payment-channel.md
  - https://docs.fiatrepublic.com/reference/oxygen-create-rule.md
  - https://docs.fiatrepublic.com/reference/oxygen-create-webhook.md
  - https://docs.fiatrepublic.com/reference/oxygen-delete-webhook.md
  - https://docs.fiatrepublic.com/reference/oxygen-get-alert.md
  - https://docs.fiatrepublic.com/reference/oxygen-get-entity.md
  - https://docs.fiatrepublic.com/reference/oxygen-get-investigation.md
  - https://docs.fiatrepublic.com/reference/oxygen-get-one-payment-channel.md
  - https://docs.fiatrepublic.com/reference/oxygen-get-platform-user.md
  - https://docs.fiatrepublic.com/reference/oxygen-get-rule.md
  - https://docs.fiatrepublic.com/reference/oxygen-get-webhook.md
  - https://docs.fiatrepublic.com/reference/oxygen-list-alerts.md
  - https://docs.fiatrepublic.com/reference/oxygen-list-entities.md
  - https://docs.fiatrepublic.com/reference/oxygen-list-investigations.md
  - https://docs.fiatrepublic.com/reference/oxygen-list-payment-channel.md
  - https://docs.fiatrepublic.com/reference/oxygen-list-platform-users.md
  - https://docs.fiatrepublic.com/reference/oxygen-list-rules.md
  - https://docs.fiatrepublic.com/reference/oxygen-list-transactions.md
  - https://docs.fiatrepublic.com/reference/oxygen-list-webhooks.md
  - https://docs.fiatrepublic.com/reference/oxygen-update-investigation.md
  - https://docs.fiatrepublic.com/reference/oxygen-update-webhook.md
  - https://docs.fiatrepublic.com/reference/update-rule.md
  merge:
    pages: 25
    deduped: 24
    conflicts_kept_first: 0