API Explorer 891 endpoints

Get Public operator List

GET /obp/dynamic-entity/banks/ogcr/public/operator

OBPv4.0.0-dynamicEntity_getPublicoperatorList_ogcr No role required _Operator(ogcr)Dynamic-EntityDynamic

Get Public 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>

Authentication is Optional

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 join queries (obp_exists / obp_not_exists) are not available on this endpoint.

User Authentication is Optional. The User need not be logged in.

Example success response
{
  "bank_id": "ogcr",
  "operator_list": [
    {
      "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"
    }
  ]
}
Possible errors (1)
  • OBP-50000: Unknown Error.
Implemented by OBPv4.0.0 dynamicEntity_getPublicoperatorList_ogcr Originally /banks/ogcr/public/operator