API Explorer 891 endpoints

Get certificate_of_compliance List

GET /obp/v7.0.0/banks/dylan-bank/dynamic-entities/certificate_of_compliance

OBPv7.0.0-dynamicEntity_getcertificate_of_complianceList_dylan-bank Roles: CanGetDynamicEntityRecord_certificate_of_compliance(per bank) _Certificate_of_compliance(dylan-bank)Dynamic-EntityDynamic

Get certificate_of_compliance List.

‘certificate of compliance’ means a conformity statement issued by a certification body certifying that an activity complies with this Regulation;. This Dynamic Entity is part of OGCR.

Property List:

  • certificate_of_compliance_id: ID of the certificate of compliance
  • certification_scheme_id: ID of the certification scheme
  • certification_body_id: ID of the certification body
  • country_id: Country of issuance
  • issue_date: Issuance data
  • expiry_date: Expiry date
  • carbon_removals_under_baseline: TBD
  • soil_emissions_under_baseline: TBD
  • permanent_net_carbon_removal_benefit: TBD
  • carbon_farming_temporary_net_carbon_removal_benefit: TBD
  • carbon_farming_net_soil_emission_reduction_benefit: TBD
  • carbon_storage_temporary_net_carbon_removal_benefit: TBD
  • unit_types: Unit category that will be produced during this activity. (Permanent Removal, Carbon Farming Sequestration, Soil Emission Reduction, Carbon Storage in Product)
  • certification_status: TBD
  • certification_scheme_rules_and_procedures: TBD
  • certification_annual_reports: TBD
  • activity_id: ID of the activity being certified.

MethodRouting settings example:

<details>

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"certificate_of_compliance"
    }
    {
        "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: activity_id, audit_report_id, certificate_of_compliance_id, certification_body_id, certification_scheme_id, country_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): activity_id → activity, audit_report_id → audit_report, certification_body_id → certification_body, certification_scheme_id → certification_scheme, 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": "dylan-bank",
  "certificate_of_compliance_list": [
    {
      "certificate_of_compliance": {
        "certificate_of_compliance_id": "3dece208-c95c-11f0-9041-54e1adfac5b3",
        "certification_scheme_id": "3dece208-c95c-11f0-9041-54e1adfac5b1",
        "certification_body_id": "3dece208-c95c-11f0-9041-54e1adfac5b2",
        "audit_report_id": "string",
        "country_id": "DE",
        "issue_date": "2026-12-25",
        "expiry_date": "2031-12-25",
        "carbon_removals_under_baseline": 6,
        "soil_emissions_under_baseline": 6,
        "permanent_net_carbon_removal_benefit": 6,
        "carbon_farming_temporary_net_carbon_removal_benefit": 6,
        "carbon_farming_net_soil_emission_reduction_benefit": 6,
        "carbon_storage_temporary_net_carbon_removal_benefit": 6,
        "unit_types": "Carbon Farming Sequestration",
        "certification_status": "TBD",
        "certification_scheme_rules_and_procedures": "TBD",
        "certification_annual_reports": "TBD",
        "activity_id": "TBD"
      },
      "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_getcertificate_of_complianceList_dylan-bank Originally /banks/dylan-bank/dynamic-entities/certificate_of_compliance