API Explorer 993 endpoints

Get operator List

GET /obp/v7.0.0/banks/ogcr/dynamic-entities/operator

OBPv7.0.0-dynamicEntity_getoperatorList_ogcr Roles: CanGetDynamicEntityRecord_operator(per bank) _Operator(ogcr)Dynamic-EntityDynamic

Get operator List.

‘operator’ means any natural or legal person or public entity that operates or controls an activity, or to whom or to which decisive economic power over the technical functioning of the activity has been delegated;. This Dynamic Entity is part of OGCR.

Property List:

  • operator_id: Internal identifier for the operator entity
  • legal_name: Legal name of the Operator.
  • email: Operator email address.
  • phone: Operator contact phone in international format.
  • address_line_1: Operator primary street address (street name, building number, P.O. Box if applicable)
  • address_line_2: Operator secondary, optional details like apartment, suite, unit, floor, or building name
  • postcode: Operator postcode
  • country_id: ISO 3166-1 alpha-2 country code for operator address.
  • ogcr_wallet_address: Wallet address to send NFTs and carbon credits to after evaluation period

MethodRouting settings example:

<details>

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"operator"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

</details>

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Filtering, sorting and pagination on the list endpoint:

Queryable (declared indexed) fields: country_id, operator_id.

  • Filter: ?obp_filter[FIELD]=OP:VALUE. Operators: eq, ne, in, lt, gt, le, ge, between, like, is_null, not_set. in / between take comma-separated values; is_null / not_set take no value. Repeat the same key to AND several constraints on one field. e.g. ?obp_filter[status]=eq:active&obp_filter[amount]=between:10,100 or ?obp_filter[closed_date]=not_set
  • Legacy filter (still supported): bare field parameters, e.g. ?name=James%20Brown&number=123.456&number=11.11 filters by name == "James Brown" && (number == 123.456 || number == 11.11).
  • Sort: ?obp_sort_by=FIELD[,FIELD2]&obp_sort_direction=ASC|DESC.
  • Paginate: ?obp_limit=20&obp_offset=40.

Filtering, sorting, pagination and is_null / not_set work on every deployment (no special backend required).

One-hop joins (EXISTS / NOT EXISTS) — filter this entity by a condition on a related entity linked through a declared reference: field:

  • ?obp_exists[RelatedEntity] — keep rows that have at least one related RelatedEntity.
  • ?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE — ...that have at least one matching the predicate.
  • ?obp_not_exists[RelatedEntity] — keep rows with NO related RelatedEntity at all.
  • ?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE — ...with no related RelatedEntity matching the predicate (this includes rows that have no related RelatedEntity).
  • If two entities are linked by more than one reference, disambiguate the edge with via:, e.g. ?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed.

The nested filter[...] reuses the operator grammar above. Mind the distinction: obp_not_exists[X]=filter[flag]=eq:true (no related X with flag=true — includes rows with no X) is not the same as obp_exists[X]=filter[flag]=ne:true (has a related X with flag≠true — excludes rows with no X).

Only a field typed reference:<Entity> and declared indexed: true forms a join edge; a plain string field holding ids is not joinable.

This entity's reference fields (each usable as a one-hop join edge to its target entity): country_id → country.

Joins require the SQL projection backend (dynamic_entity.indexing.backend=auto on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns 400 (OBP-09022); while an index is still building it returns 409. The plain filter / sort / paginate / is_null / not_set features above do not need the projection backend.

Example success response
{
  "bank_id": "ogcr",
  "operator_list": [
    {
      "operator": {
        "operator_id": "op_01JS0347FKH",
        "legal_name": "Agreena",
        "email": "contact@example.com",
        "phone": "+49 123 456 789",
        "address_line_1": "Green Street, 20",
        "address_line_2": "Suite 400",
        "postcode": "10115\" or \"W1K 3JP",
        "country_id": "DE",
        "ogcr_wallet_address": "0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B"
      },
      "metadata": {
        "created": {
          "at": "2026-09-30T10:12:00Z",
          "user_id": "a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f",
          "on_behalf_of_user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"
        },
        "updated": {
          "at": "2026-09-30T11:40:00Z",
          "user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
          "on_behalf_of_user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"
        }
      }
    }
  ]
}
Possible errors (3)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implemented by OBPv7.0.0 dynamicEntity_getoperatorList_ogcr Originally /banks/ogcr/dynamic-entities/operator